ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-06-26 18:17:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
2ad586d26b
clearml-docs/docs/deploying_clearml/upgrade_server_aws_ec2_ami.md
pollfly 7137669f24
Small edits (#861)
2024-06-30 09:16:11 +03:00

3.4 KiB
Raw Blame History

title
AWS EC2 AMIs

:::note For upgrade purposes, the terms Trains Server and ClearML Server are interchangeable.
:::

The sections below contain the steps to upgrade ClearML Server on the same AWS instance, and to upgrade and migrate to a new AWS instance.

Upgrading on the Same AWS Instance

This section contains the steps to upgrade ClearML Server on the same AWS instance.

:::warning Some legacy Trains Server AMIs provided an auto-upgrade on restart capability. This functionality is now deprecated. :::

To upgrade your ClearML Server AWS AMI:

  1. Shutdown the ClearML Server executing the following command (which assumes the configuration file is in the environment path).

    docker-compose -f /opt/clearml/docker-compose.yml down

    If you are upgrading from Trains Server, use this command:

    docker-compose -f /opt/trains/docker-compose.yml down

  2. Backing up your data is recommended, and if your configuration folder is not empty, backing up your configuration.

  3. If upgrading from ClearML Server version older than 1.2, you need to migrate your data before upgrading your server. See instructions here.
    If upgrading from Trains Server version 0.15 or older, a data migration is required before continuing this upgrade. See instructions here.

  4. If upgrading from Trains Server to ClearML Server, rename /opt/trains to /opt/clearml.

  5. Download the latest docker-compose.yml file. Execute the following command:

    sudo curl https://raw.githubusercontent.com/allegroai/clearml-server/master/docker/docker-compose.yml -o /opt/clearml/docker-compose.yml

  6. Startup ClearML Server. This automatically pulls the latest ClearML Server build.

    docker-compose -f /opt/clearml/docker-compose.yml pull
docker-compose -f docker-compose.yml up -d

Upgrading and Migrating to a New AWS Instance

This section contains the steps to upgrade ClearML Server on the new AWS instance.

To migrate and to upgrade your ClearML Server AWS AMI:

  1. Shutdown ClearML Server. Executing the following command (which assumes the configuration file is in the environment path).

    docker-compose down

  2. On the old AWS instance, backup your data and, if your configuration folder is not empty, backup your configuration.

  3. If upgrading from ClearML Server version older than 1.2, you need to migrate your data before upgrading your server. See instructions here.
    If upgrading from Trains Server version 0.15 or older, a data migration is required before continuing this upgrade. See instructions here.

  4. On the new AWS instance, restore your data and, if the configuration folder is not empty, restore the configuration.

  5. Startup ClearML Server. This automatically pulls the latest ClearML Server build.

    docker-compose -f docker-compose.yml pull
docker-compose -f docker-compose.yml up -d