This documentation supports an earlier version of BMC Helix IT Service Management on-premises deployment.To view the documentation for the latest version, select 23.3.04 from the Product version picker.

Upgrading BMC Helix Platform Common Services version from 21.3.03.001 to 23.2.02


BMC Helix Platform Common Services is a microservices-based platform that provides foundational services (such as user management, tenant management, and single sign-on) and the data lake (such as Elasticsearch, PostgreSQL, and MinIO). BMC Helix Platform Common Services 23.2.02 installation is a pre-requisite for BMC Helix Service Management upgrade. 

Upgrade BMC Helix Platform Common Services from version 21.3.03.001 to 23.2.02 before you upgrade BMC Helix Service Management. To upgrade to version 23.2.02, first upgrade the platform to version 22.2.01, and then upgrade it to version 23.2.02.

Important

  • Before you upgrade BMC Helix Platform Common Services, make sure that you perform the following tasks as specified in 06.
    • Upgrade Kubernetes and Ingress
    • Delete the Helm revision secrets of the Kubernetes CronJob
  • If you want to use Kubernetes version 1.26, apply the hotfix itom-predeploy-hotfix-23.2.02.002-10 before you upgrade BMC Helix Platform Common Services to version 23.2.02.

Before you begin

  • Create a new working directory.
    For example, 22.2.01. 
  • Download the deployment manager BMC_Helix_Platform_Services_for_Service_Management_Version_22.2.01.zip from BMC Electronic Product Distribution (EPD) and extract the files to the new working directory.
    The ZIP file contains the following files:
    • helix-on-prem-deployment-manager-22.2.01.sh—This file contains the deployment manager.
    • jsons_22201_002.bzip2—This file contains the fix for the incorrect deployment file repository location issue.
      To download the files from EPD, see Downloading-the-installation-files.

Task 1: To upgrade BMC Helix Platform Common Services to version 22.2.01

  1. Log in to the controller or bastion machine from where the Kubernetes cluster is accessible.
  2. Go to the directory where you downloaded the deployment manager from the EPD and give the execute permission to the helix-on-prem-deployment-manager-22.2.01.sh file.
  3. Self-extract the deployment manager. Run the following command:

    ./helix-on-prem-deployment-manager-22.2.01.sh
    cd helix-on-prem-deployment-manager
  4. If you are installing BMC Helix Platform common services on Kubernetes 1.24 version, perform the following steps:
    1. Navigate to the commons directory.
    2. Open the preinstall-checker. sh file.
    3. Comment the code for the Kubernetes version check.
  5.  Perform the following steps:
    1. Copy the jsons_22201_002.bzip2 file in the helix-on-prem-deployment-manager directory. 
    2. Unzip the file by running the following command:

      tar xvf jsons_22201_002.bzip2

      After you unzip the file, the following folders are replaced in the helix-on-prem-deployment-manager/Products directory:

      • aiops
      • common-services
      • helixdashboard-services
      • intelligentautomation
      • intelligentintegrations
      • itsminsight-services
      • monitor
      • platform
  6. Go to the helix-on-prem-deployment-manager/configs/infra.config file and make the following changes:
    1. Set the ingressAPIversion property to true.
    2. Make sure that the ENVIRONMENT variable has the same value that it had in the preceding version.
    3. Set the correct INGRESS_CLASS for the Kubernetes ingress controller 1.2.0 that you installed earlier.
  7. In the helix-on-prem-deployment-manager/configs/infra.config file, modify the following parameters that are environment-specific:

  8. Go to the helix-on-prem-deployment-manager/configs/deployment.config file and set the following values:

  9. If you are using BMC Helix Logging, in the helix-on-prem-deployment-manager/configs/deployment.config file, change the value of the BMC_HELIX_LOGGING parameter to yes.
  10. For the product services to which you are licensed to, set the value to yes. For all other services, set the value to no.
    To find the product services to which you are licensed to, see the deployment.config file from the version 21.3.03.001.
  11. Prepare for password encryption. 

    Expand to see the steps:
    1. Go to the commons/certs directory and open the secrets.txt file.
    2. Add the following passwords to this file:

    3. Save the secrets.txt file

    Troubleshooting tip

    Make Sure that you provide all passwords in the secrets.txt file. Even if a single password is not added in the secrets.txt file, the deployment fails with an error.

    Sample secrets.txt file

    # cat commons/certs/secrets.txt
    #Please put the passwords in this file
    IMAGE_REGISTRY_PASSWORD=password123
    SMTP_PASSWORD=""
    SMART_SYSTEM_PASSWORD=password123
    PG_PASSWD=Test2020

    ################## End OF THE FILE ####################
  12. Run the deployment manager to upgrade BMC Helix Platform common services by executing the following command:

    ./deployment-manager.sh

    To view the logs during the upgrade, run the following command:

    tail -f logs/deployment.log

Task 2: To upgrade BMC Helix Platform Common Services to version 23.2.02

See Upgrading-BMC-Helix-Platform-Common-Services-version-from-22-2-01-to-23-2-02.

Where to go from here

06

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*