CMS Upgrade on VM
  • 25 Oct 2023
  • 4 Minutes to read
  • Dark
  • PDF

CMS Upgrade on VM

  • Dark
  • PDF

Article Summary

About this Article
This article provides detailed information related to the LFR and CMS upgrade on VM.

LFR and CMS Upgrade

If the required CMS deployment type is "large" ensure that the VM has 64GB RAM
Ensure that Maintenance Mode is not active during CMS upgrade

The procedures in this section refresh the LFR and install the required CMS version. To refresh only the required files, follow the steps in Incremental LFR Refresh

  1. Execute the below commands to add the required environmental variables:
    sudo bash
    vi /etc/environment
    1. Add the below environmental variables:
  2. Execute the below commands to stop and clean previous CMS instance:
    sudo su
    cd /var/cms/docker-compose-files 
    ./ -h #to view the help menu
    ./ -h #to view the help menu
    service docker restart
  3. For upgrade from existing version, execute the below commands to remove that version

    Upgrade from Version 2.5 or Above:

    rm -rf /var/kafkavolume
    rm -rf /var/zookeepervolume
    cd /var/cms
    rm *

    Upgrade from Version 2.4 or Below:

    rm -rf /var/lib/kafkavolume
    rm -rf /var/lib/zookeepervolume
    cd /var/cms
    rm *

  4. Download the tar file vsp-cms-lfr.tar.gz from the Artifactory directory: 
    1. Version 2.8 and Abovevsp > releases > public <Major_Release> > <Minor_Release> > <Patch_Version> > tar_package > cms_lfr  
      Example: vsp > releases > public > 2 > 2.8 > 2.8.0 > tar_package > cms_lfr  
    2. Version 2.7vsp > releases > public > <Release_Number> > tar_package > cms_lfr 
      Example: vsp > releases > public > 2.7.0 > tar_package > cms_lfr  
  5. Execute the below commands to complete the CMS Upgradation:
    tar -xvzf vsp-cms-lfr.tar.gz
    echo 1 > /proc/sys/vm/drop_caches
    service docker restart 
    ./ -h  #To view more information about the script usage
    ./ <CMS_HOST_IP_Adress>
  6. The required parameter for the script is:
    HOST_IPIP Address of the VM where CMS package is installed

    The optional parameters are provided below

    SSL_VERIFYProvide 0 to disable SSL hostname verification between CMS and Probe. This is useful when a customized domain name is desired for CMS (Default Domain Name: Ensure that the option is disabled for ECS Fargate.
    Provide 1 to enable SSL hostname verification. The option is enabled by default

    Defines the CMS Deployment type. Allowed Values:
    small: Only the core CMS services are installed. Recommended for POVs only
    large: The core and optional CMS services are installed. If not specified, the default option is large

    In the configuration small, the below optional services are not installed:

    1. jreports-service – Reports are scheduled and generated in this service
    2. licenseserver – This service is the on-prem license server
    3. organization-service – Provides communication with the VSP MSSP instance
    4. report-service - Provides CMS Reporting functionality
    5. ticket-zendesk-service - Provides the ability to configure the ticketing service Zendesk
    6. virsec-api-snap-service – Provides the capability to access CMS information through SNAP API
    7. vsp-log-manager-service – Responsible for the logging functionality

    Ensure that CMS is not running during usage. Allowed Kafka options:

    0: For Unsecure Kafka connection. The option is available only for Version 2.7. By default, the value is set to 0 if not specified
    1: For One-way SSL where the Client verifies the Server
    2: For Two-way SSL where both the Client and Server verify each other.
    Version 2.8 and Above: By default, the value is set to 2 if not specified

    If there is a Custom DNS for Kafka listener, then use the option 1 for Kafka. Do not use the option 2
    Restart the probe after CMS and/or probe upgrade or when the Kafka mode is modified
    -PProvide this parameter to select the optional services that need to be started in case of CMS Deployment Type - large. If this option is not provided, all the optional services are started by default. When prompted, provide y/n for optional services [Ticketing Service (Zendesk), Centralized Logging System, MSSP, VSP APIs, Reporting Feature, On-premise License Server]
    -xCustom advertised listener for Kafka
    If a proxy server with SSL (for internet access) OR LDAP server with SSL (for user management) is configured, ensure that the root certificate information is added to the property file, as described in the Deploy Custom SSL Certificate section of the Maintenance article

  7. In cases where RAM settings for small and large CMS deployment types need modifications, execute the below command before CMS deployment and modify the value as required:
    sudo bash
    cd /var/cms/form-factors
    vi ff-ram-size.csv
    The file ff-ram-size.csv contains VSP-recommended RAM values for the available CMS deployment types. Any change in these values may affect CMS functioning

  8. VerificationExecute the below command to verify whether the LFR is up and running
    docker ps | grep lfr
    After a couple of minutes, access the URL: to view the refreshed LFR 
    1. Version 2.8 and Above: https://<VM_IP_Address>:8443
    2. Version 2.7: http://<VM_IP_Address>  
  • Post upgrade, if the probe upgrade is NOT planned, ensure that the Application is un-provisioned and re-provisioned on CMS. Restart the business application
  • When CMS is upgraded from VSP 2.3.2 or previous versions to 2.5.0 or above, probes do not auto-connect to CMS. In such cases, restart the probe service manually

Incremental LFR Refresh

  1. Execute the command below to refresh only the required LFR files
    sudo bash
    cd /var/cms 
    ./ -h  #To view more information about the script usage
  2. Example: ./ -O "rpm" -V "7,8" -S "host"
    When prompted, provide the Artifactory username and password.
    The parameters for the script are:
    -CUpdate all the CMS files. Once the script execution is complete, ensure that the script is also executed
    Example: ./ -C -r releases/public/2.8.0
    -OSpecify the required Operating System (comma separated without spaces)
    -SProvide the required SKU. Allowed values are web, host, mem. By default, files related to all SKUs are downloaded
    -VProvide the version numbers for the specified Operating System (comma separated without spaces)
    -rVSP Release Version. Example: 2.8.0
  3. Once the script is executed, LFR has the latest downloaded files
    1. A new directory backup is created in the root directory vsp with a backup of the replaced files
    2. The file changelog.txt under the directory vsp has the log of the refreshed files

Was this article helpful?