Documentation update To provide a better user experience, we have now created a separate documentation space for Helix Vulnerability Management. Users of Helix Vulnerability Management (includes BMC Helix Automation Console) can find the latest documentation at BMC Helix Vulnerability Management.

Preparing for upgrade


Upgrading TrueSight Automation Console requires you to complete these pre-upgrade tasks. You can download the installation files from the BMC Electronic Product Distribution (EPD) site. 

Setting up your upgrade environment

Complete the following tasks to set up your environment:

  • Back up the database.
  • Back up the installation directories of the database and the application. 
  • Back up any trusted certificates that you may be using in your environment by performing the following steps:
    1. On a host where the TrueSight Automation Console application is installed, run the following command to copy exiting certificates:

      cp <install_dir>/application/common/certs/tsvmSslCertificate.crt /opt/<backup_directory>
      cp <install_dir>/application/common/certs/tsvmSslCertificate.key /opt/<backup_directory>
    2. After successfully upgrading the application, run the following command to replace the new certificates (created during the upgrade) with the custom certificates copied earlier. 

      cp /opt/<backup_directory>/tsvmSslCertificate.crt <install_dir>/application/common/certs/
      cp /opt/<backup_directory>/tsvmSslCertificate.key <install_dir>/application/common/certs/
  • Ensure that you remove the local registry container and its mapped location on the host that contains the Docker images for the previous release. 
  • Ensure that the target computers meet the System-requirements.
  • Download the installation files.

Note

The Login APIs are changed from the previous release. If you have used these APIs for any automated tasks, then after a successful upgrade, you need to update your code as per the latest APIs. For more information, see Using-REST-API.

Preparing to upgrade TrueSight Automation Console

You first extract the latest images and then recreate a local registry with the latest Docker images. You can choose to delete the old registry (that contains the previous version) mapped location from the host either before you upgrade or after the upgrade is complete.  

Note

If deleting after the upgrade, ensure that you have identified the old registry mapped location.

To find out the mapped location, run the docker inspect <Registry-Container-Id> | grep "Source" command before you upgrade to the latest version.

To recreate the repository on a CentOS computer

  1. Remove the local registry, if it exists, by running the following commands:

    Stop the registry container
    docker stop registry
    Remove the registry container
    docker rm registry
    Remove the registry image
    docker rmi -f registry:2
  2. Create a local Docker registry to manage Docker images, as follows:
    1. Download the TSAC<versionNo>-IMAGES-LIN64.zip file from the BMC Electronic Products Distribution (EPD).
    2. Create a directory on the Docker host (for example, /opt/tsac_<version>/dockerrepo) and extract the TSAC<versionNo>-IMAGES-LIN64.zip into the directory.
      Ensure that the file system size of this directory is at least 10 GB. BMC recommends that you use version numbers while creating a directory to identify mapped locations for different versions. For example, /opt/tsac_20_08/dockerrepo
    3. Run the following command to log in to Docker using your Docker Hub username and password:
      docker login
      Login with your Docker ID to push and pull images from Docker Hub. If you don't have a Docker ID, head over to https://hub.docker.com to create one.
      Username:<Enter a username>
      Password:<Enter a password>
      Note From November 2020, Docker has limited the number of Anonymous and Free Docker Hub users to 100 and 200 container image pull requests per six hours. While installing or upgrading TrueSight Automation Console, you may encounter an error message, toomanyrequests: You have reached your pull rate limit. You may increase the limit by authenticating and upgrading: https://www.docker.com/increase-rate-limit.
      To prevent this issue, you must log in to your Docker Hub account before creating the local registry. For details, see Troubleshooting-installation-and-upgrade-issues.
    4. Run the following command to create the local Docker registry. Replace <Directory> with the complete path of the directory that you created in step b. If there are multiple Docker hosts, repeat this step on all hosts.
      docker run -d \
       -p 5000:5000 \
       --restart=always \
       --name registry \
       -v <Directory>:/var/lib/registry \
        registry
      For example,
      docker run -d \
        -p 5000:5000 \
        --restart=always \
        --name registry \
        -v /opt/tsac_<version>/dockerrepo:/var/lib/registry \
        registry
      This command creates a local Docker registry on port 5000.
      NoteIf installing the containerized database and the application on different hosts, you must create a local registry on each host.
  3. Verify that Docker images have been pulled successfully by running the following command:
    curl http://localhost:5000/v2/_catalog
    Alternatively, you can verify by using the http://localhost:5000/v2/_catalog URL in a browser. If successful, the command returns the following output (contains 24 repositories):
    {"repositories":["bmcsoftware/elasticsearch","bmcsoftware/postgres","bmcsoftware/truesight-app-drw","bmcsoftware/truesight-app-patch-manager-core","bmcsoftware/truesight-app-patch-manager-portal","bmcsoftware/truesight-catalog-service","bmcsoftware/truesight-common-discovery-onprem-connector","bmcsoftware/truesight-common-exceptions-service","bmcsoftware/truesight-common-itil","bmcsoftware/truesight-common-login","bmcsoftware/truesight-common-tenant-onboarding-utility","bmcsoftware/truesight-common-tso-connector","bmcsoftware/truesight-common-tssa-connector","bmcsoftware/truesight-connectors-service","bmcsoftware/truesight-identitymanagement-service","bmcsoftware/truesight-infra-ext-redis","bmcsoftware/truesight-organization-service","bmcsoftware/truesight-platform-portal","bmcsoftware/truesight-policy-service","bmcsoftware/truesight-resource-service","bmcsoftware/truesight-stack-manager","bmcsoftware/truesight-tssp-nginx","bmcsoftware/truesight-users-service","bmcsoftware/truesight-workmanager-service"]}

To recreate the repository on an RHEL computer

  1. Remove the local registry, if it exists, by running the following commands:

    Stop the registry container
    docker stop registry
    Remove the registry container
    docker rm registry
    Remove the registry image
    docker rmi -f registry
  2. Create a local Docker registry to manage Docker images, as follows:
    1. Download the TSAC<versionNo>-IMAGES-LIN64.zip file from the BMC Electronic Products Distribution (EPD).
    2. Create a directory on the Docker host (for example, /opt/tsac_<version>/dockerrepo) and extract the TSAC<versionNo>-IMAGES-LIN64.zip into the directory.
      Ensure that the file system size of this directory is at least 10 GB. BMC recommends that you use version numbers while creating a directory to identify mapped locations for different versions. For example, /opt/tsac_20_08/dockerrepo
    3. Run the following command to log in to Docker using your Docker Hub username and password:
      docker login
      Login with your Docker ID to push and pull images from Docker Hub. If you don't have a Docker ID, head over to https://hub.docker.com to create one.
      Username:<Enter a username>
      Password:<Enter a password>
      Note From November 2020, Docker has limited the number of Anonymous and Free Docker Hub users to 100 and 200 container image pull requests per six hours. While installing or upgrading TrueSight Automation Console, you may encounter an error message, toomanyrequests: You have reached your pull rate limit. You may increase the limit by authenticating and upgrading: https://www.docker.com/increase-rate-limit.
      To prevent this issue, you must log in to your Docker Hub account before creating the local registry. For details, see Troubleshooting-installation-and-upgrade-issues.
    4. Run the following command to create the local Docker registry. Replace <Directory> with the complete path of the directory that you created in step b. If there are multiple Docker hosts, repeat this step on all hosts.
      docker run -d \
       -p 5000:5000 \
       --restart=always \
       --name registry \
       -v <Directory>:/var/lib/registry \
        registry
      For example,
      docker run -d \
        -p 5000:5000 \
        --restart=always \
        --name registry \
        -v /opt/tsac_<version>/dockerrepo:/var/lib/registry \
        registry
      This command creates a local Docker registry on port 5000.
      NoteIf installing the containerized database and the application on different hosts, you must create a local registry on each host.
  3. Verify that Docker images have been pulled successfully by running the following command:
    curl http://localhost:5000/v2/_catalog
    Alternatively, you can verify by using the http://localhost:5000/v2/_catalog URL in a browser. If successful, the command returns the following output (contains 24 repositories):
    {"repositories":["bmcsoftware/elasticsearch","bmcsoftware/postgres","bmcsoftware/truesight-app-drw","bmcsoftware/truesight-app-patch-manager-core","bmcsoftware/truesight-app-patch-manager-portal","bmcsoftware/truesight-catalog-service","bmcsoftware/truesight-common-discovery-onprem-connector","bmcsoftware/truesight-common-exceptions-service","bmcsoftware/truesight-common-itil","bmcsoftware/truesight-common-login","bmcsoftware/truesight-common-tenant-onboarding-utility","bmcsoftware/truesight-common-tso-connector","bmcsoftware/truesight-common-tssa-connector","bmcsoftware/truesight-connectors-service","bmcsoftware/truesight-identitymanagement-service","bmcsoftware/truesight-infra-ext-redis","bmcsoftware/truesight-organization-service","bmcsoftware/truesight-platform-portal","bmcsoftware/truesight-policy-service","bmcsoftware/truesight-resource-service","bmcsoftware/truesight-stack-manager","bmcsoftware/truesight-tssp-nginx","bmcsoftware/truesight-users-service","bmcsoftware/truesight-workmanager-service"]}

Where to go from here?

After completing the pre-upgrade tasks, you can now start Performing-the-upgrade

 

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