Upgrading BMC Helix Platform Common services version from 23.4.00 to 24.1.00

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).

Before you begin

• Make sure that you perform the following tasks:
  1. Upgrade Kubernetes and Ingress
  2. Delete the Helm revision secrets of the Kubernetes CronJob
     See Preparing-for-upgrade.
• Create a new working directory.
  For example, 24.1.00. 
• Download the following files from EPD:
  
  • Download the deployment manager  helix-on-prem-deployment-manager-24.1.00.zip and itom-predeploy-hotfix-24.1.00.001-11.tar.gz files in the new working directory.
    The itom-predeploy-hotfix-24.1.00.001-11.tar.gz file contains the latest deployment size templates and addresses the following issues:
    • DRJ71-10089
    • DRRE3-5316
    • DRRE3-5278
    • DRRE3-5353
      For more information about the issues, see Known-and-corrected-issues.
  • Download the upgrade configuration utility.
  • If you have configured disaster recovery, download the hotfix-24.1.00.004-12-Post.tar.gz hotfix file.
    The file contains disaster recovery deployment security and performance enhancements.
    To download the files from EPD, see Downloading-the-installation-files. 

• Back up all the PersistentVolumeClaim (PVC) data. 

  BMC does not have a recommendation for this step. You can use your preferred method to back up the PVC data.

Task 1: To extract the hotfix

1. Run the following command to change the permission of the downloaded file:

   chmod a+x helix-on-prem-deployment-manager-24.1.00-103.sh

2. Self-extract the deployment manager. Run the following command:

   ./helix-on-prem-deployment-manager-24.1.00-103.sh
   cd helix-on-prem-deployment-manager

3. Navigate to the helix-on-prem-deployment-manager folder and copy the itom-predeploy-hotfix-24.1.00.001-11.tar.gz file.

1. To extract the hotfix, run the following command:

   tar -xvf itom-predeploy-hotfix-24.1.00.001-11.tar.gz

   The updated files will replace the affected files in the workspace directory.

Task 2: To run the upgrade configuration utility

The upgrade configuration utility updates the infra.config and deployment.config files by performing the following tasks:

• It uses the values that you had set during the deployment of BMC Platform Common Services to configure the infra.config and deployment.config files. 
  You need not manually configure any parameter that you had configured previously.
• It lists the configuration parameters whose names have been modified in the current release and updates their values automatically.
• It lists the configuration parameters that were added in the current release. You must manually enter the values for the new configuration parameters in the infra.config file.

Perform the following steps to run the upgrade configuration utility:

1. Go to helix-on-prem-deployment-manager/utilities/upgrade.

2. Run the following command to provide execution permission to upgrade-configuration.sh: 

   chmod a+x upgrade-configuration.sh

3. Run the upgrade configuration utility by using the following command:

   ./upgrade-configuration.sh <namespace>

   <namespace> is the name of the namespace that you used to deploy BMC Helix Platform Common Services.
   
   The utility updates the infra.config and deployment.config parameters, updates the modified parameters, and if there are any new additions, it prompts you to enter values.
   After the utility has completed updating the infra.config and deployment.config files, you will get a confirmation message. 

   Important

   The infra.config and deployment.config files are configured based on the values that you had set during the previous installation of BMC Helix Platform Common Services. Make sure that you review the files before upgrading.

Task 3: To migrate Elasticsearch data from Open Distro to OpenSearch

To migrate your Elasticsearch data from Open Distro to OpenSearch, you must run the Open Distro to OpenSearch migration utility.

Perform the following steps:

1. Go to helix-on-prem-deployment-manager/utilities/migration

2. Run the following script to migrate Elasticsearch data from Open Distro to OpenSearch:

   ./es-opensearch-migration.sh migrate

   If you have enabled disaster recovery, you will be prompted to disable it. Type y to continue.

   You will get the following message after the migration is complete:
   Completed the migration from OpenDistro ES to Open Search Elastic Cluster.

3. Perform the following steps to delete the indices that could cause problems during an upgrade:

   1. To log into the opensearch-logs-data-0 pod, run the following command:

      kubectl exec -it opensearch-logs-data-0 -n <namespace> -- bash

   2. To locate the indices, run the following command:

      curl --location --request GET "https://opensearch-logs-data:9200/_cat/indices/?v&s=index" -u <LOG_ELASTICSEARCH_USERNAME>:<LOG_ELASTICSEARCH_PASSWORD> -k
      

      Replace <LOG_ELASTICSEARCH_USERNAME> and <LOG_ELASTICSEARCH_PASSWORD> with the log Elasticsearch username and password.

      Sample output:
      
      
      

   3. Only if you find indices between .kibana_1 to .kibana_9, run the following command to delete the indices:

      curl -XDELETE https://opensearch-logs-data:9200/.kibana_<index number> -u <LOG_ELASTICSEARCH_USERNAME>:<LOG_ELASTICSEARCH_PASSWORD> -k

      Replace <index number> with the Kibana index number that you want to delete.
      For example:

      curl -XDELETE https://opensearch-logs-data:9200/.kibana_1 -u <LOG_ELASTICSEARCH_USERNAME>:<LOG_ELASTICSEARCH_PASSWORD> -k

