clearml-docs/docs/webapp/settings/webapp_settings_admin_vaults.md

70 lines
3.1 KiB
Markdown
Raw Normal View History

2024-09-29 09:20:11 +00:00
---
title: Administrator Vaults
---
:::info Enterprise Feature
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
2024-11-03 13:32:30 +00:00
[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)
2024-09-29 09:20:11 +00:00
2024-11-03 13:32:30 +00:00
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).
2024-09-29 09:20:11 +00:00
Most existing configuration file entries will be overridden by the vault values.
:::info
The following configuration values are machine and/or agent specific, so they can't be set in a configuration vault:
* `agent.cuda_version`
* `agent.cudnn_version`
* `agent.default_python`
* `agent.worker_id`
* `agent.worker_name`
* `agent.debug`
:::
2024-11-03 13:32:30 +00:00
**To create a Client configuration vault:**
2024-09-29 09:20:11 +00:00
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
2024-11-03 13:32:30 +00:00
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" />.
2024-09-29 09:20:11 +00:00
1. Click **Save**
2024-11-03 13:32:30 +00:00
## 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
2024-09-29 09:20:11 +00:00
The **Administrator Vaults** table lists all currently defined vaults, and the following details:
* Active - Toggle to enable / disable the vault
* Name - Vault name
2024-11-03 13:32:30 +00:00
* Target - Type of vault: `Client (Agent/SDK/CLI)` or `UI storage credentials`
2024-09-29 09:20:11 +00:00
* Group - User groups to apply this vault to
* ID - Vault ID (click to copy)
* Vault Content - Vault content summary
* Update - Last update time
2024-11-03 13:32:30 +00:00
Hover over a vault in the table to **Download**, **Edit**, or **Delete** a vault.
2024-09-29 09:20:11 +00:00
![Admin vaults](../../img/settings_admin_vaults.png)