Upgrade Best Practices Fault-Tolerant Deployments

Upgrades in a fault-tolerant environment are supported. However, take care to follow the recommendations in this topic and in the related procedure. All of your Primary and Secondary sss must be upgraded within a small window of a few hours.
casp941
Upgrade Best Practices Fault-Tolerant Deployments
Upgrades in a fault-tolerant environment are supported. However, take care to follow the recommendations in this topic and in the related procedure. All of your Primary and Secondary 
SpectroSERVER
s must be upgraded within a small window of a few hours.
Not all upgrade paths are supported. Refer to Upgrading From Earlier Versions for more information.
Before conducting any upgrades, verify that all 
 components are up-to-date with current service packs. Also consult the list of the communication ports and protocols that 
 uses. Your security parameters may require you to temporarily disable these ports and protocols during the upgrade. For more information about firewall ports and protocols, see .
Upgrade the Primary 
SpectroSERVER
 and Primary OneClick server first, followed by the remaining Primary 
SpectroSERVER
s. Upgrade the Secondary servers last.
The one-time database conversion is slightly different in some fault-tolerant deployments to avoid having both the Primary and Secondary
SpectroSERVER
s down at the same time.
The following steps describe a fault-tolerant database conversion:
  1. Upgrade all Primary servers first. The encoding conversion occurs automatically.
  2. Upgrade all Secondary servers. The encoding conversion occurs automatically.
  3. If required, run Ssdbload - UpgradeFrom 
    source encoding
     on all Primary servers. 
    This script converts any alarm data that is synchronized from the Secondary servers to UTF-8 character encoding. For more information, see Perform One-Time Database Conversion (Fault-Tolerant Environments).
Upgrade Fault-Tolerant 
SpectroSERVER
s and OneClick Web Servers
The following procedure describes an upgrade in a fault-tolerant environment. Use the same procedure for a single-server or DSS upgrade: upgrade Primary servers before upgrading Secondary servers. Upgrade the OneClick Web Server before upgrading the 
SpectroSERVER
s.
Typical upgrades occur between contiguous releases. The following steps include optional instructions for a noncontiguous upgrade (that is, an upgrade in which intervening versions of the software are not installed).
Alarms may display incorrectly in OneClick until the upgrade process is complete, including any post-upgrade steps that may be required. Avoid using
for management until you have completed all steps.
Follow these steps:
  1. Disable automatic online backups on the Primary 
    SpectroSERVER
    s by taking the following steps:
    1. Highlight the VNM model in the Universe Topology view.
    2. In the Component Detail panel, select the Information tab.
    3. Locate and expand the Online Database Backup subview.
    4. Set Automatic Backups to “Disabled”.
  2. Perform a manual online backup on every Primary 
    SpectroSERVER
     to preserve the current database. Take the following steps:
    1. In the Online Database Backup subview, click Begin Backup Now.
    2. Verify that the online backup has succeeded.
    We recommend differentiating the databases by version number. Set the “Prefix for Backup File Name” parameter from the default of “db_” to something like “db_
    version
    _” or another value that identifies the version.
  3. Edit the .vnmrc file to increase the 'maximum event records' parameter on all Secondary 
    SpectroSERVER
    s. For example, change the following parameter:
    max_event_records=20000
    to the following value:
    max_event_records=200000
    The new value prevents event loss during the upgrade.
  4. Restart all Secondary 
    SpectroSERVER
    s so that the change takes effect:
    1. Launch a Spectrum Control Panel.
    2. Click Stop 
      SpectroSERVER
      .
    3. Once the Status changes to “INACTIVE,” click Start 
      SpectroSERVER
      .
    4. Verify that the Status changes to “RUNNING”.
  5. Instruct all OneClick users who are logged into the Primary OneClick Web Server to close their clients and log in to the Secondary OneClick Web Server.
  6. Stop each of the Primary 
    SpectroSERVER
    s:
    1. Launch a Spectrum Control Panel
    2. Click Stop 
      SpectroSERVER
      .
    3. You are prompted to verify the action to stop the 
      SpectroSERVER
       and Archive Manger.
    4. Verify that the Status changes to “INACTIVE”.
    5. Exit the Spectrum Control Panel.
  7. On the OneClick clients, verify that the 
    SpectroSERVER
    s have failed over to the Secondary 
    SpectroSERVER
    s. 
    The landscape icons in the Explorer hierarchy panel change from green to yellow 
    Yellow borders appear around the Contents and Component Detail panels.
  8. If you are upgrading from a 
     version earlier than 9.2.2, follow the upgrade path mentioned in Upgrading from Earlier Versions to upgrade to 
     9.2.2.
  9. Install 
     [assign the value for rn in your book].
    If you are upgrading from
    9.2.2, 9.2.2 H09, 9.2.3, 9.2.3 H11, or H12, the installation includes a dialog to initiate a one-time database conversion. When you are prompted to select the appropriate character set encoding, select the option that applies to your environment. Select the Default option for deployments configured with the default character set encoding and default locale (US English). For more information, see Upgrade Scenarios that Require a One-Time Database Conversion.
  10. When the installation has completed, stop the Tomcat web server by executing the following command:
    $SPECROOT/tomcat/bin/stopTomcat.sh
  11. (Optional) Perform the upgrade to the interim version of 
     on all of the Primary 
    SpectroSERVER
    s, and verify that the installations complete successfully.
    Wait for every installation to complete before continuing to the next step.
  12. Perform the upgrade to the most recent version of 
     on the Primary OneClick Web Server, and wait for the installation to complete.
  13. When the installation has completed, stop the Tomcat web server by executing the following command:
    $SPECROOT/tomcat/bin/stopTomcat.sh
  14. Perform the upgrade to the most recent version of 
     on all of the Primary 
    SpectroSERVER
    s, and verify that the installations complete successfully.
    Wait for every installation to complete before continuing to the next step.
  15. Manually start the Archive Manager on every Primary 
    SpectroSERVER
    :
    1. Launch a Spectrum Control Panel.
    2. Select Control, and click Start Archive Manager.
    Starting the Archive Manager ensures that the events that are being stored locally on the Secondary
    SpectroSERVER
    are sent over to the Primary Archive Manager.
  16. Wait for all events on the Secondary 
    SpectroSERVER
    s to be sent over to the Primary Archive Manager. To verify their status, take the following steps:
    1. In the OneClick client, highlight the VNM model for each 
      SpectroSERVER
       in the Universe Topology view.
    2. In the Component Detail panel, select the Information tab.
    3. Locate and expand the 
      SpectroSERVER
       Control subview.
    4. Locate and expand the Event Log Information subview.
    5. Wait for the total of Locally Stored Events to reach zero (0).
  17. Start the 
    SpectroSERVER
     on the Primary MLS:
    1. Launch a Spectrum Control Panel on the Primary MLS.
    2. Click Start 
      SpectroSERVER
      .
    3. Verify that the Status changes to “RUNNING”.
  18. Start the remaining Primary 
    SpectroSERVER
    s.
  19. Start the Tomcat web service on the Primary OneClick Web Server by executing the following command:
    $SPECROOT/tomcat/bin/startTomcat.sh
    The OneClick clients that are connected to the Secondary Web Server may or may not see the landscapes go red at this point.
  20. Instruct all OneClick users who are logged in to the Secondary OneClick Web Server to close their client and log in to the Primary OneClick Web Server.
  21. Verify that all clients can see the Primary 
    SpectroSERVER
    s and that all landscape icons are green in the Explorer hierarchy panel.
Upgrade Fault-Tolerant Secondary 
SpectroSERVER
s
The following procedure describes an upgrade in a fault-tolerant environment. These steps assume that you have already upgraded Primary servers. In this procedure, you upgrade all Secondary 
SpectroSERVER
s and the Secondary OneClick Web Server.
Alarms may display incorrectly in OneClick until the upgrade process is complete, including any post-upgrade steps that may be required. Avoid using
for management until you have completed all steps.
Follow these steps:
  1. Perform the upgrade of the Secondary OneClick Web Server and wait for the installation to complete.
  2. When the installation has completed, stop the Tomcat web server by executing the following command:
    $SPECROOT/tomcat/bin/stopTomcat.sh
  3. Perform upgrades to 
     9.4 on all of the Secondary 
    SpectroSERVER
    s, and verify that the installations complete successfully.
    If you are upgrading from
    9.2.2, 9.2.2 H09, 9.2.3, 9.2.3 H11, or H12, the installation includes a dialog to initiate a one-time database conversion. When you are prompted to select the appropriate character set encoding, select the option that applies to your environment. Select the Default option for deployments configured with the default character set encoding and default locale (US English). For more information, see Upgrade Scenarios that Require a One-Time Database Conversion.
    Wait for every installation to complete before continuing to the next step.
  4. Start the 
    SpectroSERVER
     on every Secondary 
    SpectroSERVER
    :
    1. Launch a Spectrum Control Panel on the 
      SpectroSERVER
      .
    2. Click Start 
      SpectroSERVER
      .
    3. Verify that the Status changes to “RUNNING”.
  5. Start the tomcat web service on the Secondary OneClick Web Server by executing the following command:
    $SPECROOT/tomcat/bin/startTomcat.sh
  6. Instruct a few OneClick users to launch a OneClick client to the Secondary OneClick Web Server.
  7. Verify that the clients open successfully and that all of the Primary 
    SpectroSERVER
    s are green.
  8. Perform a manual online backup on every Primary 
    SpectroSERVER
     to preserve the current database. Take the following steps:
    1. In the Online Database Backup subview, click Begin Backup Now.
    2. Verify that the online backup has succeeded.
    3. Resynchronize the Primary 
      SpectroSERVER
       database with the Secondary 
      SpectroSERVER
      .
    We recommend differentiating the databases by version number. Set the “Prefix for Backup File Name” parameter from the default of “db_” to something like “db_
    version
    _” or another value that identifies the version.
  9. When both servers have been upgraded, perform the final steps that are described in Perform One-Time Database Conversion (Fault-Tolerant Environments).
