Skip to main content

AWS EC2 AMIs

important

This documentation page applies to deploying your own open source ClearML Server. It does not apply to ClearML Hosted Service users.

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. We recommend backing up your data and, if your configuration folder is not empty, backing up your configuration.

  3. If upgrading from Trains Server version 0.15 or older, a data migration is required before upgrading, First follow these data migration instructions, and then continue this upgrade.

  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 Trains Server version 0.15 or older, a data migration is required before upgrading. First follow these data migration instructions, and then continue this upgrade.

  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