Upgrading Kubernetes-based installations

Upgrade your Kubernetes installation.

Before you begin

Note: If you are running an HCL DevOps Velocity (Velocity) version prior to 2.4, you need to uninstall the product and perform a full installation of version 2.4.x found here and skipping Step 3 because you are not required to uninstall the MongoDB.
  • Velocity installation properties are stored in the /home/.ucv/settings.json file on the computer where you installed the product. If the user that is upgrading the product is not the user who installed it, ensure that the settings.json file is copied to the upgrading user's /home/.ucv directory before upgrading.
  • If you are upgrading Velocity, you must update the bitnami images repository location in the templates after generating helm charts by using the online installation file. Unzip the tar file and change the value for the accImageName tag in the following files under the templates directory:
    File Action
    accelerate-rabbitmq-statefulset.yaml Change bitnami/rabbitmq to bitnamilegacy/rabbitmq in spec/template/spec/containers/image
    accelerate-router-deployment.yaml Change bitnami/nginx to bitnamilegacy/nginx in spec/template/spec/containers/image
    accelerate-initial-admin-password-generator.yaml Change bitnami/kubectl to bitnamilegacy/kubectl in spec/template/spec/containers/image
    accelerate-jwt-key-generator.yaml Change bitnami/kubectl to bitnamilegacy/kubectl in spec/template/spec/containers/image

About this task

When you run the installer, it checks for an existing installation. If the installer finds a previous version, it uses installed properties, such as your product access key, and assumes that you are upgrading the product.

Procedure

  1. Download the installation file for your environment and access key to authorize the configuration and installation. You can download the installation file by using anyone of the following options,
    • My HCLSoftware portal

      Visit My HCLSoftware portal, navigate to the Velocity product and select the required version. Download Velocity installer for your local environment and access key.

    • Free trial edition

      Complete the form and click Get HCL DevOps Velocity Today. After few minutes, you will receive an email containing download links and an access key for free trial edition.

    Note: Velocity does not perform malware scanning on the installed files. It is recommended that end users implement malware scanning as appropriate for their environment before installing and running the Velocity in their environment.
  2. Run the downloaded executable file.
  3. Complete installation by responding to the prompts described in the following steps.
    When the script starts, you are prompted to accept the license. You can explicitly accept the license without viewing it by appending the following parameter to the command:
    ./<velocity-installation-file> --license=accept
    1. At the Please enter your DevOps Velocity access key prompt, accept the default value.
      The default value is the key you entered when you installed the product. If you are upgrading from the Community Edition, enter your new Standard Edition key.
    2. At the Enter your encryption key or leave blank to use the default. Key must be at least 8 characters prompt, enter your encryption key or leave blank to use the default encryption key.
      Note: The encryption key must be at least 8 characters. Save the encryption key to use for further upgrades.
    3. At the Choose the platform prompt, select Helm.
    4. At the Enter the location where the DevOps Velocity files will be installed prompt, enter the location where you want to install the product files.
      You do not have to use the location that you used when you installed the product.
      Files are copied to the specified directory in a subdirectory named product_version_number.
    5. At the What version of MongoDB are you using? prompt, select the version of the MongoDB that you want to use for Velocity installation.
    6. At the Please enter the hostname where you will run DevOps Velocity prompt, enter the host name where users can access the Web UI.
      The default hostname is the value that you used the last time you used the installer.
    7. At the Enter the desired port where DevOps Velocity will run prompt, enter the port number for the Web UI.
      The default port is the value that you used the last time you used the installer.
    The images are loaded on the local host.
    Note:
    • If your current version is 5.1.8 or earlier and you want to upgrade to 5.1.9 or later, proceed with Step 4.
    • If you current version is 5.0.11 or earlier and you want to upgrade to any version from 5.1.0 to 5.1.8, proceed with Step 6
  4. Run kubectl get Statefulset in the Kubernetes cluster to get the list of all Statefulset.
  5. Run kubectl delete Statefulset accelerate-rabbitmq in the Kubernetes cluster to delete the Statefulset for RabbitMQ. The Statefulset deletion is required for upgrading the Velocity installation.
  6. In the directory where your Helm chart is located, run the Helm upgrade utility to generate a Helm chart. The upgrade command requires a chart argument that identifies your installed Helm chart. For example: 
    helm upgrade velocity accelerate-hcl-<version>-helm.tgz
    For information about the Helm upgrade utility, see the Helm documentation https://helm.sh/docs/helm/helm_upgrade/.