3.5 Upgrading

3.5.1 Installing Firmware Before Sun Ray Software Upgrade
3.5.2 How to Upgrade Sun Ray Software
3.5.3 Planning Upgrades Using Failover Groups
3.5.4 How to Preserve Sun Ray Software Configuration Data

This section provides instructions on how to upgrade a previously installed Sun Ray server.

3.5.1 Installing Firmware Before Sun Ray Software Upgrade

As described in Section 3.2.4, “Installing Firmware Before Sun Ray Software Installation”, it is recommended that you install the latest firmware on the existing Sun Ray server before performing an upgrade. The firmware is not provided with the Sun Ray Software media pack.

The current upgrade procedure provides steps on how to download and install the firmware. To update client firmware outside of the Sun Ray Software upgrade process, refer to Section 14.3, “How to Update Firmware on Sun Ray Clients”.

3.5.2 How to Upgrade Sun Ray Software

This procedure describes how to upgrade Sun Ray Software on an existing Sun Ray server. This procedure relies on a specific Sun Ray configuration. See Chapter 2, Planning a Sun Ray Network Environment for details.

Note the following information before performing the upgrade.

  • Make sure the operating system on the Sun Ray server complies with the Sun Ray Server requirements listed in Section 3.1.1, “Operating System Requirements”. If not, you'll have to upgrade the operating system on the Sun Ray server as part of the Sun Ray Software upgrade.

  • Upgrades from Sun Ray Software 5.2 or later are supported with Sun Ray Software 5.4.x. You can upgrade directly to a 5.4.x release, you do not have to upgrade to Sun Ray Software 5.4 first.

  • You cannot migrate a Sun Ray server configuration to a hardware platform of a different Instruction Set Architecture. For example, you cannot migrate an existing SPARC-based Sun Ray server configuration to a new x86-based Sun Ray server.

  • You cannot migrate a Sun Ray server configuration to a different operating system, for example, from Oracle Linux to Oracle Solaris. Although, you can upgrade between major releases of the same operating system when specified, such as Oracle Solaris 10 to Oracle Solaris 11.

  • Although not necessary in most circumstances, you should preserve the configuration data on the Sun Ray server and copy the backup file to another location. See Section 3.5.4, “How to Preserve Sun Ray Software Configuration Data” for details.

