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

Small edits (#882)

Browse Source
This commit is contained in:
pollfly 2024-07-21 15:19:32 +03:00 committed by GitHub
parent 38c9c11e00
commit f85bade950
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/clearml_agent/clearml_agent_env_caching.md
View File

@ -20,14 +20,14 @@ the same environment will be used.
ClearML does not support environment reuse when using Poetry package manager ClearML does not support environment reuse when using Poetry package manager
::: :::
To enable environment reuse, modify the `clearml.conf` file and unmark the `venvs_cache` section. To enable virutal environment reuse, modify the `clearml.conf` file and uncomment the `venvs_cache` section.
``` ```
venvs_cache: { venvs_cache: {
# maximum number of cached venvs # maximum number of cached venvs
max_entries: 10 max_entries: 10
# minimum required free space to allow for cache entry, disable by passing 0 or negative value # minimum required free space to allow for cache entry, disable by passing 0 or negative value
free_space_threshold_gb: 2.0 free_space_threshold_gb: 2.0
# unmark to enable virtual environment caching # uncomment to enable virtual environment caching
# path: ~/.clearml/venvs-cache # path: ~/.clearml/venvs-cache
}, },
``` ```

6
docs/deploying_clearml/clearml_server_es7_migration.md
View File

@ -69,7 +69,7 @@ and ClearML Server needs to be installed.
1. For **Kubernetes** and **Kubernetes using Helm**, connect to the node in the Kubernetes cluster labeled `app=trains`. 1. For **Kubernetes** and **Kubernetes using Helm**, connect to the node in the Kubernetes cluster labeled `app=trains`.
1. Download the migration package archive. 1. Download the migration package archive:
``` ```
curl -L -O https://github.com/allegroai/clearml-server/releases/download/0.16.0/trains-server-0.16.0-migration.zip curl -L -O https://github.com/allegroai/clearml-server/releases/download/0.16.0/trains-server-0.16.0-migration.zip
@ -77,13 +77,13 @@ and ClearML Server needs to be installed.
If the file needs to be downloaded manually, use this direct link: [trains-server-0.16.0-migration.zip](https://github.com/allegroai/clearml-server/releases/download/0.16.0/trains-server-0.16.0-migration.zip). If the file needs to be downloaded manually, use this direct link: [trains-server-0.16.0-migration.zip](https://github.com/allegroai/clearml-server/releases/download/0.16.0/trains-server-0.16.0-migration.zip).
1. Extract the archive. 1. Extract the archive:
``` ```
unzip trains-server-0.16.0-migration.zip -d /opt/trains unzip trains-server-0.16.0-migration.zip -d /opt/trains
``` ```
1. Migrate the data. 1. Migrate the data:
* **Linux, macOS, and Windows** - if managing own containers. * **Linux, macOS, and Windows** - if managing own containers.

6
docs/deploying_clearml/clearml_server_mongo44_migration.md
View File

@ -87,7 +87,7 @@ installed ClearML under a different path, replace the file locations accordingly
sudo docker exec mongodb_upgrade bash -c 'mongo --eval "db.adminCommand({setFeatureCompatibilityVersion:\"4.0\"})"' sudo docker exec mongodb_upgrade bash -c 'mongo --eval "db.adminCommand({setFeatureCompatibilityVersion:\"4.0\"})"'
``` ```
This command should return an `{ "ok" : 1 }` response. This command should return an `{ "ok" : 1 }` response.
1. Stop the mongo 4.0 container 1. Stop the mongo 4.0 container:
```bash ```bash
sudo docker stop mongodb_upgrade && sudo docker rm mongodb_upgrade sudo docker stop mongodb_upgrade && sudo docker rm mongodb_upgrade
@ -103,7 +103,7 @@ installed ClearML under a different path, replace the file locations accordingly
sudo docker exec mongodb_upgrade bash -c 'mongo --eval "db.adminCommand({setFeatureCompatibilityVersion:\"4.2\"})"' sudo docker exec mongodb_upgrade bash -c 'mongo --eval "db.adminCommand({setFeatureCompatibilityVersion:\"4.2\"})"'
``` ```
This command should return an `{ "ok" : 1 }` response. This command should return an `{ "ok" : 1 }` response.
1. Stop the mongo 4.2 container 1. Stop the mongo 4.2 container:
```bash ```bash
sudo docker stop mongodb_upgrade && sudo docker rm mongodb_upgrade sudo docker stop mongodb_upgrade && sudo docker rm mongodb_upgrade
@ -119,7 +119,7 @@ installed ClearML under a different path, replace the file locations accordingly
sudo docker exec mongodb_upgrade bash -c 'mongo --eval "db.adminCommand({setFeatureCompatibilityVersion:\"4.4\"})"' sudo docker exec mongodb_upgrade bash -c 'mongo --eval "db.adminCommand({setFeatureCompatibilityVersion:\"4.4\"})"'
``` ```
This command should return an `{ "ok" : 1 }` response. This command should return an `{ "ok" : 1 }` response.
1. Stop the mongo 4.4 1. Stop the mongo 4.4:
```bash ```bash
sudo docker stop mongodb_upgrade && sudo docker rm mongodb_upgrade sudo docker stop mongodb_upgrade && sudo docker rm mongodb_upgrade

6
docs/deploying_clearml/upgrade_server_gcp.md
View File

@ -15,7 +15,7 @@ title: Google Cloud Platform
1. Follow these [data migration instructions](clearml_server_es7_migration.md), 1. Follow these [data migration instructions](clearml_server_es7_migration.md),
and then continue this upgrade. and then continue this upgrade.
1. Rename `/opt/trains` and its subdirectories to `/opt/clearml`. 1. Rename `/opt/trains` and its subdirectories to `/opt/clearml`:
``` ```
sudo mv /opt/trains /opt/clearml sudo mv /opt/trains /opt/clearml
@ -25,7 +25,7 @@ title: Google Cloud Platform
1. [Backing up data](clearml_server_gcp.md#backing-up-and-restoring-data-and-configuration) is recommended, and if the configuration folder is 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. not empty, backing up the configuration.
1. Download the latest `docker-compose.yml` file. 1. Download the latest `docker-compose.yml` file:
``` ```
curl https://raw.githubusercontent.com/allegroai/clearml-server/master/docker/docker-compose.yml -o /opt/clearml/docker-compose.yml curl https://raw.githubusercontent.com/allegroai/clearml-server/master/docker/docker-compose.yml -o /opt/clearml/docker-compose.yml
@ -38,4 +38,4 @@ title: Google Cloud Platform
docker-compose -f /opt/clearml/docker-compose.yml up -d docker-compose -f /opt/clearml/docker-compose.yml up -d
``` ```
If issues arise during your upgrade, see the FAQ page, [How do I fix Docker upgrade errors?](../faq.md#common-docker-upgrade-errors). If issues arise during your upgrade, see the FAQ page, [How do I fix Docker upgrade errors?](../faq.md#common-docker-upgrade-errors)

12
docs/deploying_clearml/upgrade_server_linux_mac.md
View File

@ -7,7 +7,7 @@ title: Linux or macOS
For Linux only, if upgrading from <strong>Trains Server</strong> v0.14 or older, configure the <strong>ClearML Agent Services</strong>. For Linux only, if upgrading from <strong>Trains Server</strong> v0.14 or older, configure the <strong>ClearML Agent Services</strong>.
* If ``CLEARML_HOST_IP`` is not provided, then **ClearML Agent Services** uses the external public address of the ClearML Server. * If ``CLEARML_HOST_IP`` is not provided, then **ClearML Agent Services** uses the external public address of the ClearML Server.
* If ``CLEARML_AGENT_GIT_USER`` / ``CLEARML_AGENT_GIT_PASS`` are not provided, then **ClearML Agent Services** can't access any private repositories for running service tasks. * If ``CLEARML_AGENT_GIT_USER`` / ``CLEARML_AGENT_GIT_PASS`` are not provided, then **ClearML Agent Services** can't access any private repositories for running service tasks:
``` ```
export CLEARML_HOST_IP=server_host_ip_here export CLEARML_HOST_IP=server_host_ip_here
@ -25,7 +25,7 @@ For backwards compatibility, the environment variables ``TRAINS_HOST_IP``, ``TRA
**To upgrade ClearML Server Docker deployment:** **To upgrade ClearML Server Docker deployment:**
1. Shutdown ClearML Server. Execute the following command (which assumes the configuration file is in the environment path). 1. Shutdown ClearML Server. Execute the following command (which assumes the configuration file is in the environment path):
``` ```
docker-compose -f docker-compose.yml down docker-compose -f docker-compose.yml down
@ -38,23 +38,23 @@ For backwards compatibility, the environment variables ``TRAINS_HOST_IP``, ``TRA
1. [Backing up data](clearml_server_linux_mac.md#backing-up-and-restoring-data-and-configuration) is recommended and, if the configuration folder is 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. not empty, backing up the configuration.
1. If upgrading from **Trains Server** to **ClearML Server**, rename `/opt/trains` and its subdirectories to `/opt/clearml`. 1. If upgrading from **Trains Server** to **ClearML Server**, rename `/opt/trains` and its subdirectories to `/opt/clearml`:
``` ```
sudo mv /opt/trains /opt/clearml sudo mv /opt/trains /opt/clearml
``` ```
1. Download the latest `docker-compose.yml` file. 1. Download the latest `docker-compose.yml` file:
``` ```
curl https://raw.githubusercontent.com/allegroai/clearml-server/master/docker/docker-compose.yml -o /opt/clearml/docker-compose.yml curl https://raw.githubusercontent.com/allegroai/clearml-server/master/docker/docker-compose.yml -o /opt/clearml/docker-compose.yml
``` ```
1. Startup ClearML Server. This automatically pulls the latest ClearML Server build. 1. Startup ClearML Server. This automatically pulls the latest ClearML Server build:
``` ```
docker-compose -f /opt/clearml/docker-compose.yml pull docker-compose -f /opt/clearml/docker-compose.yml pull
docker-compose -f /opt/clearml/docker-compose.yml up -d docker-compose -f /opt/clearml/docker-compose.yml up -d
``` ```
If issues arise during your upgrade, see the FAQ page, [How do I fix Docker upgrade errors?](../faq.md#common-docker-upgrade-errors). If issues arise during your upgrade, see the FAQ page, [How do I fix Docker upgrade errors?](../faq.md#common-docker-upgrade-errors)

2
docs/deploying_clearml/upgrade_server_win.md
View File

@ -33,7 +33,7 @@ title: Windows
1. If upgrading from **Trains Server** to **ClearML Server**, rename `/opt/trains` and its subdirectories to `/opt/clearml`. 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. 1. 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 curl https://raw.githubusercontent.com/allegroai/clearml-server/master/docker/docker-compose-win10.yml -o c:\opt\clearml\docker-compose-win10.yml