ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-03-03 18:53:37 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Edit open-source server deployment instructions (#1062)

Browse Source
This commit is contained in:
pollfly 2025-02-27 15:01:11 +02:00 committed by GitHub
parent ffe51adeec
commit c75fc40c07
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 38 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/deploying_clearml/upgrade_server_aws_ec2_ami.md
View File

@ -2,14 +2,21 @@
title: AWS EC2 AMIs
---
:::note
For upgrade purposes, the terms **Trains Server** and **ClearML Server** are interchangeable.
:::
<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/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.
</Collapsible>
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 1.1 or older, 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.

10
docs/deploying_clearml/upgrade_server_gcp.md
View File

@ -19,11 +19,13 @@ you can proceed to upgrade to v2.x.
```
docker-compose -f docker-compose.yml down
```
1. [Backing up data](clearml_server_gcp.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** 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`:
@ -31,9 +33,7 @@ you can proceed to upgrade to v2.x.
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_gcp.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 ClearML Server version 1.1 or older, you need to migrate your data before upgrading your server. See instructions [here](clearml_server_mongo44_migration.md).
1. Download the latest `docker-compose.yml` file:

18
docs/deploying_clearml/upgrade_server_linux_mac.md
View File

@ -40,19 +40,21 @@ 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 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** version 0.15 or older to **ClearML Server**, do the following:
1. If upgrading from **Trains Server** to **ClearML Server**, rename `/opt/trains` and its subdirectories to `/opt/clearml`:
1. Follow these [data migration instructions](clearml_server_es7_migration.md).
1. Rename `/opt/trains` and its subdirectories to `/opt/clearml`:
```
sudo mv /opt/trains /opt/clearml
```
```
sudo mv /opt/trains /opt/clearml
```
1. If upgrading from ClearML Server version 1.1 or older, you need to migrate your data before upgrading your server. See instructions [here](clearml_server_mongo44_migration.md).
1. Download the latest `docker-compose.yml` file:

13
docs/deploying_clearml/upgrade_server_win.md
View File

@ -29,10 +29,7 @@ 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 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,9 +37,15 @@ 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. 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).
1. Rename `/opt/trains` and its subdirectories to `/opt/clearml`.
1. If upgrading from ClearML Server version 1.1 or older, you need to migrate your data before upgrading your server. See instructions [here](clearml_server_mongo44_migration.md).
1. Download the latest `docker-compose.yml` file:
```