Update agent configuration file sample (#122)

docs/clearml_agent.md

@@ -155,8 +155,8 @@ In case a `clearml.conf` file already exists, add a few ClearML Agent specific c
          agent {
             # Set GIT user/pass credentials (if user/pass are set, GIT protocol will be set to https)
             # leave blank for GIT SSH credentials (set force_git_ssh_protocol=true to force SSH protocol)
-           git_user: ""
+            git_user=""
-           git_pass: ""
+            git_pass=""
             # Limit credentials to a single domain, for example: github.com,
             # all other domains will use public access (no user/pass). Default: always send user/pass for any VCS domain
             git_host=""
@@ -169,12 +169,12 @@ In case a `clearml.conf` file already exists, add a few ClearML Agent specific c
             # force_git_ssh_user: git
    
             # unique name of this worker, if None, created based on hostname:process_id
-           # Override with os environment: CLEARML_WORKER_ID
+            # Overridden with os environment: CLEARML_WORKER_NAME
             # worker_id: "clearml-agent-machine1:gpu0"
             worker_id: ""
    
             # worker name, replaces the hostname when creating a unique name for this worker
-           # Override with os environment: CLEARML_WORKER_ID
+            # Overridden with os environment: CLEARML_WORKER_ID
             # worker_name: "clearml-agent-machine1"
             worker_name: ""
    
@@ -182,16 +182,24 @@ In case a `clearml.conf` file already exists, add a few ClearML Agent specific c
             # Example values: "/usr/bin/python3" or "/usr/local/bin/python3.6"
             # The default is the python executing the clearml_agent
             python_binary: ""
+            # ignore any requested python version (Default: False, if a Task was using a
+            # specific python version and the system supports multiple python the agent will use the requested python version)
+            # ignore_requested_python_version: true
    
             # select python package manager:
-           # currently supported pip and conda
+            # currently supported: pip, conda and poetry
-           # poetry is used if pip selected and repository contains poetry.lock file
+            # if "pip" or "conda" are used, the agent installs the required packages
+            # based on the "installed packages" section of the Task. If the "installed packages" is empty,
+            # it will revert to using `requirements.txt` from the repository's root directory.
+            # If Poetry is selected and the root repository contains `poetry.lock` or `pyproject.toml`,
+            # the "installed packages" section is ignored, and poetry is used.
+            # If Poetry is selected and no lock file is found, it reverts to "pip" package manager behaviour.
             package_manager: {
                # supported options: pip, conda, poetry
                type: pip,
                
                # specify pip version to use (examples "<20", "==19.3.1", "", empty string will install the latest version)
-              pip_version: "<20.2",
+               # pip_version: "<20"
                
                # virtual environment inheres packages from system
                system_site_packages: false,
@@ -199,11 +207,11 @@ In case a `clearml.conf` file already exists, add a few ClearML Agent specific c
                force_upgrade: false,
                
                # additional artifact repositories to use when installing python packages
-              # extra_index_url: ["https://allegroai.jfrog.io/clearmlai/api/pypi/public/simple"]
+               # extra_index_url: ["https://allegroai.jfrog.io/clearml/api/pypi/public/simple"]
                extra_index_url: []
    
                # additional conda channels to use when installing with conda package manager
-              conda_channels: ["defaults", "conda-forge", "pytorch", ]
+               conda_channels: ["pytorch", "conda-forge", "defaults", ]
                # conda_full_env_update: false
                # conda_env_as_base_docker: false
                
@@ -247,11 +255,12 @@ In case a `clearml.conf` file already exists, add a few ClearML Agent specific c
             path: ~/.clearml/vcs-cache
             },
    
+            # DEPRECATED: please use `venvs_cache` and set `venvs_cache.path`
             # use venv-update in order to accelerate python virtual environment building
             # Still in beta, turned off by default
-           venv_update: {
+            # venv_update: {
-               enabled: false,
+            #     enabled: false,
-           },
+            # },
    
             # cached folder for specific python package download (mostly pytorch versions)
             pip_download_cache {
@@ -286,10 +295,10 @@ In case a `clearml.conf` file already exists, add a few ClearML Agent specific c
    
             default_docker: {
                 # default docker image to use when running in docker mode
-               image: "nvidia/cuda:10.1-runtime-ubuntu18.04"
+                image: "nvidia/cuda:10.1-cudnn7-runtime-ubuntu18.04"
    
                 # optional arguments to pass to docker image
-               # arguments: ["--ipc=host", ]
+                # arguments: ["--ipc=host"]
             }
    
             # set the OS environments based on the Task's Environment section before launching the Task process.
@@ -299,7 +308,39 @@ In case a `clearml.conf` file already exists, add a few ClearML Agent specific c
             # it Should be detected automatically. Override with os environment CUDA_VERSION / CUDNN_VERSION
             # cuda_version: 10.1
             # cudnn_version: 7.6
+   
+            # Hide docker environment variables containing secrets when printing out the docker command by replacing their
+            # values with "********". 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 include more environment variables, add their keys to the "extra_keys" list. E.g. to make sure the value of
+            # your custom environment variable named MY_SPECIAL_PASSWORD will not show in the logs when included in the
+            # docker command, set:
+            #   extra_keys: ["MY_SPECIAL_PASSWORD"]
+            hide_docker_command_env_vars {
+               enabled: true
+               extra_keys: []
             }
+   
+            # allow to set internal mount points inside the docker,
+            # especially useful for non-root docker container images.
+            # 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"
+            # }
+   
+            # Name docker containers created by the daemon using the following string format (supported from Docker 0.6.5)
+            # Allowed variables are task_id, worker_id and rand_string (random lower-case letters string, up to 32 characters)
+            # Note: resulting name must start with an alphanumeric character and
+            #       continue with alphanumeric characters, underscores (_), dots (.) and/or dashes (-)
+            # docker_container_name_format: "clearml-id-{task_id}-{rand_string:.8}"
+        }
+
    </div></details>   
 1. Save the configuration.