SD-WAN Versa Collector Upgrade Process Guide

Execute the following command to update SOA and upgrade SD-WAN Versa Collector.

When running the upgrade using the Command Line Interface, it validates the checksum, extracts the upgrade file, upgrades sevone-cli (if required), upgrades SOA, attempts to read NMS IP list from SD-WAN Versa Collector database, imports TopN views in SevOne NMS & OOTB reports in SevOne Data Insight and configures the SSH keys for the NMS being used as a datasource.

After the upgrade completes successfully, SevOne highly recommends a reboot to update the kernel as it does not update automatically. To reboot, execute command, sudo reboot.

Update SD-WAN Versa Collector without using the Graphical User Interface Installer

$ /usr/local/sbin/SevOne-validate-image \
-i $(ls -Art /opt/SevOne/upgrade/sevone_solutions_sdwan_versa-*.tgz | tail -n 1) \
-s $(ls -Art /opt/SevOne/upgrade/sevone_solutions_sdwan_versa-*.tgz.sha256.txt | tail -n 1) \
--installer solutions  --installer-opts '--no_screen'

After the upgrade completes successfully, perform the following steps.

1. The node(s) will automatically reboot three times. On the final reboot only, execute the following command and wait for it to finish successfully.

   $ journalctl -xefu reboot2continue

   You will see the output similar to the following.

   Example

   -- Logs begin at Mon 2024-02-12 07:41:24 UTC. --
   Feb 12 07:41:28 sevonek8s systemd[1]: Starting Upgrade SevOne on boot...
   -- Subject: Unit reboot2continue.service has begun start-up
   -- Defined-By: systemd
   -- Support: https://access.redhat.com/support
   --
   --
   --
   Feb 12 07:48:16 sevonek8s reboot2continue.sh[19377]: changed: [sevonek8s]
   Feb 12 07:48:16 sevonek8s reboot2continue.sh[19377]: PLAY RECAP
   *********************************************************************
   Feb 12 07:48:16 sevonek8s reboot2continue.sh[19377]: sevonek8s : ok=161
   changed=88 unreachable=0 failed=0 skipped=150 rescued=0 ignored=1
   Feb 12 07:48:16 sevonek8s systemd[1]: reboot2continue.service: Succeeded.
   -- Subject: Unit succeeded
   -- Defined-By: systemd
   -- Support: https://access.redhat.com/support
   --
   -- The unit reboot2continue.service has successfully entered the 'dead' state.
   Feb 12 07:48:16 sevonek8s systemd[1]: Started Upgrade SevOne on boot.
   -- Subject: Unit reboot2continue.service has finished start-up
   -- Defined-By: systemd
   -- Support: https://access.redhat.com/support
   --
   -- Unit reboot2continue.service has finished starting up.
   --
   -- The start-up result is done.

   Important: Please do not proceed further until the command completes without errors.
2. Verify that all nodes (master and worker) have migrated to Red Hat Enterprise Linux (RHEL) by running the following command on each node.

   $ cat /etc/os-release

   You will see the output similar to the following.

   Example

   NAME="Red Hat Enterprise Linux"
   VERSION="8.9 (Ootpa)"
   ID="rhel"
   ID_LIKE="fedora"
   VERSION_ID="8.9"
   PLATFORM_ID="platform:el8"
   PRETTY_NAME="Red Hat Enterprise Linux 8.9 (Ootpa)"
   ANSI_COLOR="0;31"
   CPE_NAME="cpe:/o:redhat:enterprise_linux:8::baseos"
   HOME_URL="https://www.redhat.com/"
   DOCUMENTATION_URL="https://access.redhat.com/documentation/en-us/
   red_hat_enterprise_linux/8"
   BUG_REPORT_URL="https://bugzilla.redhat.com/"
   REDHAT_BUGZILLA_PRODUCT="Red Hat Enterprise Linux 8"
   REDHAT_BUGZILLA_PRODUCT_VERSION=8.9
   REDHAT_SUPPORT_PRODUCT="Red Hat Enterprise Linux"
   REDHAT_SUPPORT_PRODUCT_VERSION="8.9"

   Important: Ensure the output includes Red Hat Enterprise Linux (RHEL) as the operating system name. If any node fails this check, please resolve the issue(s) before continuing or contact IBM SevOne Support.
3. Run the post-check.

   $ sevone-cli playbook postcheck

