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.01 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 Upgrading BMC Helix Service Management to 22.1.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:


    Parameter name

    Description

    Example

    IMAGE_REGISTRY_HOST   

    Image registry from where the nodes on the cluster download the images.

    If you have synchronized the images to local Harbor registry, make sure Harbor registry is set up with HTTPS.

    containers.bmc.com

    or

    local repo if copied down

    IMAGE_REGISTRY_USERNAME

    User name to log in to BMC DTR.

    If you use a local Harbor registry to synchronize with BMC DTR, specify the user name to log in to your local registry.

    abc@bmc.com

    ENVIRONMENT

    Type of environment such as POC, Dev, and QA.

    Do not use special characters for the environment value.

    You can use the same environment value while performing the BMC Helix Innovation Suite installation.

    poc

    NAMESPACE   

    Namespace in which to install the services.

    You must have separate namespaces to install BMC Helix Platform Common Services and BMC Helix Innovation Suite and applications.

    dark-helmet

    LB_HOST     

    Host for load balancer for BMC Helix Innovation Suite.

    Specify the BMC Helix Innovation Suite URL.

    host-india-app.mydomain.com

    LB_PORT     

    Port for load balancer.

    443

    TMS_LB_HOST 

    Host for tenant management system.

    Specify the host of the load balancer that points to the tenant management system service.

    tms-private-poc.mydomain.com

    Domain        

    Domain name of the Load Balancer

    mydomain.com

    MINIO_LB_HOST

    URL for Minio storage.

    minio-private-poc.mydomain.com

    CLUSTER_TYPE

    Cluster type can have values openshift or ocp for OpenShift.

    If CLUSTER_TYPE is not set to openshift or ocp then cluster type is treated as kubernetes cluster.

    " "

    COMPANY_NAME    

    This parameter will be used in the tenant URL formation like: $COMPANY_NAME-$TENANT_TYPE-$ENVIRONMENT.$DOMAIN

    Do not use special characters for the Company name.

    COMPANY_NAME value is used to generate the tenant URL.

    photon2

    TENANT_EMAIL    

    Tenant email address.

    pqr@mycompany.com

    TENANT_FIRST_NAME

    Tenant first name.

    TestName

    TENANT_LAST_NAME

    Tenant last name.

    TestLastName

    TENANT_TYPE

    The tenant type. 

    Valid values:

    public or private

    This parameter will be used in the tenant URL and BMC Discovery appliance URL formation.

    For BMC Helix Operations Management:
    $COMPANY_NAME-disc-$TENANT_TYPE-$ENVIRONMENT.$FQDN  $COMPANY_NAME-$TENANT_TYPE-$ENVIRONMENT.$FQDN
    Example:
    acme-private-poc.acme.com

    private 

    COUNTRY

    The country name must match the value in the OS locale.

    • Add the country name within double quotes.
    • Do not use abbreviation in country names

      Click here to view a list of the supported country names.

    Important:

    • The country name must match the value in the OS locale.
    • Make sure that the value of COUNTRY is enclosed within double quotation marks.
    • Do not use abbreviations in country names.

    "United States"

    NFS_MOUNT_PATH

    This parameter is not required for BMC Helix IT Service Management.

    Leave it blank.

    ""

    NFS_SERVER

    This parameter is not required for BMC Helix IT Service Management.

    Leave it blank. 

    ""

    SMTP_HOST     

    SMTP host name of IP address accessible from cluster.

    SMTP parameters are required for the emails that are sent to the administrator for tenant activation after the BMC Helix Platform deployment is complete.

    All SMTP mail servers are supported.

    To use a temporary SMTP server to receive BMC Helix Platform Common Services installation emails, see the knowledge article 000396217 Open link .

    mailhost.mycompany.com

    SMTP_PORT     

    An integer value for the port of the SMTP server. For example: 25

    25

    SMTP_USERNAME 

    User name to connect to the SMTP server.

    If SMTP_AUTH value is set to NONE, keep the SMTP_USERNAME and SMTP_PASSWORD values blank as shown below:

    • SMTP_USERNAME=""
    • SMTP_PASSWORD=""

    abc@mycompany.com

    SMTP_FROM_EMAIL

    A valid email ID for the From address in all emails.

    helix-rd@mycompany.com

    SMTP_TLS

    The SMTP server TLS. If not in use, leave the parameter blank as shown below:

    SMTP_TLS=""

    ""

    SMTP_AUTH_DASHBOARD

    The value can be true or false.

    true

    SMTP_AUTH

    One of the following values:

    • PLAIN
      This value is case sensitive. If you set the value as PLAIN, it is mandatory to set valid values for SMTP_USER and SMTP_PASSWORD.
    • LOGIN
      This value is case sensitive. If you set the value as LOGIN, it is mandatory to set valid values for SMTP_USER and SMTP_PASSWORD.
    • NONE
      This value is case sensitive. Use this value when you want to skip SMTP authentication. If you set the value as NONE, set the user name and password values as shown below:
      • SMTP_USERNAME=""
      • SMTP_PASSWORD=""

    PLAIN

    OPS_GROUP_EMAIL

    ops email address

    All emails related to tenant activities such as tenant creation, tenant registration, and tenant offboarding are sent to your organization's operations team.

    ops-grp@mycompany.com

    APPROVAL_GROUP_EMAIL

    email address for approval

    When a new tenant is created, an email is sent for tenant approval to this email group.

    grp-rd@mycompany.com

    PG_STORAGE_CLASS            

    Storage class used. Usually there is one Storage class configured for all the infra services. Please repeat the same value in that case

    ceph-block-storage

    VMSTORAGE_STORAGE_CLASS

    Storage class for VictoriaMetrics. 

    onprem-storage

    VMAGGSTORAGE_STORAGE_CLASS

    Storage class for VictoriaMetrics. 

    onprem-storage

    ES_MASTER_STORAGE_CLASSStorage class for Elasticsearch master nodesblock-store-class
    ES_DATA_STORAGE_CLASSStorage class for Elasticsearch data nodes.block-store-class

    MINIO_STORAGE_CLASS

    Storage class for Minio.

    onprem-storage

    EFS_STORAGE_CLASSLeave it blank. ""
    REDIS_HA_GLOBAL_STORAGECLASSStorage class for REDIS.block-store-class
    KAFKA_STORAGECLASSStorage class for Kafka.block-store-class

    ESLOG_MASTER_STORAGE_CLASS

    Storage class for Elasticsearch log.block-store-class
    ESLOG_DATA_STORAGE_CLASSStorage class for Elasticsearch log.block-store-class
    AIOPS_STORAGE_CLASSLeave it blank.""
    CUSTOM_CA_SIGNED_CERT_IN_USE

    The default value is false.

    If you are using a self-signed or custom CA certificate, set the value to true.

    For instructions on using a self-signed or custom CA certificates, see  Using self-signed or custom CA certificates Open link .

    Important: If you are using a self-signed or custom CA certificate, make sure that you use the same custom certificate during BMC Helix Platform and BMC Helix Service Management installation.

    false
    OPT_STORAGE_CLASSLeave it blank.""
    REPOPV_MOUNT_PATHLeave it blank.""
    MIGRATORPV_MOUNT_PATHLeave it blank.""
    ETLPV_MOUNT_PATHLeave it blank.""
    SMART_SYSTEM_USERNAMELeave it blank.""

    HELM_BIN

    Absolute path of the HELM binary.

    /usr/local/bin/helm

    KUBECTL_BIN

    Absolute path of the kubectl binary.

    /usr/bin/kubectl

    OC_BIN

    OC_BIN path should be set if CLUSTER_TYPE is openshift or ocp.

    /usr/local/sbin/oc

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

    PropertyUpgrade values
    INSTALL_MODEupgrade
    _POSTGRESno
    _MINIOno

  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. 

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

      Parameter nameDescriptionExample
      IMAGE_REGISTRY_PASSWORDPassword for the Docker registry.5016adc4-993f-4fc5-8fb0-8ef6b02ca9d3
      SMTP_PASSWORD

      The password to connect to the SMTP server. 

      In the configs/infra.config file, if the value of the the SMTP_AUTH parameter file is NONE, leave the SMTP_PASSWORD value blank as shown below:

       SMTP_PASSWORD=""

      password123
      SMART_SYSTEM_PASSWORD

      Password to connect to the BMC Discovery appliance.

      password123
      PG_PASSWD

      Password to connect to the PostgreSQL database.

      password123

    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

Upgrading BMC Helix Service Management to 22.1.06

Was this page helpful? Yes No Submitting... Thank you

Comments

  1. Balaji Kumbhar

    Hi Team,

    Where is the link to downloads below file. Download the only_ITSM_configs_22201_003.tar.xz file from EPD. In the EPD this file is not exist.

    Please can you provide the link to download it.

    Dec 31, 2023 07:22
    1. Poonam Morti

      Hi Balaji,

      You can find the instructions to download the file in the following topic:

      Downloading the installation files

      However, you do not need to apply the only_ITSM_configs_22201_003.tar.xz file, as in the Task 2: To upgrade BMC Helix Platform Common Services to version 23.2.02, you will apply the latest deployment size templates.

      We have removed the step to apply the deployment size templates from Task 1: To upgrade BMC Helix Platform Common Services to version 22.2.01.

      Thanks,

      Poonam

      Jan 02, 2024 04:39