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 23.1.02 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 23.1.02 to 23.2.02 before you upgrade BMC Helix Service Management.

Important

  • Before you upgrade BMC Helix Platform Common Services, make sure that you perform the following tasks as specified in Upgrading-BMC-Helix-Service-Management-to-21-3-10.
    • 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

  • Make sure that you upgrade Helm to version 3.11
  • Create a new working directory.
    For example, 23.2.02. 
  • Download the following files from EPD:
    • Download the deployment manager helix-on-prem-deployment-manager-23.2.02.sh file in the new working directory.
    • Download the upgrade configuration utility.
    • Download the itom-predeploy-hotfix-23.2.02.002-10.tar.gz file.
      This file contains the latest deployment size templates.
      To download the deployment manager, upgrade configuration utility, and itom-predeploy-hotfix-23.2.02.002-10.tar.gz file from EPD, see Downloading-the-installation-files. 

  • Back up all the PersistentVolumeClaim (PVC) data. 

    Important

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

  • Run the upgrade configuration utility.

Task 1: To clean up EFK

BMC Helix Logging used Elasticsearch, Fluent Bit, and Kibana (EFK) to collect, store, and view log data:
In BMC Helix Platform Common Services version 23.1.02, Fluent Bit was a DaemonSet. Starting with BMC Helix Platform Common Services version 23.4.00, Fluent Bit is a deployment. Due to this change, you must perform the following steps to clean up Elasticsearch, Fluent Bit, and Kibana (EFK).

  1. Back up logs from Kibana into a Microsoft Excel file.

    See, To export logs to a csv file.
    1. On the Kibana home page, click 23.1.02_FlentBit_Hamburger.png.
    2. In the Analytics area, click Discover .
    3. Use the filter to refine your search, and then click Refresh query .
      23.1.02_FluentBit_FiltersRefreshQuery.png

    4. Save your search.
    5. Select Share > CSV Reports.
      23.1.02_FluentBit_CSVReport.png
    6. Click Generate CSV.
      • The system displays a similar message:
        23.1.02_FluentBit_Message1.png
    1. When prompted, click Download report and save the report.
      23.1.02_FluentBit_Message2.png

  2. Run the following commands to export the kubectl and Helm binary:

    export KUBECTL_BIN=<path of KUBECTL_BIN>

    export HELM_BIN=<path of HELM_BIN>

    Copy the path of KUBECTL_BIN and HELM_BIN from the infra.config file.

  3. Download the  efk-cleanup.sh  script.

  4. Run the efk-cleanup.sh script to clean up the EFK pods:

    ./efk-cleanup.sh <namespace>

    <namespace> is the namespace where you deployed BMC Helix Platform Common Services.

    This script removes the Kubernetes objects such as EFK pods, PVCs, secrets and so on.

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.

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 ../helix-on-prem-deployment-manager/utilities/upgrade/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 apply the hotfix

The hotfix itom-predeploy-hotfix-23.2.02.002-10.tar.gz provides support for Kubernetes version 1.26 and updated deployment size templates. Apply the hotfix by performing the following steps:

  1. Back up the following files:
    • helix-on-prem-deployment-manager directory/deployment-manager.sh
    • commons/preinstall-checker.sh
    • helix-on-prem-deployment-manager directory/configs/infra.config
    • configs/helix-chart-version.config
  2. In the helix-on-prem-deployment-manager directory, copy the itom-predeploy-hotfix-23.2.02.002-8.tar.gz file.

  3. Extract the itom-predeploy-hotfix-23.2.02.002-10.tar.gz file by using the following command:

    tar -xvf itom-predeploy-hotfix-23.2.02.002-10.tar.gz

    After you unzip the file, the following folders are replaced with the new deployment size templates in the helix-on-prem-deployment-manager directory.

    • deployment-manager.sh
    • commons/preinstall-checker.sh
    • configs/infra.config
    • configs/helix-chart-version.config
    • configs/itsmsmall.config 
    • configs/itsmcompact.config 
    • configs/itsmcompact.json 
    • configs/itsmcompact_jvm.config 
    • configs/itsmsmall.json 
    • configs/itsmsmall_jvm.config 

Task 4: To upgrade BMC Helix Platform Common Services

  1. Navigate to your working directory.

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

    Parameter

    Value

    DEPLOYMENT_SIZE

    itsmcompact or itsmsmall

    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.

    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.
    To find the product services to which you are licensed to, see the deployment.config file from the version 23.1.02.

  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

Where to go from here

Upgrading-BMC-Helix-Service-Management-to-21-3-10


 

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