1. The setup script in the command below updates SOA on all your datasources and configures the Graphical User Interface Installer. This steps takes about 1-2 minutes to run.

   $ /usr/local/sbin/SevOne-validate-image \
   -i $(ls -Art /opt/SevOne/upgrade/sevone_solutions_sdwan_versa-*.tgz | tail -n 1) \
   -s $(ls -Art /opt/SevOne/upgrade/sevone_solutions_sdwan_versa-*.tgz.sha256.txt | tail -n 1) \
   --installer solutions-gui

   Example: The command returns the following

   ╒═══════════════════════════════════════════════════════════════╕
   │ SEVONE GUI INSTALLER                                          │
   ╞═══════════════════════════════════════════════════════════════╡
   │ Please open https://10.49.10.248:3000 in your web browser to │
   │ access the GUI Installer.                                     │
   ├───────────────────────────────────────────────────────────────┤
   │ Your credentials are:                                         │
   │ - Username: admin                                             │
   │ - Password: Zed(j+j,d+                                        │
   ├───────────────────────────────────────────────────────────────┤
   │ If you ever lose your credentials, they are stored in:        │ 
   │ /etc/sevone-guii/creds                                        │
   ╘═══════════════════════════════════════════════════════════════╛

   You are now ready to upgrade using the Graphical User Interface Installer.

2. Using a web browser of your choice, enter the URL the setup script has returned. For example, https://10.49.10.248:3000.
   Note: You will also need the credentials (Username and Password) that the setup script returns. These credentials are also stored in /etc/sevone-guii/creds file.

   Example

   $ cat /etc/sevone-guii/creds | jq  
   
   {
       "password": "Zed(j+j,d+",
       "tokenSecret": "MUdkXurZzNIxTFzWdznrUisNWbekEYA",
       "username": "admin"
   } 

3. Click Update Cluster to update SD-WAN Versa Collector. For example, upgrade from SD-WAN Versa Collector 6.7.2+2 to SD-WAN Versa Collector 6.8.0+29.
4. Enter the credentials returned to perform the Self-Service Upgrade. For example, Username: admin and Password: Zed(j+j,d+
   
   Note: To use the Graphical User Interface installer in dark theme, click next to SevOne logo.
   
   For help on what each upgrade step does, click button in the upper-right corner.
   Important: All the screenshots below are based on the example being used to write this document. Your total number of tasks passed (ok) , skipped, failed, ignored, unreachable, or unexecuted will vary based on your setup. The tasks failed must be addressed as ansible has not ignored them.
5. The graphical user interface installer checks the Current Version and the Upgrade Available version. If the current version is older than the upgrade version available, you are now ready to continue to Configure.
   Note: Example
   Current Version is on SD-WAN Versa Collector 6.7.2+2.
   Upgrade Available version is SD-WAN Versa Collector 6.8.0+29.
   Important: During the Self-Service Upgrade, if you experience network connectivity issue or the upgrade has been halted for any reason, the self-service upgrade will resume from the step where it left off after the issue is resolved. However, if you are at the Deploy step and the self-service upgrade has been halted for any reason, self-service upgrade will show a message requesting you to contact IBM SevOne Support.
   
   To resume with the Self-Service Upgrade, using a web browser of your choice, re-enter the URL the setup script has returned. For example, https://10.49.10.248:3000.
6. Click the Continue to Configure button to configure SD-WAN Versa chart values, if required.
   Note: If you do not want to configure the chart values, click Continue button to upgrade SOA.
   Warning: Limitation applies with GUI Installer version 2.0.0 only
   In case of multi-tenancy, the GUI Installer only edits the first tenant. Any additional tenant configuration must be performed manually. Using a text editor of your choice, edit /opt/SevOne/chartconfs/solutions-sdwan-versa-<tenant #>_custom-guii.yaml to set your configuration settings. This is the only scenario where the .yaml file needs to be edited manually.
   
   1. From Configuration drop-down, choose a configuration file from the list. For example, the primary configuration file is solutions-sdwan-versa_custom_guii.yaml. If SD-WAN Versa collector has already been configured, you can select that configuration from the drop-down list to edit it. If multiple configuration files are present for the same tenant, the files will be applied in the alphabetical order.
   2. Collector Service
      • Credentials (All values must be base64-encoded format)
        • Controller Credentials
          • Username - The username for Versa Director credentials with admin-level read privilege.
          • Password - The password for Versa Director.
        • NMS Credentials
          • NMS API Credentials
            • Username - The SevOne NMS user name for an administrator-level account.
            • Password - The SevOne NMS password.
          • SSH Credentials
            • Username - The SevOne NMS user name for ssh access to the appliance. It is recommend to set to root in base64-encoded format.
            • Password - The SevOne NMS password for root user.
        • DI Credentials
          • DI API Credentials
            • Username - The SevOne Data Insight user name for an adminstrator-level account.
            • Password - The SevOne Data Insight password.
        • Syslog Receiver Port - The port on which the collector listens for non-flow syslog data sent by Versa Analytics.
   3. Collector Configuration
      • MSP Name - The Managed Service Provider (MSP) name for this instance. MSP is a grouping of one or more tenants.
   4. Log
      • Log Level - Defines the log-level for the collector. Value can be info, debug, warning, or error.
   5. Jaeger
      • Disabled - Select the check box to disable Jaeger tracing.
   6. Load Reports
      • Disabled - Set the check box to not import TopN views and OOTB reports.
   7. Vendor Controller Settings
      • Versa Director Settings
        • Versa Director API URL - The API URL of Versa Director.
        • Insecure TLS - Select the check box to enable insecure TLS connection by skipping certification verification. This is necessary for servers with self-signed server certificates.
   8. NMS
      • NMS API Settings
        • NMS API IP / Hostname - The hostname or IP address for SOA and REST API endpoints. i.e., targeted SevOne NMS.
        • Insecure TLS - Select the check box to enable insecure TLS connection by skipping certification verification. This is necessary for servers with self-signed server certificates.
      • DI
        • DI API Settings - The hostname or IP address for targeted SevOne Data Insight.
        • Insecure TLS - Select the check box to enable insecure TLS connection by skipping certification verification. This is necessary for servers with self-signed server certificates.
        • Tenant - Tenant name for this SevOne Data Insight instance. This is an internal name used to keep settings and cached data segregated by tenant. Default value is SevOne.
   9. Flow Augmentor Service Settings
      • Enable - Select the check box to enable Flow Augmentor installation.
      • Flow Receiver Port - The port on which Flow Augmentor listens for inbound flows. The port number can range from 9000 - 33000.
   10. Flow Augmentor Configuration
       • Flow Augmentor Sender Configuration
         • Flow Augmentor Sender Buffer Size - Sender output buffer size in number of packets.
         • DNC IP - IP address of the DNC, where the augmented flows are sent.
         • Port No - Port of DNC, where the the augmented flows are sent.
7. Click Save. Configuration is saved in /opt/SevOne/chartconfs/solutions-sdwan-versa_custom_guii.yaml.
   Important: Once the configuration is saved, click Continue button to upgrade SOA.
8. Click Continue button to Upgrade SOA.
   Note: SOA version
   SOA must be on the latest version on all appliances in SevOne NMS cluster. Command Line Interface (CLI) must be used to upgrade SOA on all peers as the graphical user interface (GUI) only upgrades SOA for the NMS appliance you are connected to.
   

   Important: Add flag --all-peers if you want to install SOA on all peers in the cluster.

   $ sevone-cli soa upgrade \
   /opt/SevOne/upgrade/utilities/SevOne-soa-*.rpm \
   <enter SevOne NMS IP address> --all-peers

   
9. You are now ready to upgrade SOA. Click Run Upgrade SOA button. This can take a few minutes to run.
10. Click the Continue button to Pre-Check.
    Note: Pre-Check step runs various checks to ensure that SD-WAN Versa collector cluster is healthy before the deployment. It takes backups of the database and creates a copy of the security keys.
    
11. You are now ready to run the pre-check. Click the Run Pre-Check button.
    Note: To view the logs for a task, click for the task you need the details for. The pop-up has Copy to clipboard button which allows you to copy all the contents in the pop-up and paste it into a file.
12. Click the Continue button to Deploy.
13. Click the Run Deploy button to deploy the collector. This can take a few minutes to run.
    Note: To view the logs for a task, click for the task you need the details for. The pop-up has Copy to clipboard button which allows you to copy all the contents in the pop-up and paste it into a file.
14. Click the Continue button to Post-Check.
    Important: Please skip Post-Check if you do not want to overwrite the existing flow view. Also, please verify the status of pods. For more details, please refer to SD-WAN Versa Collector Deployment / Configuration Guide > Verification > section Check Pods.
    
15. Click the Run Post-Check button to run the post-check. This can take a few minutes to run.

    SD-WAN Viptela Collector upgrade has now completed.

    Note: The task list can be long. Search tasks capability is available to search for text you are looking for in the task list.
    Note: To view the logs for a task, click for the task you need the details for. The pop-up has Copy to clipboard button which allows you to copy all the contents in the pop-up and paste it into a file.
16. Click the Continue button.
    Important: This indicates that the upgrade has completed successfully.
    Important: If there was a kernel upgrade for this release, it is recommended to reboot the cluster after the upgrade to install the right kernel version.
17. You may now click the link Click Here.
18. Link Click Here will launch SevOne Data Insight, where you can view the data collected by the collector.

Important: Example: Upgrade not required
If you are already on the version you are trying to upgrade to, you will get the You can proceed with redeploy/install message. This allows you to upgrade to a later version, if available.