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

Merge branch 'main' of https://github.com/allegroai/clearml-docs

Browse Source
This commit is contained in:
revital 2025-02-02 07:06:51 +02:00
commit 9ab6e7f1c6
6 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/clearml_agent/clearml_agent_env_var.md
View File

@ -23,6 +23,7 @@ but can be overridden by command-line arguments.
|**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_DOCKER_ARGS_FILTERS**| Set a whitelist of allowed Docker arguments. Only arguments matching the specified patterns can be used when running a task. Use `shlex.split` whitespace-separated format. For example: `CLEARML_AGENT_DOCKER_ARGS_FILTERS="^--env$ ^-e$"`|
|**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. |

9
docs/configs/clearml_conf.md
View File

@ -134,6 +134,15 @@ Use with care! This might introduce security risks by allowing access to keys/se
the same argument is passed in both. If set to `False`, a task's docker arguments will override the `extra_docker_arguments`.
---
**`agent.docker_args_filters`** (*list*)
* Set a whitelist of allowed Docker arguments. Only arguments matching the specified patterns can be used when running
a task. For example: `docker_args_filters: ["^--env$", "^-e$"]`.
---
**`agent.docker_container_name_format`** (*string*)
:::note Compatibility Required

2
docs/webapp/settings/webapp_settings_overview.md
View File

@ -24,6 +24,6 @@ The Settings page consists of the following sections:
* [Identity Providers](webapp_settings_id_providers.md) (ClearML Enterprise Server) - Manage server identity providers
* [Resource Configuration](webapp_settings_resource_configs.md) (ClearML Enterprise Server) - Define the available resources and the way in which they
will be allocated to different workloads
* [Usage & Billing](webapp_settings_usage_billing.md) (ClearML Hosted Service) - View current usage information and billing details
* [Billing & Usage](webapp_settings_usage_billing.md) (ClearML Hosted Service) - View current billing details and usage information
* [Storage Credentials](webapp_settings_storage_credentials.md) (ClearML Enterprise Server) - Configure storage provider access credentials to
enable ClearML to delete artifacts stored in cloud storage when tasks and models are deleted

4
docs/webapp/settings/webapp_settings_storage_credentials.md
View File

@ -2,10 +2,6 @@
title: Storage Credentials
---
:::important Enterprise Feature
This feature is available under the ClearML Enterprise plan.
:::
To enable ClearML to delete task artifacts stored in cloud storage when a task is deleted, configure access credentials for your storage provider:
* [Google Cloud Storage](#google-cloud-storage)
* [AWS S3 Storage](#aws-s3-storage)

6
docs/webapp/settings/webapp_settings_usage_billing.md
View File

@ -1,8 +1,8 @@
---
title: Usage & Billing
title: Billing & Usage
---
The **USAGE & BILLING** section displays your ClearML workspace usage information including:
The **Billing & Usage** section displays your ClearML workspace usage information including:
* Number of workspace users
* Available storage
* Number of monthly API calls
@ -17,7 +17,7 @@ To add users to your workspace, click **INVITE USERS** in the **USERS** section.
If you use up your free resources, consider upgrading your account! See the [ClearML pricing page](https://clear.ml/pricing/)
for additional plans information.
With the ClearML Pro plan, the **USAGE & BILLING** page additionally shows estimated charges for the current billing
With the ClearML Pro plan, the **Billing & Usage** page additionally shows estimated charges for the current billing
period and provides access to billing information.
![Billing and Usage pro](../../img/settings_billing_usage.png)

2
docs/webapp/webapp_overview.md
View File

@ -45,7 +45,7 @@ in the top right corner of the web UI screen to access the following:
* Manage [server identity providers](settings/webapp_settings_id_providers.md) (available in the ClearML Enterprise plan)
* Define the [available resources](settings/webapp_settings_resource_configs.md) and the way in which they will be
allocated to different workloads (available in the ClearML Enterprise plan)
* View [usage and billing](settings/webapp_settings_usage_billing.md) information
* View [billing and usage](settings/webapp_settings_usage_billing.md) information
* **Invite a User** to your workspace (supported in hosted service). Click **Invite a User** > input user's
email > click **ADD** > page redirects to the [Users & Groups](settings/webapp_settings_users.md#user-groups) section of
the **Settings** page