Upgrade in Docker

This section describes how to upgrade OpenText Software Delivery Management in Docker.

Get default configuration files from the docker image

Before upgrading, make sure you have default configuration files from the new OpenText Software Delivery Management Docker image.

  1. Download the new OpenText Software Delivery Management Docker image.

  2. Run the Docker image:

    Linux

    docker run -d -p 8080:8080 -v /opt/octane_docker_config_files/conf:/opt/octane/conf -v /opt/octane_docker_config_files/log:/opt/octane/log -v /opt/octane_docker_config_files/repo:/opt/octane/repo --name alm_octane_config_files lifecyclemanagement/octane:<version_number>

    Windows

    1. In Docker Desktop, select Images.

    2. Locate the OpenText Software Delivery Management version you want to upgrade.

      Note that only on-premises versions of OpenText Software Delivery Management are supported.

    3. Click Run and open Optional Settings.

    4. In Container name, enter a name of your choice.

    5. In Ports, enter 8080 to use HTTP.

    6. In Volumes, enter the following:

      C:\OctaneDockerConfFiles\conf    for    opt/octane/conf
      C:\OctaneDockerConfFiles\log     for    opt/octane/log
      C:\OctaneDockerConfFiles\repo    for    opt/octane/repo

    7. Click Run to run the Docker image for the fist time.

    The first run should fail with errors because OpenText Software Delivery Management has not been configured.

  3. Go to the mapped repo folder. The conf-discover folder contains the default configuration files. Copy them to a backup location.

    OS Path
    Linux /opt/octane_docker_config_files/repo
    Windows C:\OctaneDockerConfFiles\repo

Back to top

Upgrade in Docker

This section describes how to start a new OpenText Software Delivery Management container using the configuration from a previous version, and upgrade the data.

  1. Stop your OpenText Software Delivery Management container.

  2. Back up your Oracle or MSSQL database.

  3. Back up Elasticsearch.

  4. Back up the conf and log folders (if mapped).

  5. Back up the REPO folder, which includes the conf-discover and storage folders.

  6. Download the new OpenText Software Delivery Management Docker image.

    Note that only on-premises versions of OpenText Software Delivery Management are supported.

  7. Overwrite the .xml files in the folder conf-discover (in the REPO folder) with the .xml files from the default configuration files for the new version. For details see Get default configuration files from the docker image.

  8. Harden the authentication by storing the encryption key in a keystore file. The authentication mechanism uses a stronger encryption algorithm.

    You can provide your own keystore or use the automatically generated keystore.

    • If you use your own keystore, only BKS format is supported, and the keystore should contain a 256-bit AES key.

      Add the following information to the octane.conf file:

      Copy code 
      hp-sso{
          # the entry name inside keystore
          keystore-cipher-alias = “<alias>” 
          # password to open the key inside keystore
          keystore-cipher-alias-password = “<alias password>”
          # Absolute path to the keystore
          keystore-location = “<absolute keystore path>”
          # password to open the keystore
          keystore-password = “<keystore password>”
      }

    • If you do not provide a keystore, a keystore is automatically generated during the first server start up and placed in the configuration folder.

    Note:  

    • You can define a subset of parameters, such as the passwords. The defined parameters are used and any missing parameters are generated.

    • If you do not define all the parameters, the keystore path is overridden with the path to the generated keystore.

  9. When upgrading from OpenText Software Delivery Management 24.1 or earlier, you must perform the following:

    Item Details
    osp-config folder

    Replace the ../repo/conf/osp-config/ folder with the ../repo/conf/osp-config.new/ folder. To do this:

    1. Make a back up of the existing ../repo/conf/osp-config folder.

    2. Rename the ../repo/conf/osp-config.new folder to ../repo/conf/osp-config.
    sso.conf file Merge the existing sso.conf file with the sso.conf.new file.

  10. Run the Docker image with the following command, using the identical container configuration:

    Linux

    docker run -d -p 8080:8080 -p 8443:8443 -v [your-path-to-CONF-folder]:/opt/octane/conf -v [your-path-to-LOG-folder]:/opt/octane/log -v [your-path-to-REPO-folder]:/opt/octane/repo --name alm_octane_<version_number> lifecyclemanagement/octane:<version_number>

    This means that the ports, and the mapping of the conf, log, and repo mount folders should be the same in the new container as your current container.

    Windows

    1. Click Run.

    2. Open Optional Settings, and define the following:

      1. The new container name.

      2. The identical container configuration as your current OpenText Software Delivery Management container configuration.

        This means that the ports, and the mapping of the conf, log, and repo mount folders should be the same in the new container as your current container.

    3. Run the new OpenText Software Delivery Management container configuration.

  11. Validate that the container works by checking the container's Log tab, or the wrapper.log and octane.log files in the mapped log folder.

  12. Continue with the regular space upgrade procedure, as described in Step 3: Upgrade spaces.

    Note: If you need to roll back the upgrade:

    • If the new OpenText Software Delivery Management container failed to run, restore configuration files in the conf-discover folder (in the REPO folder), and run the previous version of the OpenText Software Delivery Management container.

    • If the new OpenText Software Delivery Management container successfully upgraded the site, restore backups (database, Elasticsearch, and REPO folder), and run the previous version of the OpenText Software Delivery Management container.

Back to top