2.3. Installing and Configuring Oracle VDI

2.3.1. Installing Oracle VDI
2.3.2. Configuring a New Oracle VDI Center
2.3.3. Adding a Host to an Oracle VDI Center
2.3.4. Removing a Host from an Oracle VDI Center
2.3.5. Reinstalling Oracle VDI
2.3.6. Uninstalling Oracle VDI

2.3.1. Installing Oracle VDI

Before you begin, check that the host meets the requirements for installing Oracle VDI, as described in Section 2.2, “Oracle VDI System Requirements”.

Steps

  1. Download the Oracle VDI software archive to a temporary location on the host.

  2. Become superuser (root) on the host.

    See Section 2.2.6, “User Requirements” for details.

  3. Unzip the Oracle VDI software archive and change working directory to the extracted directory.

    • On Oracle Solaris 10 hosts:

      # unzip vda_3.5_solaris_10_amd64.zip
      # cd vda_3.5_solaris_10_amd64
    • On Oracle Solaris 11 hosts:

      # unzip vda_3.5_solaris_11plus_amd64.zip
      # cd vda_3.5_solaris_11plus_amd64
    • On Oracle Linux hosts:

      # unzip vda_3.5_linux.zip
      # cd vda_3.5_linux
  4. Install the software.

    If you use zones on Oracle Solaris hosts, Oracle VDI must be installed in the global zone.

    In the directory extracted from the Oracle VDI software archive, run the following command:

    # ./vda-install

    Use the -i option with the vda-install command to install the software without configuring it. You should use this option if you are you are installing the software in a host template for use in a virtualized environment.

    The software is installed in /opt/SUNWvda.

    On Oracle Linux and Oracle Solaris 11 hosts, the installation script checks whether the required packages for Oracle VDI are installed. If any required packages are missing and packaging system is configured correctly, the installation script prompts you to continue and installs the missing packages. If the required packages are not installed, the installation fails.

    At the end of the installation, you are prompted to configure Oracle VDI.

    Do you want to configure Oracle VDI 3.5 now? ([y]/n)
    • To configure Oracle VDI later, type n and press the Return key.

    • To configure Oracle VDI now, press the Return key.

    If you use the -i option with the vda-install command, the configuration prompt is not displayed.

    When you configure Oracle VDI on a host, you can either create a new Oracle VDI Center or you can add the host to an existing Oracle VDI Center. For details of how to configure Oracle VDI, see:

    Warning

    If you are prompted to reboot the host to complete the installation, ensure you do this.

2.3.2. Configuring a New Oracle VDI Center

Follow these steps to configure Oracle VDI on a host and form a new Oracle VDI Center. To add a host to an existing Oracle VDI Center, see Section 2.3.3, “Adding a Host to an Oracle VDI Center”.

You can configure Oracle VDI on a host in the following circumstances:

  • As part of the software installation, immediately after you install or update Oracle VDI software on a host.

  • As a separate step, after you install or update Oracle VDI software on a host.

  • As a separate step, after you unconfigure Oracle VDI on a host.

To use a remote MySQL database instead of the embedded Oracle VDI MySQL Server database, ensure you have all the required information as described in Section 2.2.9, “Requirements for Using a Remote MySQL Database”.

