From dd9ab1fe17d20f4f08322ca0bdeaf873dc7565f6 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Tue, 11 Oct 2022 12:16:44 +0300 Subject: [PATCH] Add new ClearML Agent env var and config options (#348) --- docs/clearml_agent/clearml_agent_env_var.md | 3 +++ docs/configs/clearml_conf.md | 19 +++++++++++++++++++ 2 files changed, 22 insertions(+) diff --git a/docs/clearml_agent/clearml_agent_env_var.md b/docs/clearml_agent/clearml_agent_env_var.md index 113f7f6e..b67d4042 100644 --- a/docs/clearml_agent/clearml_agent_env_var.md +++ b/docs/clearml_agent/clearml_agent_env_var.md @@ -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| \ No newline at end of file diff --git a/docs/configs/clearml_conf.md b/docs/configs/clearml_conf.md index dbdd1d98..bdf20d99 100644 --- a/docs/configs/clearml_conf.md +++ b/docs/configs/clearml_conf.md @@ -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.