Steps
  1. Inform users about the upgrade.

    Before you upgrade Sun Ray Software, inform your users of your plans, and have them terminate their sessions. An effect of the upgrade procedure is that all active and suspended sessions are lost.

  2. If you are upgrading Sun Ray servers in a failover group, consider ways to reduce downtime.

    See Section 3.5.3, “Planning Upgrades Using Failover Groups” for details.

  3. Become superuser on the Sun Ray server.

    To avoid installation script errors that can occur if user environment settings are carried forward, use the following command:

    % su - root
  4. List the current Sun Ray network configuration and retain the information. You need to reconfigure the Sun Ray network after the upgrade.

    # /opt/SUNWut/sbin/utadm -l           
  5. If necessary, upgrade the operating system on the Sun Ray server to meet the requirements listed in Section 3.1.1, “Operating System Requirements”.

    Upgrading Oracle Linux 5.x to 5.8
    1. Preserve the configuration data on the Sun Ray server and copy the backup file to a safe location. See Section 3.5.4, “How to Preserve Sun Ray Software Configuration Data” for details.

    2. Uninstall the Sun Ray Software on the Sun Ray server. See Section 3.2.11, “How to Remove Sun Ray Software” for details.

      Note

      If the utkiosk group is still configured on the system, remove it. Otherwise, the kiosk mode user account configuration will fail during the Sun Ray Software upgrade.

    3. Upgrade Oracle Linux on the Sun Ray server.

    4. If necessary, copy the Sun Ray server configuration data backup file created earlier, /var/tmp/SUNWut.upgrade/preserve_version.tar.gz, to the same location on the upgraded Sun Ray server. The Oracle Linux upgrade should have retained this file.

    5. Go to Step 6.

    Upgrading Oracle Linux 5.x to 6.3
    1. Preserve the configuration data on the Sun Ray server and copy the backup file to a safe location. See Section 3.5.4, “How to Preserve Sun Ray Software Configuration Data” for details.

    2. Upgrade Oracle Linux on the Sun Ray server.

      In-place upgrades are not supported between major Oracle Linux releases, so it is recommended that you perform a fresh install of Oracle Linux 6.3 on the Sun Ray server after backing up the existing system. Refer to the Oracle Linux documentation for details on upgrading between major Oracle Linux releases.

    3. Copy the Sun Ray server configuration data backup file created earlier, /var/tmp/SUNWut.upgrade/preserve_version.tar.gz, to the same location on the upgraded Sun Ray server.

    4. Go to Step 6.

    Upgrading Oracle Solaris 10
    1. (Optional) Preserve the configuration data on the Sun Ray server and move the backup file to a safe location. See Section 3.5.4, “How to Preserve Sun Ray Software Configuration Data” for details.

      This step is not necessary because the Oracle Solaris 10 upgrade will not affect the Sun Ray Software configuration data. However, backing up data before performing an operating system upgrade is always good practice.

    2. Upgrade Oracle Solaris on the Sun Ray server.

    3. Go to Step 6.

    Upgrading Oracle Solaris 10 to Oracle Solaris 11
    1. Preserve the configuration data on the Sun Ray server and copy the backup file to a safe location. See Section 3.5.4, “How to Preserve Sun Ray Software Configuration Data” for details.

    2. Upgrade Oracle Solaris on the Sun Ray server.

      There is no upgrade program to upgrade Oracle Solaris 10 to Oracle Solaris 11. You must perform a fresh install of Oracle Solaris 11 on the Sun Ray server after backing up the existing system. Refer to the Oracle Solaris 11 documentation for details on upgrading to Oracle Solaris 11.

    3. Copy the Sun Ray server configuration data backup file created earlier, /var/tmp/SUNWut.upgrade/preserve_version.tar.gz, to the same location on the upgraded Sun Ray server.

    4. Go to Step 6.

  6. Download and unzip the Sun Ray Software media pack and make it accessible to the Sun Ray server.

    See http://www.oracle.com/technetwork/server-storage/sunrayproducts/downloads/index.html

  7. (Optional) Download and unzip the latest Sun Ray Operating Software (firmware) and make it accessible to the Sun Ray server.

    See http://www.oracle.com/technetwork/server-storage/sunrayproducts/downloads/index.html

    If you decide to install and configure client firmware after the upgrade, refer to Section 14.3, “How to Update Firmware on Sun Ray Clients”.

  8. Disable all Sun Ray Client firmware updates until all the servers in a failover group are upgraded.

    See Section 14.13, “How to Disable All Sun Ray Client Firmware Updates” for details.

  9. If you downloaded the latest Sun Ray Operating Software (firmware), change directory to the unzipped firmware directory and update the current firmware to make it available to the Sun Ray Software installation upgrade.

    # ./utfwinstall

    The utfwinstall script overwrites the existing firmware installed on the Sun Ray server.

  10. Change directory to the unzipped Sun Ray Software media pack and upgrade Sun Ray Software on the Sun Ray server.

    # ./utsetup

    The utsetup script preserves the current Sun Ray Software configuration data on the Sun Ray server, upgrades Sun Ray Software to the new version, and then restores the Sun Ray Software configuration data after the upgrade. If you had to create a /var/tmp/SUNWut.upgrade/preserve_version.tar.gz backup file and copy it to the newly installed OS as described in Step 5, the utsetup script will prompt you to use the backup file to restore the Sun Ray Software configuration data.

    When the script ends, a log file is available at:

    Oracle Linux:

    /var/log/utsetup.year_month_date_hour:minute:second.log

    Oracle Solaris:

    /var/adm/log/utsetup.year_month_date_hour:minute:second.log

    The values in the file name reflect a time stamp of when the commands are started. Check these files for notices of installation problems.

    See Section 3.2.12, “Installation (utinstall) Error Messages” for a listing of utinstall error messages.

  11. Reconfigure the Sun Ray network based on the previous configuration you confirmed in step 4.

    For a shared network (LAN) with external DHCP server support (used utadm -L on)

    No action is required. This configuration is preserved during the upgrade.

    For a shared network (LAN) with Sun Ray server DHCP support

    # /opt/SUNWut/sbin/utadm -A subnet
    

    For a private network

    # /opt/SUNWut/sbin/utadm -a intf
    
  12. If you used a preserve file as part of the upgrade, you must run utconfig -w to complete the upgrade.

    The utconfig -w command will prompt you for the Admin GUI settings, including the location of the Tomcat installation, and the Admin GUI will be started automatically.

  13. If the Windows connector groupname was not previously configured or the groupname was set to root or sys, reconfigure the Windows connector. Errors regarding these scenarios will be listed in the installation log.

    # /opt/SUNWut/sbin/utconfig -c
    
  14. Repeat Steps 1 through 13 for each server in failover group.

  15. Synchronize the updated Sun Ray Operating Software (firmware) on the Sun Ray clients.

    You must perform this task on a stand-alone Sun Ray server or the last Sun Ray server upgraded in a failover group. The utfwsync takes the currently installed and configured firmware on the Sun Ray server and updates all the Sun Ray servers in the failover group, and then it updates all the firmware on the Sun Ray Clients. The Sun Ray Clients reboot themselves and update to the new firmware if needed.

    # /opt/SUNWut/sbin/utfwsync
    
  16. If you plan to use the Windows connector, upgrade the Windows Connector Components on your designated Windows Server.

    There is no upgrade program for the Windows connector components. To upgrade a Windows system with the previous components installed, remove the current Windows connector components and install the new versions.

3.5.3 Planning Upgrades Using Failover Groups