Steps

  1. (Optional) Start Oracle VDI configuration.

    This step is not necessary if you configure the software at the same time as you install it.

    Run the following command as root:

    # /opt/SUNWvda/sbin/vda-config

    See Section 2.2.6, “User Requirements” for details of how to run commands as root.

    When you installed Oracle VDI, if the installation script detected the preserved configuration from an existing installation or you installed the software with the vda-install -p command, the host is automatically configured using the preserved configuration. Otherwise, a list of configuration types is displayed.

    1 New Oracle VDI Center
    2 Join Oracle VDI Center
                    
    Select (1/2):
  2. To configure a new Oracle VDI Center, type 1 and press the Return key.

    If you are configuring an Oracle VDI Center that contains only one host, type 1.

    A list of configuration settings is displayed.

    Review the settings for a new Oracle VDI Center:
       Name: VDI Center
       Administrator Password: ********
       VDI Administrator (super-user): root
       DNS name of this host: vdi1.example.com
       Maximum number of sessions on this host: 100
       User ID range start: 150000
       Database: Embedded Oracle VDI
    
    Do you want to create the Oracle VDI Center now? 
    Enter 'c' to customize the settings. ([y]/c):

    The default is to use the embedded Oracle VDI MySQL Server database. To use a remote MySQL database, you must customize the configuration settings.

    • To accept the defaults and create the Oracle VDI Center, press the Return key.

    • To change the settings before creating the Oracle VDI Center, type c and press the Return key.

      If you change the settings, you can review the changes before they are applied.

    The host is configured using the supplied settings.

    The following are the configuration settings for a primary host:

    • Name: The name of the Oracle VDI Center. The name can contain alphanumeric characters as well as spaces.

    • Administrator Password: The password used to secure the embedded Oracle VDI MySQL Server database and the Sun Ray data store.

      Normally you do not need to know this password and an automatically-generated password is used. To use the automatically-generated password, press the Return key. Otherwise you can provide a password, which you have to enter twice to confirm. The password must contain at least five characters.

    • VDI Administrator (super-user): The user name of the initial Oracle VDI administrator.

      You use the credentials of this user to log in to the Oracle VDI graphical administration tool, and to use the command-line tools for configuring Oracle VDI. You can add further administrators later.

    • DNS name of this host: The fully-qualified DNS name of the host, for example vdi1.example.com. There must be a valid DNS entry for the host, otherwise the configuration fails.

    • Maximum number of sessions on this host: This is the maximum number of user sessions that can run on each Oracle VDI host in the Oracle VDI Center.

    • User ID range start: Oracle VDI creates a local user for each user session on the Oracle VDI host. This option enables you to specify the starting number of the user ID.

    • Database: Choose whether to use the embedded Oracle VDI MySQL Server database, or connect to a remote MySQL database. For more information about using remote databases, see Section 2.2.9, “Requirements for Using a Remote MySQL Database”.

2.3.3. Adding a Host to an Oracle VDI Center

Follow these steps to configure Oracle VDI on a host and add it to an existing Oracle VDI Center. To configure Oracle VDI on a host and form a new Oracle VDI Center, see Section 2.3.2, “Configuring a New Oracle VDI Center”.

You can configure Oracle VDI on a host in the following circumstances:

  • As part of the software installation, immediately after installing or updating Oracle VDI software on a host.

  • As a separate step, after installing or updating Oracle VDI software on a host.

  • As a separate step, after unconfiguring Oracle VDI on a host.

Steps

  1. (Optional) Start Oracle VDI configuration.

    This step is not necessary if you configure the software at the same time as installing the software.

    Run the following command as a root:

    # /opt/SUNWvda/sbin/vda-config

    See Section 2.2.6, “User Requirements” for details of how to run commands as root.

    When you installed Oracle VDI, if the installation script detected the preserved configuration from an existing installation, or you installed the software with the vda-install -p command, the host is automatically configured using the preserved configuration. Otherwise, a list of configuration types is displayed.

    1 New Oracle VDI Center
    2 Join Oracle VDI Center
                    
    Select (1/2):
  2. To add the host to an existing Oracle VDI Center, type 2 and press the Return key.

    You are prompted to enter the DNS name of the primary host in the Oracle VDI Center.

    Enter the primary Oracle VDI Host:
  3. Enter the fully-qualified DNS name of the primary host in the Oracle VDI Center, for example vdi1.example.com, and press the Return key.

    The MD5 fingerprint of the primary host's SSL certificate is displayed and you are prompted to enter the credentials for becoming the root user on the primary host.

    • On Oracle Linux and Oracle Solaris hosts where root is not configured as a role:

      Retrieving certificate from vdi1.example.com...
      MD5 fingerprint is 59:D9:6C:D1:52:00:51:76:71:89:CE:B8:2B:97:9B:D0.
      
      Enter the root password for vdi1.example.com:
    • On Oracle Solaris hosts where root is configured as a role:

      Retrieving certificate from vdi1.example.com...
      MD5 fingerprint is 59:D9:6C:D1:52:00:51:76:71:89:CE:B8:2B:97:9B:D0.
      
      Enter the name of a user who can assume the root role on vdi1.example.com [jdoe]:
  4. Check that the MD5 fingerprint matches the fingerprint of the primary host.

    This is an important security step that ensures you are adding the host to a genuine Oracle VDI Center. To check the fingerprint, run the vda-center agent-status command as root on the primary host.

    # /opt/SUNWvda/sbin/vda-center agent-status
    Agent is up for 0 day(s), 0:6.
    MD5 fingerprint is 59:D9:6C:D1:52:00:51:76:71:89:CE:B8:2B:97:9B:D0.
  5. Enter the credentials for becoming the root user on the primary host.

    • On Oracle Linux and Oracle Solaris hosts where root is not configured as a role, enter root's password and press the Return key.

    • On Oracle Solaris hosts where root is configured as a role, enter the credentials for assuming the root role and press the Return key.

      Enter the name of a user who can assume the root role on vdi1.example.com [jdoe]:
      
      Enter the password for jdoe on vdi1.example.com: 
      
      Enter the password for the root role on vdi1.example.com: 

    You are prompted to enter the DNS name of the host you are adding to the Oracle VDI Center.

    Enter the DNS name of this host [vdi2.example.com]:
  6. To accept the detected DNS name of the secondary, press the Return key. Otherwise, enter the fully-qualified DNS name of the secondary and press the Return key.

    There must be a valid DNS entry for the host, otherwise the configuration fails.

    The host is configured using the supplied settings.