Task 4: To upgrade BMC Helix Platform Common Services

1. Navigate to your new working directory.

2. In the configs/deployment.config file, make sure that the parameters have following values:

   Parameter	Value
   DEPLOYMENT_SIZE	itsmcompact, itsmsmall, or itsmxlarge If you are installing BMC Helix Platform Common Services in a nonproduction environment, specify the value as itsmcompact. If you are installing BMC Helix Platform Common Services in a production environment, specify the value as itsmsmall. If you are installing BMC Helix Service Management extra large size, specify the value as itsmxlarge. BMC Helix Service Management can be deployed without requiring BMC Helix Platform Common Services resources in medium or large sizes. To optimize resources, two deployment sizes are provided for BMC Helix Service Management installation: itsmcompact and itsmsmall. The itsmcompact size is suitable for non-production environments, but it does not support high availability. The itsmsmall size supports high availability, and it is recommended for production environments.
   INSTALL_MODE	upgrade
   _INFRA	yes
   _PTPOSTGRES	yes
   _KAFKA	yes
   _REDIS	yes
   _RSSO	yes
   _VICTORIAMETRICS	yes Important: For the latest deployment size templates, set this parameter to No if you using only BMC Helix Dashboards and not using BMC Helix ITSM Insights . If you have already installed Victoriametrics and not using BMC Helix ITSM Insights , scale down the following pods to zero replicas: victoria-metrics-cluster-vmstorage statefulset victoria-metrics-cluster-vminsert deployment victoria-metrics-cluster-vmselect deployment
   _ELASTICSEARCH	yes
   _MINIO	yes

3. For the product services to which you are licensed to, set the value to yes. For all other services, set the value to no.

4. From the working directory, run the deployment manager to upgrade BMC Helix Platform Common Services by using the following command:

   ./deployment-manager.sh

   After the upgrade is complete, you will get the following message:
   Completed Helix On-prem Installation.

5. (Optional) To view the logs during the upgrade, run the following command:

   tail -f logs/deployment.log

   Important

   For Kubernetes version 1.25 or higher versions, you can change the namespace pod security admission to restricted.

To apply the Disaster Recovery hotfix

The BMC Helix Platform Services for Service Management Disaster Recovery Hotfix Version 24.1.00 provides enhanced security and performance for disaster recovery deployment.
Apply the hotfix only if you have configured disaster recovery.

Perform the following steps:

1. If you have already enabled disaster recovery, disable it:
   1. Go to /helix-on-prem-deployment-manager/utilities/disaster-recovery.

   2. Run the following command:

      ./disaster-recovery.sh disable 
2. Make sure you have downloaded the hotfix-24.1.00.004-12-Post.tar.gz file from EPD.

3. To extract the hotfix file, run the following command:

   tar xvf hotfix-24.1.00.004-12-Post.tar.gz

   The new-image-list.txt file present in the extracted hotfix folder contains the following container images:
   

   • 2410004-v1-victoriametrics-vmbackupmanager-v1.100.1   
     
   • 2410004-v1-bitnami-minio-2024.03.21-rockylinux-9   
     
   • 2410004-v1-victoriametrics-vmrestore-v1.99.0-enterprise
4. Synchronize your local repository with BMC Docker Trusted Registry (DTR).
   See Setting-up-a-Harbor-repository-to-synchronize-container-images.
   

5. To execute the sh file, run the following command:

   bash hf_script.sh /<path to 24.1 deployment manager directory>/helix-on-prem-deployment-manager

   Replace <path to 24.1 deployment manager directory> with the full path of the directory where you have saved the 24.1 deployment manager.
   Example:

   bash hf_script.sh /data/24.1.00/helix-on-prem-deployment-manager

A copy of the directory helix-on-prem-deployment-manager gets created in the path specified in the command.

In the example, a new directory helix-on-prem-deployment-manager_HF1 gets created at /data/24.1.00.
No changes are made to the original directory specified in the command.

Where to go from here

Upgrading-BMC-Helix-IT-Service-Management-to-23-3-01