diff --git a/docs/configs/clearml_conf.md b/docs/configs/clearml_conf.md index 1a2f90d7..5f61c368 100644 --- a/docs/configs/clearml_conf.md +++ b/docs/configs/clearml_conf.md @@ -93,11 +93,11 @@ for information about using environment variables with Windows in the configurat **`agent.docker_container_name_format`** (*string*) -:::note Support -Supported from Docker 0.6.5 +:::note Compatibility Required +Compatible with Docker versions 0.6.5 and above ::: -* Set a name format for Docker containers created by a daemon +* Set a name format for Docker containers created by an agent * The following variables can be used: * `task_id` @@ -106,6 +106,8 @@ Supported from Docker 0.6.5 * The resulting name must start with an alphanumeric character, while the rest of the name may contain alphanumeric characters, underscores (`_`), dots (`.`) and / or dashes (`-`) + +* For example: `clearml-id-{task_id}-{rand_string:.8}` --- @@ -124,7 +126,22 @@ Supported from Docker 0.6.5 **`agent.docker_internal_mounts`** (*dict*) -* Set internal mount points inside the Docker. This is especially useful for non-root Docker container images. +* Set internal mount points inside the Docker. This is especially useful for non-root Docker container images. + +For example: + + ``` + docker_internal_mounts { + sdk_cache: "/clearml_agent_cache" + apt_cache: "/var/cache/apt/archives" + ssh_folder: "/root/.ssh" + pip_cache: "/root/.cache/pip" + poetry_cache: "/root/.cache/pypoetry" + vcs_cache: "/root/.clearml/vcs-cache" + venv_build: "/root/.clearml/venvs-builds" + pip_download: "/root/.clearml/pip-download-cache" + } + ``` --- @@ -202,17 +219,25 @@ Supported from Docker 0.6.5 **`agent.hide_docker_command_env_vars`** (*dict*) -* Hide Docker environment variables containing secrets when printing out the Docker command. When printed, the variable + * Hide Docker environment variables containing secrets when printing out the Docker command. When printed, the variable values will be replaced by `********` -* Turning this feature on will hide the following environment variables values: + * Enable this feature by setting `enabled` to `true`. Doing this will hide the following environment variables values: * `CLEARML_API_SECRET_KEY` * `CLEARML_AGENT_GIT_PASS` * `AWS_SECRET_ACCESS_KEY` * `AZURE_STORAGE_KEY` -* To mask additional environment variables, add their keys to the `extra_keys` list + * To mask additional environment variables, add their keys to the `extra_keys` list. + For example, to hide the value of a custom environment variable named `MY_SPECIAL_PASSWORD`, set `extra_keys: ["MY_SPECIAL_PASSWORD"]` + + ``` + hide_docker_command_env_vars { + enabled: true + extra_keys: ["MY_SPECIAL_PASSWORD"] + } + ``` --- @@ -706,6 +731,16 @@ and limitations on bucket naming.
+--- + +**`sdk.aws.s3.credentials.verify`** (*string*/*boolean*) + +* Specify whether to verify SSL certificates. By default, they are verified. Input a path to a CA bundle, or set to + `false` to skip SSL certificate verification. + + +
+ #### sdk.azure.storage **`sdk.azure.storage.containers`** (*[dict]*) diff --git a/docs/integrations/storage.md b/docs/integrations/storage.md index 040a73e8..a1fc8893 100644 --- a/docs/integrations/storage.md +++ b/docs/integrations/storage.md @@ -40,6 +40,7 @@ aws { # bucket: "my-bucket-name" # key: "my-access-key" # secret: "my-secret-key" + # verify: "/path/to/ca/bundle.crt" OR false to not verify # }, ]