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

Add agent configs and env vars (#89)

Browse Source
This commit is contained in:
pollfly 2021-10-21 09:45:44 +03:00 committed by GitHub
parent d05555b01a
commit 6d54c6baaa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 60 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
docs/configs/clearml_conf.md
View File

@ -85,6 +85,25 @@ for information about using environment variables with Windows in the configurat
* The apt (Linux package tool) cache folder for mapping Ubuntu package caching into Docker.
---
**`agent.docker_container_name_format`** (*string*)
:::note Support
Supported from Docker 0.6.5
:::
* Set a name format for Docker containers created by a daemon
* The following variables can be used:
* `task_id`
* `worker_id`
* `rand_string` - random lower-case letters string, up to 32 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 (`-`)
---
**`agent.docker_force_pull`** (*bool*)
@ -96,6 +115,12 @@ for information about using environment variables with Windows in the configurat
* `false` - Do not always update.
---
**`agent.docker_internal_mounts`** (*dict*)
* Set internal mount points inside the Docker. This is especially useful for non-root Docker container images.
---
**`agent.docker_pip_cache`** (*string*)
@ -169,6 +194,34 @@ for information about using environment variables with Windows in the configurat
* If not using Git SSH credentials, use this option to specify a Git password for cloning your repositories.
---
**`agent.hide_docker_command_env_vars`** (*dict*)
* 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:
* `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
---
**`agent.ignore_requested_python_version`** (*bool*)
* Indicates whether to ignore any requested python version
* The values are:
* `true` - ignore any requested python version
* `false` - if a task was using a specific python version and the system supports multiple versions, the agent will
use the requested python version (default)
___
**`agent.python_binary`** (*string*)

9
docs/configs/env_vars.md
View File

@ -36,7 +36,7 @@ Overrides Repository Auto-logging
|**CLEARML_FILES_HOST** | Sets the File Server URL
|**CLEARML_API_ACCESS_KEY** | Sets the Server's Public Access Key|
|**CLEARML_API_SECRET_KEY** | Sets the Server's Private Access Key|
|**CLEARML_API_HOST_VERIFY_CERT**| Enables \ Disable server certificate verification (If behind a firewall)|
|**CLEARML_API_HOST_VERIFY_CERT**| Enables \ Disables server certificate verification (If behind a firewall)|
|**CLEARML_OFFLINE_MODE** | Sets Offline mode|
|**CLEARML_NO_DEFAULT_SERVER** | Disables sending information to demo server when no HOST server is set|
@ -50,9 +50,14 @@ Overrides Repository Auto-logging
|**CLEARML_CUDNN_VERSION** | Sets the CUDNN version to be used|
|**CLEARML_CPU_ONLY** | Force CPU only mode|
|**CLEARML_DOCKER_SKIP_GPUS_FLAG**| Skips the GPUs flag (support for docker V18|
|**CLEARML_AGENT_DISABLE_SSH_MOUNT**| Disables the auto `.ssh` mount into the docker|
|**CLEARML_AGENT_GIT_USER** | Sets the Git user for ClearML Agent|
|**CLEARML_AGENT_GIT_PASS** | Sets the Git password for ClearML Agent|
|**CLEARML_AGENT_GIT_HOST** | Sets Git host (only sending login to this host)|
|**CLEARML_AGENT_EXEC_USER**| User for Agent executing tasks (root by default)|
|**CLEARML_AGENT_EXTRA_DOCKER_ARGS**| Overrides extra docker args configuration |
|**CLEARML_AGENT_EXTRA_PYTHON_PATH**| Sets extra python path|
|**CLEARML_AGENT_K8S_HOST_MOUNT / CLEARML_AGENT_DOCKER_HOST_MOUNT**| Specifies Agent's mount point for Docker \ K8s|
|**CLEARML_AGENT_INITIAL_CONNECT_RETRY_OVERRIDE**| Overrides initial server connection behavior (true by default), allows explicit number to specify number of connect retries) |
|**CLEARML_AGENT_K8S_HOST_MOUNT / CLEARML_AGENT_DOCKER_HOST_MOUNT**| Specifies Agent's mount point for Docker \ K8s|
|**CLEARML_AGENT_SKIP_PIP_VENV_INSTALL**| Skips Python virtual env installation on execute and provides a custom venv binary |
|**CLEARML_AGENT_VENV_CACHE_PATH**|Overrides venv cache folder configuration|