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

Update Docusaurus (#855)

Browse Source
This commit is contained in:
pollfly
2024-06-23 10:00:06 +03:00
committed by GitHub
parent f52a139c34
commit d166467a32
32 changed files with 8616 additions and 4726 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/deploying_clearml/clearml_server_aws_ec2_ami.md
View File

@@ -19,7 +19,7 @@ and delete all cookies under the ClearML Server URL.
## Launching
:::caution
:::warning
By default, ClearML Server deploys as an open network. To restrict ClearML Server access, follow the instructions
in the [Security](clearml_server_security.md) page.
:::
@@ -70,7 +70,7 @@ The pre-built ClearML Server storage configuration is the following:
## Backing Up and Restoring Data and Configuration
:::caution
:::warning
Stop your server before backing up or restoring data and configuration
:::

83
docs/deploying_clearml/clearml_server_config.md
View File

@@ -166,15 +166,17 @@ The following example, which is based on AWS load balancing, demonstrates the co
1. In the ClearML Server `/opt/clearml/config/apiserver.conf` file, add the following `auth.cookies` section:
auth {
cookies {
httponly: true
secure: true
domain: ".clearml.mydomain.com"
max_age: 99999999999
}
}
```
auth {
cookies {
httponly: true
secure: true
domain: ".clearml.mydomain.com"
max_age: 99999999999
}
}
```
:::tip
If the `apiserver.conf` file does not exist, create your own in ClearML Server's `/opt/clearml/config` directory (or
an alternate folder you configured), and input the modified configuration
@@ -212,7 +214,7 @@ For improved security, the ports for ClearML Server Elasticsearch, MongoDB, and
they are only open internally in the docker network. If external access is needed, open these ports (but make sure to
understand the security risks involved with doing so).
:::caution
:::warning
Opening the ports for Elasticsearch, MongoDB, and Redis for external access may pose a security concern and is not recommended
unless you know what you're doing. Network security measures, such as firewall configuration, should be considered when
opening ports for external access.
@@ -261,27 +263,29 @@ Without web login authentication, ClearML Server does not restrict access (by de
For example:
auth {
# Fixed users login credentials
# No other user will be able to login
fixed_users {
enabled: true
pass_hashed: false
users: [
{
username: "jane"
password: "12345678"
name: "Jane Doe"
},
{
username: "john"
password: "12345678"
name: "John Doe"
},
]
}
```
auth {
# Fixed users login credentials
# No other user will be able to login
fixed_users {
enabled: true
pass_hashed: false
users: [
{
username: "jane"
password: "12345678"
name: "Jane Doe"
},
{
username: "john"
password: "12345678"
name: "John Doe"
},
]
}
}
```
:::tip
If the `apiserver.conf` file does not exist, create your own in ClearML Server's `/opt/clearml/config` directory (or
an alternate folder you configured), and input the modified configuration
@@ -338,18 +342,19 @@ Modify the following settings for the watchdog:
section and specify the watchdog settings.
For example:
```
tasks {
non_responsive_tasks_watchdog {
enabled: true
tasks {
non_responsive_tasks_watchdog {
enabled: true
# In-progress tasks that haven't been updated for at least 'value' seconds will be stopped by the watchdog
threshold_sec: 7200
# In-progress tasks that haven't been updated for at least 'value' seconds will be stopped by the watchdog
threshold_sec: 7200
# Watchdog will sleep for this number of seconds after each cycle
watch_interval_sec: 900
}
# Watchdog will sleep for this number of seconds after each cycle
watch_interval_sec: 900
}
}
```
:::tip
If the `apiserver.conf` file does not exist, create your own in ClearML Server's `/opt/clearml/config` directory (or

16
docs/deploying_clearml/clearml_server_es7_migration.md
View File

@@ -22,7 +22,7 @@ The migration process makes use of a script that automatically performs the foll
* Renames the original data directory to avoid accidental reuse.
:::caution
:::warning
Once the migration process completes successfully, the data is no longer accessible to the older version of Trains Server,
and ClearML Server needs to be installed.
:::
@@ -140,14 +140,14 @@ and ClearML Server needs to be installed.
Upon successful completion, the migration script renames the original **Trains Server** directory, which contains the now
migrated data, and prints a completion message:
Renaming the source directory /opt/trains/data/elastic to /opt/trains/data/elastic_migrated_<date_time>.
Upgrade completed.
```
Renaming the source directory /opt/trains/data/elastic to /opt/trains/data/elastic_migrated_<date_time>.
Upgrade completed.
```
All console output during the execution of the migration script is saved to a log file in the directory where the migration script executes:
<path_to_script>/upgrade_to_7_<date_time>.log
```
<path_to_script>/upgrade_to_7_<date_time>.log
```
If the migration script does not complete successfully, the migration script prints the error.
:::important

4
docs/deploying_clearml/clearml_server_gcp.md
View File

@@ -65,7 +65,7 @@ For more information see the [Compute Engine Documentation](https://cloud.google
## Launching
:::caution
:::warning
By default, ClearML Server launches with unrestricted access. To restrict ClearML Server access, follow the
instructions in the [Security](clearml_server_security.md) page.
:::
@@ -89,7 +89,7 @@ The minimum requirements for ClearML Server are:
## Backing Up and Restoring Data and Configuration
:::caution
:::warning
Stop your server before backing up or restoring data and configuration
:::

2
docs/deploying_clearml/clearml_server_kubernetes_helm.md
View File

@@ -23,7 +23,7 @@ Ensure that the `helm` binary is in the PATH of your shell.
You will create a multi-node Kubernetes cluster using Helm, and then install ClearML in your cluster. For deployment
instructions with up-to-date Helms charts, see the [clearml-helm-charts repository](https://github.com/allegroai/clearml-helm-charts/tree/main/charts/clearml#local-environment).
:::caution Server Access
:::warning Server Access
By default, ClearML Server launches with unrestricted access. To restrict ClearML Server access, follow the
instructions in the [Security](clearml_server_security.md) page.
:::

4
docs/deploying_clearml/clearml_server_linux_mac.md
View File

@@ -30,7 +30,7 @@ For Linux users only:
## Deploying
:::caution
:::warning
By default, ClearML Server launches with unrestricted access. To restrict ClearML Server access, follow the
instructions in the [Security](clearml_server_security.md) page.
:::
@@ -157,7 +157,7 @@ After deploying ClearML Server, the services expose the following ports:
## Backing Up and Restoring Data and Configuration
:::caution
:::warning
Stop your server before backing up or restoring data and configuration
:::

2
docs/deploying_clearml/clearml_server_win.md
View File

@@ -15,7 +15,7 @@ and delete all cookies under the ClearML Server URL.
## Deploying
:::caution
:::warning
By default, ClearML Server launches with unrestricted access. To restrict ClearML Server access, follow the instructions in the [Security](clearml_server_security.md) page.
:::

2
docs/deploying_clearml/upgrade_server_aws_ec2_ami.md
View File

@@ -13,7 +13,7 @@ to upgrade and migrate to a [new AWS instance](#upgrading-and-migrating-to-a-new
This section contains the steps to upgrade ClearML Server on the same AWS instance.
:::caution
:::warning
Some legacy **Trains Server** AMIs provided an auto-upgrade on restart capability. This functionality is now deprecated.
:::