From eacab177872482b950a2b36172e68c4351761372 Mon Sep 17 00:00:00 2001 From: revital Date: Thu, 27 Feb 2025 11:18:01 +0200 Subject: [PATCH] Deployment updates --- .../upgrade_server_aws_ec2_ami.md | 22 +++++++++++++------ docs/deploying_clearml/upgrade_server_gcp.md | 3 +-- .../upgrade_server_linux_mac.md | 17 ++++++++------ docs/deploying_clearml/upgrade_server_win.md | 9 +++++--- 4 files changed, 32 insertions(+), 19 deletions(-) diff --git a/docs/deploying_clearml/upgrade_server_aws_ec2_ami.md b/docs/deploying_clearml/upgrade_server_aws_ec2_ami.md index 9edd3457..9e48c7c2 100644 --- a/docs/deploying_clearml/upgrade_server_aws_ec2_ami.md +++ b/docs/deploying_clearml/upgrade_server_aws_ec2_ami.md @@ -2,14 +2,21 @@ title: AWS EC2 AMIs --- -:::note -For upgrade purposes, the terms **Trains Server** and **ClearML Server** are interchangeable. -::: + + +MongoDB major version was upgraded from `v5.x` to `6.x`. Please note that if your current ClearML Server version is older than +`v1.17` (where MongoDB `v5.x` was first used), you'll need to first upgrade to ClearML Server v1.17. + +First upgrade to ClearML Server v1.17 following the procedure below and using [this `docker-compose` file](https://github.com/clearml/clearml-server/blob/2976ce69cc91550a3614996e8a8d8cd799af2efd/upgrade/1_17_to_2_0/docker-compose.yml). Once successfully upgraded, +you can proceed to upgrade to v2.x. + + + The sections below contain the steps to upgrade ClearML Server on the [same AWS instance](#upgrading-on-the-same-aws-instance), and to upgrade and migrate to a [new AWS instance](#upgrading-and-migrating-to-a-new-aws-instance). -### Upgrading on the Same AWS Instance +## Upgrading on the Same AWS Instance This section contains the steps to upgrade ClearML Server on the same AWS instance. @@ -52,7 +59,7 @@ If upgrading from Trains Server version 0.15 or older, a data migration is requi docker-compose -f docker-compose.yml up -d ``` -### Upgrading and Migrating to a New AWS Instance +## Upgrading and Migrating to a New AWS Instance This section contains the steps to upgrade ClearML Server on the new AWS instance. @@ -67,8 +74,9 @@ This section contains the steps to upgrade ClearML Server on the new AWS instanc 1. On the old AWS instance, [backup your data](clearml_server_aws_ec2_ami.md#backing-up-and-restoring-data-and-configuration) and, if your configuration folder is not empty, backup your configuration. -1. If upgrading from ClearML Server version older than 1.2, you need to migrate your data before upgrading your server. See instructions [here](clearml_server_mongo44_migration.md). - If upgrading from Trains Server version 0.15 or older, a data migration is required before continuing this upgrade. See instructions [here](clearml_server_es7_migration.md). +1. If upgrading from Trains Server version 0.15 or older, you need to migrate your data before upgrading your server. See instructions [here](clearml_server_es7_migration.md). + +1. If upgrading from ClearML Server version older than 1.2, you need to migrate your data before upgrading your server. See instructions [here](clearml_server_mongo44_migration.md). 1. On the new AWS instance, [restore your data](clearml_server_aws_ec2_ami.md#backing-up-and-restoring-data-and-configuration) and, if the configuration folder is not empty, restore the configuration. diff --git a/docs/deploying_clearml/upgrade_server_gcp.md b/docs/deploying_clearml/upgrade_server_gcp.md index b352ef68..8694f976 100644 --- a/docs/deploying_clearml/upgrade_server_gcp.md +++ b/docs/deploying_clearml/upgrade_server_gcp.md @@ -22,8 +22,7 @@ you can proceed to upgrade to v2.x. 1. If upgrading from **Trains Server** version 0.15 or older to **ClearML Server**, do the following: - 1. Follow these [data migration instructions](clearml_server_es7_migration.md), - and then continue this upgrade. + 1. Follow these [data migration instructions](clearml_server_es7_migration.md). 1. Rename `/opt/trains` and its subdirectories to `/opt/clearml`: diff --git a/docs/deploying_clearml/upgrade_server_linux_mac.md b/docs/deploying_clearml/upgrade_server_linux_mac.md index 7be52d46..097f5f29 100644 --- a/docs/deploying_clearml/upgrade_server_linux_mac.md +++ b/docs/deploying_clearml/upgrade_server_linux_mac.md @@ -41,19 +41,22 @@ For backwards compatibility, the environment variables ``TRAINS_HOST_IP``, ``TRA docker-compose -f docker-compose.yml down ``` -1. If upgrading from **Trains Server** version 0.15 or older, a data migration is required before continuing this upgrade. See instructions [here](clearml_server_es7_migration.md). +1. If upgrading from **Trains Server** version 0.15 or older to **ClearML Server**, do the following: + + 1. Follow these [data migration instructions](clearml_server_es7_migration.md), + and then continue this upgrade. + + 1. Rename `/opt/trains` and its subdirectories to `/opt/clearml`: + + ``` + sudo mv /opt/trains /opt/clearml + ``` 1. If upgrading from ClearML Server version older than 1.2, you need to migrate your data before upgrading your server. See instructions [here](clearml_server_mongo44_migration.md). 1. [Backing up data](clearml_server_linux_mac.md#backing-up-and-restoring-data-and-configuration) is recommended and, if the configuration folder is not empty, backing up the configuration. -1. If upgrading from **Trains Server** to **ClearML Server**, rename `/opt/trains` and its subdirectories to `/opt/clearml`: - - ``` - sudo mv /opt/trains /opt/clearml - ``` - 1. Download the latest `docker-compose.yml` file: ``` diff --git a/docs/deploying_clearml/upgrade_server_win.md b/docs/deploying_clearml/upgrade_server_win.md index ab22f542..489f2e84 100644 --- a/docs/deploying_clearml/upgrade_server_win.md +++ b/docs/deploying_clearml/upgrade_server_win.md @@ -30,8 +30,13 @@ you can proceed to upgrade to v2.x. docker-compose -f c:\opt\trains\docker-compose-win10.yml down ``` -1. If upgrading from **Trains Server** version 0.15 or older, a data migration is required before continuing this upgrade. See instructions [here](clearml_server_es7_migration.md). +1. If upgrading from **Trains Server** version 0.15 or older to **ClearML Server**, do the following: + 1. Follow these [data migration instructions](clearml_server_es7_migration.md), + and then continue this upgrade. + + 1. Rename `/opt/trains` and its subdirectories to `/opt/clearml`. + 1. If upgrading from ClearML Server version older than 1.2, you need to migrate your data before upgrading your server. See instructions [here](clearml_server_mongo44_migration.md). 1. Backing up data is recommended, and if the configuration folder is not empty, backing up the configuration. @@ -40,8 +45,6 @@ you can proceed to upgrade to v2.x. 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. ::: - -1. If upgrading from **Trains Server** to **ClearML Server**, rename `/opt/trains` and its subdirectories to `/opt/clearml`. 1. Download the latest `docker-compose.yml` file: