From e8bd0980f0952be9968bad96acaaf4eb80a6438d Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Sun, 19 Jan 2025 09:50:04 +0200 Subject: [PATCH] Add ClearML Server update instructions (#1004) --- docs/deploying_clearml/upgrade_server_gcp.md | 10 ++++++++++ docs/deploying_clearml/upgrade_server_linux_mac.md | 10 ++++++++++ docs/deploying_clearml/upgrade_server_win.md | 10 ++++++++++ 3 files changed, 30 insertions(+) diff --git a/docs/deploying_clearml/upgrade_server_gcp.md b/docs/deploying_clearml/upgrade_server_gcp.md index c7a4ce4c..93e53998 100644 --- a/docs/deploying_clearml/upgrade_server_gcp.md +++ b/docs/deploying_clearml/upgrade_server_gcp.md @@ -2,6 +2,16 @@ title: Google Cloud Platform --- +<Collapsible title="Important: Upgrading to v2.x from v1.16.0 or older" type="info"> + +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/allegroai/clearml-server/blob/2976ce69cc91550a3614996e8a8d8cd799af2efd/upgrade/1_17_to_2_0/docker-compose.yml). Once successfully upgraded, +you can proceed to upgrade to v2.x. + +</Collapsible> + **To upgrade ClearML Server Docker deployment:** 1. Shut down the docker containers with the following command: diff --git a/docs/deploying_clearml/upgrade_server_linux_mac.md b/docs/deploying_clearml/upgrade_server_linux_mac.md index ac15afa3..818fe375 100644 --- a/docs/deploying_clearml/upgrade_server_linux_mac.md +++ b/docs/deploying_clearml/upgrade_server_linux_mac.md @@ -2,6 +2,16 @@ title: Linux or macOS --- +<Collapsible title="Important: Upgrading to v2.x from v1.16.0 or older" type="info"> + +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/allegroai/clearml-server/blob/2976ce69cc91550a3614996e8a8d8cd799af2efd/upgrade/1_17_to_2_0/docker-compose.yml). Once successfully upgraded, +you can proceed to upgrade to v2.x. + +</Collapsible> + <Collapsible title="Important: Upgrading from v0.14 or older" type="info"> For Linux only, if upgrading from <strong>Trains Server</strong> v0.14 or older, configure the <strong>ClearML Agent Services</strong>. diff --git a/docs/deploying_clearml/upgrade_server_win.md b/docs/deploying_clearml/upgrade_server_win.md index 2210c739..36ec3007 100644 --- a/docs/deploying_clearml/upgrade_server_win.md +++ b/docs/deploying_clearml/upgrade_server_win.md @@ -2,6 +2,16 @@ title: Windows --- +<Collapsible title="Important: Upgrading to v2.x from v1.16.0 or older" type="info"> + +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/allegroai/clearml-server/blob/2976ce69cc91550a3614996e8a8d8cd799af2efd/upgrade/1_17_to_2_0/docker-compose-win10.yml). Once successfully upgraded, +you can proceed to upgrade to v2.x. + +</Collapsible> + **To upgrade ClearML Server Docker deployment:** 1. Shut down the docker containers.