From 25709e30a75bcc608f7132026ce0c50f6bcf916c Mon Sep 17 00:00:00 2001
From: pollfly <75068813+pollfly@users.noreply.github.com>
Date: Tue, 26 Dec 2023 15:06:23 +0200
Subject: [PATCH] Update ClearML Agent config options (#739)

---
 docs/clearml_agent/clearml_agent_env_var.md |  4 ++++
 docs/configs/clearml_conf.md                | 14 +++++++++++++-
 2 files changed, 17 insertions(+), 1 deletion(-)

diff --git a/docs/clearml_agent/clearml_agent_env_var.md b/docs/clearml_agent/clearml_agent_env_var.md
index ad1f2b4f..59026692 100644
--- a/docs/clearml_agent/clearml_agent_env_var.md
+++ b/docs/clearml_agent/clearml_agent_env_var.md
@@ -21,7 +21,10 @@ but can be overridden by command-line arguments.
 |**CLEARML_DOCKER_SKIP_GPUS_FLAG** | Skips the GPUs flag (support for docker V18                                                                                                                                                                                                     |
 |**CLEARML_AGENT_DOCKER_ARGS_HIDE_ENV** | Hide Docker environment variables containing secrets when printing out the Docker command. When printed, the variable values will be replaced by `********`. See [`agent.hide_docker_command_env_vars`](../configs/clearml_conf.md#hide_docker) |
 |**CLEARML_AGENT_DISABLE_SSH_MOUNT** | Disables the auto `.ssh` mount into the docker                                                                                                                                                                                                  |
+|**CLEARML_AGENT_FORCE_CODE_DIR**| Allows overriding the remote execution code directory to bypass repository cloning and use a repo already available where the remote agent is running. |
+|**CLEARML_AGENT_FORCE_EXEC_SCRIPT**| Allows overriding the remote execution script to bypass repository cloning and execute code already available where the remote agent is running|
 |**CLEARML_AGENT_FORCE_SYSTEM_SITE_PACKAGES** | If set to `true`, overrides default [`agent.package_manager.system_site_packages: true`](../configs/clearml_conf.md#system_site_packages) behavior when running tasks in containers (docker mode and k8s-glue)|
+|**CLEARML_AGENT_GIT_CLONE_VERBOSE**| If set to `true`, `git clone` calls will report progress verbosely  |
 |**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)                                                                                                                                                                                                 |
@@ -33,6 +36,7 @@ but can be overridden by command-line arguments.
 |**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_NO_UPDATE** | Boolean. Set to `true` to skip agent update in the k8s pod container before the agent executes the task |
 |**CLEARML_AGENT_K8S_HOST_MOUNT / CLEARML_AGENT_DOCKER_HOST_MOUNT** | Specifies Agent's mount point for Docker / K8s                                                                                                                                                                                                  |
+|**CLEARML_AGENT_TEMP_STDOUT_FILE_DIR**|Allows overriding the default `/tmp` location for agent temporary files|
 |**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_PACKAGE_PYTORCH_RESOLVE**|Sets the PyTorch resolving mode. The options are: <ul><li>`none` - No resolving. Install PyTorch like any other package</li><li>`pip` (default) - Sets extra index based on cuda and lets pip resolve</li><li>`direct` - Resolve a direct link to the PyTorch wheel by parsing the pytorch.org pip repository, and matching the automatically detected cuda version with the required PyTorch wheel. If the exact cuda version is not found for the required PyTorch wheel, it will try a lower cuda version until a match is found</li></ul>  |
 |**CLEARML_AGENT_DEBUG_INFO** | Provide additional debug information for a specific context (currently only the `docker` value is supported)                                                                                                                                    |
diff --git a/docs/configs/clearml_conf.md b/docs/configs/clearml_conf.md
index 0000eaac..b6259937 100644
--- a/docs/configs/clearml_conf.md
+++ b/docs/configs/clearml_conf.md
@@ -126,6 +126,12 @@ Use with care! This might introduce security risks by allowing access to keys/se
         
 ---
 
+**`docker_args_extra_precedes_task`** (*bool*)
+
+*  Allow the arguments specified in `agent.extra_docker_arguments` to override task level docker arguments, in the case that
+the same argument is passed in both. If set to `False`, a task's docker arguments will override the `extra_docker_arguments`.
+
+---
 **`agent.docker_container_name_format`** (*string*)
 
 :::note Compatibility Required
@@ -329,7 +335,13 @@ from `system_site_packages`
       use the requested python version (default)
 
 ___
-        
+
+**`agent.protected_docker_extra_args`** (*[string]*)   
+
+* Prevent listed task docker arguments from being used if they are already specified in `agent.extra_docker_arguments`. 
+
+---
+
 **`agent.python_binary`** (*string*)
         
 * Set the Python version to use when creating the virtual environment, and when launching the experiment. For example, `/usr/bin/python3` or `/usr/local/bin/python3.6`.