Upgrade

CAUTION
  • Before upgrading, it is strongly recommended to back up ADCM data. For more information, see Backup & Restore.

  • Downgrade of the ADCM version is not supported.

  • It is not recommended to update ADCM more than 5 minor versions ahead (see <minor> in the versioning format below).

Online update

If you need to upgrade the previously installed version of ADCM, do the following:

  1. Stop the adcm container:

    $ sudo docker stop adcm
  2. Remove the adcm container:

    $ sudo docker container rm adcm
  3. Download the required Docker image from the Arenadata Docker Registry:

    $ sudo docker pull hub.arenadata.io/adcm/adcm:<version>

    where <version> is a desired ADCM image version in one of the following formats:

    • <major>.<minor>.<patch> — if you need a specific ADCM patch. For example, 2.0.0.

    • <major>.<minor> — if you need the last patch within the selected ADCM version. For example, 2.0.

    IMPORTANT
    • latest was used for earlier versions of ADCM and is no longer supported starting from version 2.0.0.

    • Before ADCM 2.0.0, the following format was used for versioning: YYYY.MM.DD.HH.

  4. Create a new container based on the downloaded image:

    $ sudo docker create --name adcm -p 8000:8000 -v /opt/adcm:/adcm/data -e DB_HOST="<DATABASE_HOSTNAME_OR_IP_ADDRESS>" -e DB_PORT="<DATABASE_TCP_PORT>" -e DB_USER="<DATABASE_USERNAME>" -e DB_NAME="<DATABASE_NAME>" -e DB_PASS="<DATABASE_USER_PASSWORD>" -e DB_OPTIONS="<DATABASE_OPTIONS>" hub.arenadata.io/adcm/adcm:<version>
    NOTE
    For more information on the environment variables (DB_HOST, DB_PORT, DB_USER, DB_NAME, DB_PASS, and DB_OPTIONS), see the Installation article.
  5. Start the new adcm container:

    $ sudo docker start adcm

Offline update

You can also try offline ADCM update in situations without Internet access. To upgrade the previously installed ADCM version offline, follow these steps:

  1. Stop the adcm container:

    $ sudo docker stop adcm
  2. Remove the adcm container:

    $ sudo docker container rm adcm
  3. Download the required Docker image from the Arenadata Docker Registry on a host that has Internet access:

    $ sudo docker pull hub.arenadata.io/adcm/adcm:<version>

    where <version> is a desired ADCM image version in one of the following formats:

    • <major>.<minor>.<patch> — if you need a specific ADCM patch. For example, 2.0.0.

    • <major>.<minor> — if you need the last patch within the selected ADCM version. For example, 2.0.

    IMPORTANT
    • latest was used for earlier versions of ADCM and is no longer supported starting from version 2.0.0.

    • Before ADCM 2.0.0, the following format was used for versioning: YYYY.MM.DD.HH.

  4. Save the Docker image to a .tar file:

    $ sudo docker save -o <file_name> hub.arenadata.io/adcm/adcm:<version>

    where <file_name> is the full name of the created file with the extension (for example, adcm_2.5.0_arenadata.tar).

    NOTE
    Running the command can take some time. Please wait until it is completed.
  5. Copy the saved file from the current host to a host without Internet connection using any available methods.

    IMPORTANT
    Make sure you have configured access to hosts and necessary file permissions.
  6. Load the Docker image from the .tar file:

    $ sudo docker load -i <file_path>

    where <file_path> is the absolute path to the .tar file with the Docker image.

    The example of a successful command execution result:

    Loaded image: hub.arenadata.io/adcm/adcm:2.5.0
  7. Create a new container based on the downloaded image:

    $ sudo docker create --name adcm -p 8000:8000 -v /opt/adcm:/adcm/data -e DB_HOST="<DATABASE_HOSTNAME_OR_IP_ADDRESS>" -e DB_PORT="<DATABASE_TCP_PORT>" -e DB_USER="<DATABASE_USERNAME>" -e DB_NAME="<DATABASE_NAME>" -e DB_PASS="<DATABASE_USER_PASSWORD>" -e DB_OPTIONS="<DATABASE_OPTIONS>" hub.arenadata.io/adcm/adcm:<version>
    NOTE
    For more information on the environment variables (DB_HOST, DB_PORT, DB_USER, DB_NAME, DB_PASS, and DB_OPTIONS), see the Installation article.
  8. Start the new adcm container:

    $ sudo docker start adcm
Found a mistake? Seleсt text and press Ctrl+Enter to report it