Upgrading the server running as a container

You can upgrade servers that are running as containers by preparing a backup and using helm upgrade.

Before you begin

You must have a maintenance window in place, as scaling the statefulset results in temporary downtime.

Procedure

  1. Prepare a backup:
    1. Cancel or wait for all running deployment processes to complete.
    2. Set the server statefulset resource to 0 to shut down the server.
    3. Back up the database.
      For example, export the schema to a file.
    4. Back up the appdata Persistent Volume.
    5. Scale the server statefulset resource back to 1 to restart the server.
  2. Pull the latest Helm chart to upgrade to latest or any earlier supported version of the product.
    Note: You should always use the latest version of the Helm chart, even if you are upgrading to an earlier supported version of Deploy. The Helm chart is backwards compatible across all supported product releases and includes the latest functional updates, security patches, and deployment fixes.
  3. Perform Helm upgrade on the server.
    • Upgrade to the latest version.

      If default values are used, Helm deploys the latest version:

      helm upgrade <release-name> oci://hclcr.io/launch-helm/hcl-launch-server-prod --values myvalues.yaml
    • Upgrade to a specific supported version.
      To upgrade to a specific supported version of Deploy rather than the latest version, specify the version parameter using one of the following methods:
      • Method 1: By using the command-line flag (--set) -

        You can pass the --set version=<x.x.x.x> parameter in the upgrade command:

        helm upgrade <release-name> oci://hclcr.io/launch-helm/hcl-launch-server-prod --values myvalues.yaml --set version=<target_version>

        For example:

        helm upgrade my-deploy-server oci://hclcr.io/launch-helm/hcl-launch-server-prod --values myvalues.yaml --set version=8.1.0.0
      • Method 2: By using the custom values.yaml file -

        Set the version parameter in your myvalues.yaml file, such as version: "8.1.0.0", and then run the standard upgrade command.

      Important: You must specify only a supported version of Deploy for the version parameter. Specifying an unsupported or invalid product version will cause the Helm upgrade to fail.
  4. Verify that deployment processes operate correctly.
    If issues arise, proceed to the rollback steps.
  5. Roll back the upgrade, if required:
    1. Cancel or wait for all running deployment processes to complete.
    2. Set the server statefulset resource to 0 to shut down the server.
    3. Restore the database.
      For example, drop the schema and import the schema from the backup file.
    4. Restore the appdata directory backup to the Persistent Volume.
    5. Perform a Helm rollback to the previous revision of the server.
    6. Set the server statefulset resource back to 1 and verify that your deployment processes operate correctly after the rollback.

Results

You have upgraded the server to the new version.