From 82cd870812c469cc0354cd0483ab1fe5951bc3ba Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Thu, 30 Jan 2025 09:52:44 +0200 Subject: [PATCH 1/3] Update billing and usage page (#1023) --- docs/webapp/settings/webapp_settings_overview.md | 2 +- docs/webapp/settings/webapp_settings_usage_billing.md | 6 +++--- docs/webapp/webapp_overview.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/webapp/settings/webapp_settings_overview.md b/docs/webapp/settings/webapp_settings_overview.md index d44fe05f..0f06fef6 100644 --- a/docs/webapp/settings/webapp_settings_overview.md +++ b/docs/webapp/settings/webapp_settings_overview.md @@ -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 \ No newline at end of file diff --git a/docs/webapp/settings/webapp_settings_usage_billing.md b/docs/webapp/settings/webapp_settings_usage_billing.md index 17d0549b..51ba9dcc 100644 --- a/docs/webapp/settings/webapp_settings_usage_billing.md +++ b/docs/webapp/settings/webapp_settings_usage_billing.md @@ -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) diff --git a/docs/webapp/webapp_overview.md b/docs/webapp/webapp_overview.md index 53da14dc..bd337985 100644 --- a/docs/webapp/webapp_overview.md +++ b/docs/webapp/webapp_overview.md @@ -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 From 93be9006f3a90fab0f59037f831e0466ab0203a2 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Thu, 30 Jan 2025 09:53:35 +0200 Subject: [PATCH 2/3] Add `agent.docker_args_filters` config option (#1019) --- docs/clearml_agent/clearml_agent_env_var.md | 1 + docs/configs/clearml_conf.md | 9 +++++++++ 2 files changed, 10 insertions(+) diff --git a/docs/clearml_agent/clearml_agent_env_var.md b/docs/clearml_agent/clearml_agent_env_var.md index 1f55bb9c..93c7c6ff 100644 --- a/docs/clearml_agent/clearml_agent_env_var.md +++ b/docs/clearml_agent/clearml_agent_env_var.md @@ -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. | diff --git a/docs/configs/clearml_conf.md b/docs/configs/clearml_conf.md index 859c7bd9..6cb9e210 100644 --- a/docs/configs/clearml_conf.md +++ b/docs/configs/clearml_conf.md @@ -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 From d963d1d1513b6c168c36a2342abc9ece081806f6 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Thu, 30 Jan 2025 09:54:26 +0200 Subject: [PATCH 3/3] Update Storage credentials page (#1022) --- docs/webapp/settings/webapp_settings_storage_credentials.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/webapp/settings/webapp_settings_storage_credentials.md b/docs/webapp/settings/webapp_settings_storage_credentials.md index 1435c5d5..26260d77 100644 --- a/docs/webapp/settings/webapp_settings_storage_credentials.md +++ b/docs/webapp/settings/webapp_settings_storage_credentials.md @@ -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)