Perform One-Time Database Conversion (Fault-Tolerant Environments)
After upgrading multiple servers to 
 [assign the value for rn in your book] in a fault-tolerant deployment, you must take some final steps to convert existing alarms to use UTF-8 encoding. This encoding is required to support localization. The upgrade procedure automatically converts your databases to use UTF-8; however, the steps in this one-time procedure are required to convert existing alarms in a fault-tolerant deployment to UTF-8.
The additional conversion steps are only required if any one of the following applies:
  • A non-default character set was configured in your CA Spectrum deployment.
  • The system locale has been changed from the default (English) locale.
  • User input to CA Spectrum may contain non-English characters -- characters outside of the standard NVT ASCII character set.
For more information about upgrade scenarios that require database conversion, see Upgrade Scenarios that Require a One-Time Database Conversion.
Alarms may display incorrectly in OneClick until the upgrade process is complete, including any post-upgrade steps that may be required. Avoid using
for management until you have completed all steps.
Follow these steps:
  1. Disable the option to Automatically Start/Stop Archive Manager on the Primary 
    SpectroSERVER
     by taking the following steps:
    1. Launch a Spectrum Control Panel.
    2. From the Control menu, clear the option to 'Auto Start/Stop Archive Manager'.
  2. Stop the Primary 
    SpectroSERVER
     by taking the following steps:
    1. Launch a Spectrum Control Panel.
    2. Click Stop 
      SpectroSERVER
      .
      You are prompted to verify the action to stop the 
      SpectroSERVER
      .
    3. Verify that the Status changes to “INACTIVE”.
    4. Exit the Spectrum Control Panel.
  3. Disable Fault-Tolerant Alarm Synchronization on the Primary 
    SpectroSERVER
     by taking the following steps:
    1. Open the 
      $SPECROOT
      /SS/.vnmrc file.
    2. Add the following option at the end of the file:
      ftasv_enabled=false
  4. Save a copy of the database on the Primary 
    SpectroSERVER
    .
    From the 
    $SPECROOT
    /S
    directory, run the following command:
    ../SS-Tools/SSdbsave - m dbsavefile
    • dbsavefile
      The filename of the database copy that you are creating.
  5. Run the conversion script on the Primary 
    SpectroSERVER
    .
    The conversion utility is included with SSdbload and uses the following syntax:
    SSdbload - UpgradeFrom encoding SAVE_FILE
    • encoding 
      The encoding that you used with the previous version of 
       and want to convert. The supported encodings are listed in the 
      Software Release Notice
      .
    • SAVE_FILE
      The filename of the database copy that you created in Step 4.
  6. Start the Primary 
    SpectroSERVER
     by taking the following steps:
    1. Launch a Spectrum Control Panel on the Primary 
      SpectroSERVER
      .
    2. Click Start 
      SpectroSERVER
      .
    3. Verify that the Status changes to “RUNNING”.
  7. Run an Online Database Backup by taking the following steps:
    1. Open a OneClick client.
    2. Navigate to the Online Database Backup subview on the VNM model.
    3. Wait for the Model Activation on the Primary 
      SpectroSERVER
       to complete.
    4. Click Begin Backup Now.
  8. Enable the Fault Tolerant Alarm Synchronization on the Primary 
    SpectroSERVER
     by taking the following steps:
    1. Open the 
      $SPECROOT
      /SS/.vnmrc file.
    2. Remove the following option from the end of the file:
      ftasv_enabled=false
  9. Enable the option to Automatically Start/Stop Archive Manager on the Primary 
    SpectroSERVER
     by taking the following steps:
    1. Launch a Spectrum Control Panel.
    2. From the Control menu, select the option to 'Auto Start/Stop Archive Manager'.
  10. Restart the OneClick web server and any connected OneClick clients.
Alarms that are generated on the Secondary
SpectroSERVER
during this process are not preserved, but are regenerated on the Primary
SpectroSERVER
when the conditions are detected.