Windows

important

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

To upgrade ClearML Server Docker deployment:

1. Shut down the docker containers.

2. Execute one of the following commands, depending upon the version that is being upgraded:

   • Upgrading ClearML Server version:

     docker-compose -f c:\opt\clearml\docker-compose-win10.yml down

   • Upgrading from Trains Server to ClearML Server:

     docker-compose -f c:\opt\trains\docker-compose-win10.yml down

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

4. We recommend backing up data and, if the configuration folder is not empty, backing up the configuration.

   note

   For example, if the configuration is in c:\opt\clearml, then backup c:\opt\clearml\config and c:\opt\clearml\data. Before restoring, remove the old artifacts in c:\opt\clearml\config and c:\opt\clearml\data, and then restore.

5. If upgrading from Trains Server to ClearML Server, rename /opt/trains and its subdirectories to /opt/clearml.

6. Download the latest docker-compose.yml file.

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

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

   docker-compose -f c:\opt\clearml\docker-compose-win10.yml pull

   docker-compose -f c:\opt\clearml\docker-compose-win10.yml up -d

If issues arise during your upgrade, see the FAQ page, How do I fix Docker upgrade errors?.