ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-06-26 18:17:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update docs (#948)

Browse Source
This commit is contained in:
pollfly
2024-11-03 15:32:30 +02:00
committed by GitHub
parent af5639ac99
commit be102be4c3
51 changed files with 458 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/webapp/settings/webapp_settings_admin_vaults.md
View File

@@ -7,10 +7,17 @@ This feature is available under the ClearML Enterprise plan.
:::
Administrators can define multiple [configuration vaults](webapp_settings_profile.md#configuration-vault) which will each be applied to designated
[user groups](webapp_settings_users.md). Use configuration vaults to extend and/or override entries in the local ClearML [configuration file](../../configs/clearml_conf.md)
where a ClearML task is executed. Configuration vault values will be applied to tasks run by members of the designated user groups.
[user groups](webapp_settings_users.md). There are two types of vaults:
* [Client configuration (Agent/SDK/CLI)](#client-configuration-agentsdkcli)
* [UI storage credentials](#ui-storage-credentials)
To apply its contents, a vault should be enabled. New entries will extend the configuration in the local ClearML [configuration file](../../configs/clearml_conf.md).
To apply its contents, a vault should be enabled in the [Administrator Vault Table](#administrator-vault-table).
## Client Configuration (Agent/SDK/CLI)
Client configuration vaults extend and/or override entries in the local ClearML [configuration file](../../configs/clearml_conf.md)
where a task is executed. Vault values will be applied to tasks run by members of the designated user groups.
New entries will extend the configuration in the local ClearML [configuration file](../../configs/clearml_conf.md).
Most existing configuration file entries will be overridden by the vault values.
:::info
@@ -23,24 +30,41 @@ The following configuration values are machine and/or agent specific, so they ca
* `agent.debug`
:::
**To create a vault:**
**To create a Client configuration vault:**
1. Click **+ Add Vault**
1. Fill in vault details:
1. Vault name - Name that appears in the Administrator Vaults table
1. User Group - Specify the User Group that the vault affects
1. Format - Specify the configuration format: HOCON / JSON / YAML.
1. Fill in the configuration values (click <img src="/docs/latest/icons/ico-info.svg" alt="Info" className="icon size-md space-sm" />
to view configuration file reference). To import and existing configuration file, click <img src="/docs/latest/icons/ico-import.svg" alt="Import" className="icon size-md space-sm" />.
1. Target - Vault type. Select `Client (Agent/SDK/UI)`
1. Format - Specify the configuration format: HOCON / JSON / YAML.
1. Fill in the configuration values (click <img src="/docs/latest/icons/ico-info.svg" alt="Info" className="icon size-md space-sm" />
to view configuration file reference). To import an existing configuration file, click <img src="/docs/latest/icons/ico-import.svg" alt="Import" className="icon size-md space-sm" />.
1. Click **Save**
## UI Storage Credentials
UI storage credential vaults configure UI access to cloud storage credentials for a designated group of users.
**To create a vault:**
1. Click **+ Add Vault**
1. Fill in vault details:
1. Vault name - Name that appears in the Administrator Vaults table
1. User Group - Specify the User Group that the vault affects
1. Target - Select `UI storage credentials`
1. \+ Add access keys - Enter storage credentials (see [Browser Cloud Storage Access](webapp_settings_profile.md#browser-cloud-storage-access))
1. Click **Save**
## Administrator Vault Table
The **Administrator Vaults** table lists all currently defined vaults, and the following details:
* Active - Toggle to enable / disable the vault
* Name - Vault name
* Target - Type of vault: `Client (Agent/SDK/CLI)` or `UI storage credentials`
* Group - User groups to apply this vault to
* ID - Vault ID (click to copy)
* Vault Content - Vault content summary
* Update - Last update time
Hover over a vault in the table to Download, Edit, or Delete a vault.
Hover over a vault in the table to **Download**, **Edit**, or **Delete** a vault.
![Admin vaults](../../img/settings_admin_vaults.png)