2.3.4. Removing a Host from an Oracle VDI Center

You might want to remove a host from an Oracle VDI Center, for example to add it to a different Oracle VDI Center or to resolve a problem with the host.

To force the removal of a host from an Oracle VDI Center because the host is no longer responding, see Section 8.11.7, “Removing an Unresponsive Host from an Oracle VDI Center”.

Steps

  1. Check the configuration of the Oracle VDI Center and reconfigure it if needed.

    If the Oracle VDI Center contains multiple hosts, run the following command as root to identify the master database host, the replication database host, and the Sun Ray primary server:

    # /opt/SUNWvda/sbin/vda-center getprops \
    -p db.master.host,db.replication.host,srs.primary.host

    If the host you want to remove is shown in the output of this command, reconfigure the Oracle VDI Center as follows:

  2. Unconfigure Oracle VDI on the host.

    To unconfigure the host without removing the Oracle VDI software, run the following command as root:

    # /opt/SUNWvda/sbin/vda-config -u

    To uninstall the Oracle VDI software and unconfigure the host, run the following command as root:

    # /opt/SUNWvda/sbin/vda-install -u

2.3.5. Reinstalling Oracle VDI

To reinstall Oracle VDI and preserve your existing configuration, make sure you first back up the following:

  • Oracle VDI database

    Ensure you have a backup of the Oracle VDI database before you reinstall. This enables you to restore the current system. See Section 8.7, “Backing Up and Restoring the Oracle VDI Database”.

  • Customized database configuration files

    If you customized the /etc/opt/SUNWvda/my.cnf file, ensure you back up this file as it is replaced when you reinstall Oracle VDI. If you customized any of the other database configuration files (*.cnf) in the /etc/opt/SUNWvda directory, back them up. Add the customizations from the backup to the new files.

  • Customized Sun Ray Server access configuration file

    If you customized either the /etc/pam.conf file (Oracle Solaris platforms) or the /etc/pam.d/utadmingui file (Oracle Linux platforms), ensure you back up this file as this file is replaced when you reinstall Oracle VDI. Add the customizations from the backup to the new file.

To reinstall Oracle VDI, you must first uninstall it, see Section 2.3.6, “Uninstalling Oracle VDI”. After you reinstall the software, restore the data from the backups.

2.3.6. Uninstalling Oracle VDI

Perform the following steps to completely remove Oracle VDI from a host.

If you are removing an entire Oracle VDI Center, uninstall Oracle VDI on the secondary hosts first and then uninstall Oracle VDI on the primary host.

Steps

  1. Check the configuration of the Oracle VDI Center and reconfigure it if needed.

    If the Oracle VDI Center contains multiple hosts, run the following command as root to identify the master database host, the replication database host, and the Sun Ray primary server:

    # /opt/SUNWvda/sbin/vda-center getprops \
    -p db.master.host,db.replication.host,srs.primary.host

    If the host you want to remove is shown in the output of this command, reconfigure the Oracle VDI Center as follows:

  2. Unconfigure and uninstall Oracle VDI on the host.

    Run the following command as root:

    # /opt/SUNWvda/sbin/vda-install -u
  3. Reboot the host.