clearml-docs/docs/webapp/settings/webapp_settings_admin_vaults.md
2024-11-03 16:42:54 +02:00

3.1 KiB

title
Administrator Vaults

:::info Enterprise Feature This feature is available under the ClearML Enterprise plan. :::

Administrators can define multiple configuration vaults which will each be applied to designated user groups. There are two types of vaults:

To apply its contents, a vault should be enabled in the Administrator Vault Table.

Client Configuration (Agent/SDK/CLI)

Client configuration vaults extend and/or override entries in the local ClearML configuration file 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. 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 :::

To create a Client configuration vault:

  1. Click + Add Vault
  2. Fill in vault details:
    1. Vault name - Name that appears in the Administrator Vaults table
    2. User Group - Specify the User Group that the vault affects
    3. Target - Vault type. Select Client (Agent/SDK/UI)
    4. Format - Specify the configuration format: HOCON / JSON / YAML.
    5. Fill in the configuration values (click Info to view configuration file reference). To import an existing configuration file, click Import.
  3. 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
  2. Fill in vault details:
    1. Vault name - Name that appears in the Administrator Vaults table
    2. User Group - Specify the User Group that the vault affects
    3. Target - Vault type. Select UI storage credentials
    4. + Add access keys - Enter storage credentials (see Browser Cloud Storage Access)
  3. 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.

Admin vaults