Add configuration options (#114)

This commit is contained in:
pollfly 2021-11-10 09:54:44 +02:00 committed by GitHub
parent 540ae4d476
commit 90302c33ac
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 43 additions and 7 deletions

View File

@ -93,11 +93,11 @@ for information about using environment variables with Windows in the configurat
**`agent.docker_container_name_format`** (*string*) **`agent.docker_container_name_format`** (*string*)
:::note Support :::note Compatibility Required
Supported from Docker 0.6.5 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: * The following variables can be used:
* `task_id` * `task_id`
@ -107,6 +107,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, * The resulting name must start with an alphanumeric character, while the rest of the name may contain alphanumeric characters,
underscores (`_`), dots (`.`) and / or dashes (`-`) underscores (`_`), dots (`.`) and / or dashes (`-`)
* For example: `clearml-id-{task_id}-{rand_string:.8}`
--- ---
@ -126,6 +128,21 @@ Supported from Docker 0.6.5
* 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"
}
```
--- ---
**`agent.docker_pip_cache`** (*string*) **`agent.docker_pip_cache`** (*string*)
@ -202,17 +219,25 @@ Supported from Docker 0.6.5
**`agent.hide_docker_command_env_vars`** (*dict*) **`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 `********` 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_API_SECRET_KEY`
* `CLEARML_AGENT_GIT_PASS` * `CLEARML_AGENT_GIT_PASS`
* `AWS_SECRET_ACCESS_KEY` * `AWS_SECRET_ACCESS_KEY`
* `AZURE_STORAGE_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.
<br/> <br/>
---
**`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.
<br/>
#### sdk.azure.storage #### sdk.azure.storage
**`sdk.azure.storage.containers`** (*[dict]*) **`sdk.azure.storage.containers`** (*[dict]*)

View File

@ -40,6 +40,7 @@ aws {
# bucket: "my-bucket-name" # bucket: "my-bucket-name"
# key: "my-access-key" # key: "my-access-key"
# secret: "my-secret-key" # secret: "my-secret-key"
# verify: "/path/to/ca/bundle.crt" OR false to not verify
# }, # },
] ]