From b98f716486d4c4084c2a84d310ec01b01c5ec959 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Tue, 22 Aug 2023 11:11:29 +0300 Subject: [PATCH] Add note for backing up restoring server data and conf (#653) --- docs/deploying_clearml/clearml_server_aws_ec2_ami.md | 4 ++++ docs/deploying_clearml/clearml_server_gcp.md | 6 +++++- docs/deploying_clearml/clearml_server_linux_mac.md | 6 +++++- 3 files changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/deploying_clearml/clearml_server_aws_ec2_ami.md b/docs/deploying_clearml/clearml_server_aws_ec2_ami.md index e053500f..6f7e2ca7 100644 --- a/docs/deploying_clearml/clearml_server_aws_ec2_ami.md +++ b/docs/deploying_clearml/clearml_server_aws_ec2_ami.md @@ -70,6 +70,10 @@ The pre-built ClearML Server storage configuration is the following: ## Backing Up and Restoring Data and Configuration +:::caution +Stop your server before backing up or restoring data and configuration +::: + :::note If data is being moved between a **Trains Server** and a **ClearML Server** installation, make sure to use the correct paths for backup and restore (`/opt/trains` and `/opt/clearml` respectively). diff --git a/docs/deploying_clearml/clearml_server_gcp.md b/docs/deploying_clearml/clearml_server_gcp.md index 8fac3231..ecab6218 100644 --- a/docs/deploying_clearml/clearml_server_gcp.md +++ b/docs/deploying_clearml/clearml_server_gcp.md @@ -88,7 +88,11 @@ The minimum requirements for ClearML Server are: ## Backing Up and Restoring Data and Configuration -The commands in this section are an example of how to back up and restore data and configuration. +:::caution +Stop your server before backing up or restoring data and configuration +::: + +The commands in this section are an example of how to back up and restore data and configuration. If data and configuration folders are in `/opt/clearml`, then archive all data into `~/clearml_backup_data.tgz`, and configuration into `~/clearml_backup_config.tgz`: diff --git a/docs/deploying_clearml/clearml_server_linux_mac.md b/docs/deploying_clearml/clearml_server_linux_mac.md index 42b5ef83..764c2286 100644 --- a/docs/deploying_clearml/clearml_server_linux_mac.md +++ b/docs/deploying_clearml/clearml_server_linux_mac.md @@ -157,7 +157,11 @@ After deploying ClearML Server, the services expose the following ports: ## Backing Up and Restoring Data and Configuration -The commands in this section are an example of how to back up and to restore data and configuration. +:::caution +Stop your server before backing up or restoring data and configuration +::: + +The commands in this section are an example of how to back up and to restore data and configuration. If the data and configuration folders are in `/opt/clearml`, then archive all data into `~/clearml_backup_data.tgz`, and configuration into `~/clearml_backup_config.tgz`: