ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-02-07 13:21:46 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add new ClearML Agent env var and config options (#348)

Browse Source
This commit is contained in:
pollfly 2022-10-11 12:16:44 +03:00 committed by GitHub
parent 20d427db41
commit dd9ab1fe17
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/clearml_agent/clearml_agent_env_var.md
View File

@ -27,6 +27,9 @@ but can be overridden by command-line arguments.
|**CLEARML_AGENT_EXTRA_PYTHON_PATH**| Sets extra python path|
|**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_K8S_GLUE_START_AGENT_SCRIPT_PATH**| Provide an alternate path to place the agent startup script generated inside a k8s task pod (instead of the default `~/~/__start_agent__.sh`)|
|**CLEARML_AGENT_DEBUG_INFO**| Provide additional debug information for a specific context (currently only the `docker` value is supported)|
|**CLEARML_AGENT_CHILD_AGENTS_COUNT_CMD**|Provide an alternate bash command to list child agents while working in services mode|
|**CLEARML_AGENT_SKIP_PIP_VENV_INSTALL**| Skips Python virtual env installation on execute and provides a custom venv binary |
|**CLEARML_AGENT_SKIP_PYTHON_ENV_INSTALL**| Skips entire Python venv installation and assumes python as well as every dependency is preinstalled|
|**CLEARML_AGENT_VENV_CACHE_PATH**|Overrides venv cache folder configuration|

19
docs/configs/clearml_conf.md
View File

@ -84,6 +84,13 @@ for information about using environment variables with Windows in the configurat
Alternatively, override this option with the environment variable `CUDNN_VERSION`.
---
**`agent.disable_ssh_mount`** (*bool*)
* Set to `true` to disables the auto `.ssh` mount into the docker. The environment variable `CLEARML_AGENT_DISABLE_SSH_MOUNT`
overrides this configuration option.
___
**`agent.docker_apt_cache`** (*string*)
@ -159,6 +166,18 @@ For example:
---
**`agent.enable_git_ask_pass`** (*bool*)
:::note
`enable_git_ask_pass` is supported only on Linux systems
:::
* If enabled, uses `GIT_ASKPASS` to pass Git user/pass when cloning/fetching repositories
* It solves passing user/token to git submodules.
* This is a safer way to ensure multiple users using the same repository will not accidentally leak credentials
---
**`agent.enable_task_env`** (*bool*)
* Set the OS environments based on the Task's Environment section before launching the Task process.