By configuring two or more Sun Ray servers in a failover group, you can reduce interruption of new service availability in the event that one server fails. If you plan to combine existing Sun Ray servers into a failover group, or to upgrade an existing failover group, please consider the following:

  • You should always upgrade the secondary servers first before upgrading the primary server. New functionality from the release may not work until all the servers in the failover group are upgraded.

  • Before you upgrade a given server, make sure that Sun Ray Client users terminate their sessions.

Note

If upgrading servers in a large configuration at once is not convenient, upgrade one or two servers at a time until the entire configuration is complete.

  • For best results in groups of four or more servers, configure the primary server so that it serves only the Sun Ray data store. Configure the secondary servers so that they serve users directly in addition to serving the data store.

  • While upgrading the primary server, secondary servers will not be able to do any updates to the data store.

  • To take advantage of the new features in this release, do not mix different Sun Ray Software versions within a failover group. Failover groups that use more than one software version revert to the functionality of the earliest version.

  • Using the Admin GUI to restart or reset Sun Ray services does not work across servers with different Sun Ray releases. For example, even if you use the Admin GUI to restart all the servers in a failover group that are running the latest Sun Ray Software release, you should still restart or reset any Sun Ray servers running earlier versions of Sun Ray Software.

  • Disable all Sun Ray Client firmware updates until all the servers in a failover group are upgraded. For details, see Section 14.13, “How to Disable All Sun Ray Client Firmware Updates”.

Note

Even if you upgrade one or two servers per week, you must wait until all servers in the group are upgraded before you enable firmware updates.

  • If your configuration is a dedicated private interconnect, disconnect the server from the Sun Ray interconnect.

See Chapter 6, Failover Groups for a more general discussion of failover groups, including diagrams of failover topologies.

3.5.4 How to Preserve Sun Ray Software Configuration Data

When you choose an upgrade, the utsetup script automatically preserves your existing configuration information. You must preserve your existing configuration before running the utsetup script only in the following situations:

  • Upgrading the operating system on an existing Sun Ray server that requires you to reformat the server's disk.

  • Replacing an existing Sun Ray server hardware with a new server.

  • Upgrading the operating system on the Sun Ray server, in most situations, as part of the Sun Ray Software upgrade.

In all of these cases, you will need to create a Sun Ray Software configuration data backup file, saved in /var/tmp/SUNWut.upgrade/preserve_version.tar.gz, and copy it to the same location on the newly installed or upgraded server before you start the utsetup script. The utsetup script automatically restores the configuration data in the /var/tmp/SUNWut.upgrade/preserve_version.tar.gz after it installs Sun Ray Software.

The utpreserve script in the Sun Ray Software image directory preserves the following information:

  • X user settings

  • Sun Ray data store

  • Authentication Manager configuration files

  • utslaunch properties

  • Failover group information

  • Kiosk mode configuration

  • Group name used by the Windows connector

The utpreserve script does not preserve the following information:

  • The Sun Ray server's network and DHCP configuration settings (utadm -A or utadm -a configuration information). You must reconfigure those settings after upgrading Sun Ray Software.

  • The server's PAM configuration is not saved. The PAM configuration is located in /etc/pam.conf on Oracle Solaris 10 and /etc/pam.d/* on Oracle Solaris 11 or Oracle Linux. You need to back up and restore the PAM configuration manually.

Before You Begin

Depending on the size of your configuration, this procedure, including the operating system software upgrade, might take anywhere from five minutes to several hours or even more to complete.

Note

Running the utpreserve script stops all Sun Ray daemons and services, including the Sun Ray data store, causing users to lose all of their sessions, both active and disconnected. Make sure to inform them of your plans.

Steps
  1. Change directory to the unzipped Sun Ray Software media pack.

  2. Preserve the Sun Ray configuration:

    # ./utpreserve
    

    The utpreserve script warns that it will stop all Sun Ray services, consequently terminating all user sessions, and asks whether it should continue.

    If you answer y, the utpreserve script:

    • Stops the Sun Ray services and the Sun Ray data store daemon.

    • Lists the files that are saved.

    • Tars and compresses the entire list of files as the /var/tmp/SUNWut.upgrade/preserve_version.tar.gz file, where version is the currently installed version of Sun Ray Software.

    • Indicates that a log file containing notices of errors is available at /var/adm/log/utpreserve.year_month_date_hour:minute:second.log for Oracle Solaris or /var/log/SUNWut/utpreserve.year_month_date_hour:minute:second.log for Oracle Linux

      where year, month, and so on are represented by numeric values reflecting the time utpreserve was started.

    • Recommends that the /var/tmp/SUNWut.upgrade/preserve_version.tar.gz backup file be copied to a safe location.

Note

If you have modified the PAM configuration in a previous version of Sun Ray Software, your changes might be lost when Sun Ray Software is upgraded. To avoid losing your modifications, be sure to save a copy before performing the update, then use the saved copy to restore your earlier modifications.