Update docs (#1026)
Some checks are pending
CI / build (push) Waiting to run

This commit is contained in:
pollfly
2025-02-06 14:11:23 +02:00
committed by GitHub
parent 18d3209059
commit 30805e474d
14 changed files with 50 additions and 77 deletions

View File

@@ -25,5 +25,5 @@ The Settings page consists of the following sections:
* [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
* [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
* [Storage Cleanup](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

View File

@@ -63,7 +63,7 @@ to switch to.
![Workspace configuration page](../../img/settings_workspace_configuration.png#light-mode-only)
![Workspace configuration page](../../img/settings_workspace_configuration_dark.png#dark-mode-only)
### ClearML App Credentials
### ClearML API Credentials
Generate ClearML credentials, made up of an access and secret key pair, and insert them into your [configuration file](../../configs/clearml_conf.md)
or Jupyter Notebook to grant the ClearML SDK and the ClearML Agent API access to the server.
@@ -74,7 +74,7 @@ You can create credentials for any workspace that you are a member of.
1. In **WORKSPACE**, expand the desired workspace's panel (self-deployed ClearML Server users have one workspace)
1. In **App Credentials**, click **+ Create new credentials**
1. In **API Credentials**, click **+ Create new credentials**
1. In the dialog that pops up, you can input a label for the new credentials
@@ -114,7 +114,7 @@ Generate tokens providing API access to the AI Application Gateway endpoints:
### Changing Your Workspace Name
To change the name of your own workspace, click **Edit workspace name** <img src="/docs/latest/icons/ico-edit.svg" alt="Edit Pencil" className="icon size-md" />
(under App credentials) **>** modify the name **>** click <img src="/docs/latest/icons/ico-save.svg" alt="Check Mark" className="icon size-md" />.
(under API credentials) **>** modify the name **>** click <img src="/docs/latest/icons/ico-save.svg" alt="Check Mark" className="icon size-md" />.
### Adding Users to Your Workspace

View File

@@ -1,5 +1,5 @@
---
title: Storage Credentials
title: Storage Cleanup
---
To enable ClearML to delete task artifacts stored in cloud storage when a task is deleted, configure access credentials for your storage provider:
@@ -7,8 +7,8 @@ To enable ClearML to delete task artifacts stored in cloud storage when a task i
* [AWS S3 Storage](#aws-s3-storage)
* [Azure](#azure)
![Storage Credentials page](../../img/webapp_settings_storage_credentials.png#light-mode-only)
![Storage Credentials page](../../img/webapp_settings_storage_credentials_dark.png#dark-mode-only)
![Storage Cleanup page](../../img/webapp_settings_storage_credentials.png#light-mode-only)
![Storage Cleanup page](../../img/webapp_settings_storage_credentials_dark.png#dark-mode-only)
## Google Cloud Storage
Set up credentials for Google Cloud buckets:

View File

@@ -19,6 +19,9 @@ Each row of the table includes:
* If the user's invitation is pending, the date the user was added
* [User groups](#user-groups) (ClearML Enterprise feature)
Use the search bar <img src="/docs/latest/icons/ico-search.svg" alt="Magnifying glass" className="icon size-md space-md" />
to find a specific user by their name, email, or user ID.
![Users table](../../img/settings_user_table.png#light-mode-only)
![Users table](../../img/settings_user_table_dark.png#dark-mode-only)
@@ -68,6 +71,9 @@ Each row of the table includes:
* Credentials - Number of credentials currently available to the account
* Last active time
Use the search bar <img src="/docs/latest/icons/ico-search.svg" alt="Magnifying glass" className="icon size-md space-md" />
to find a specific service account by its name or ID.
Hover over a service account in the table to **Edit** or **Delete** it.
![Service accounts](../../img/settings_service_accounts.png#light-mode-only)
@@ -163,6 +169,8 @@ The system includes three pre-configured groups that can't be removed:
* `Queue admins` - Can create / delete / rename queues
The user group table lists all the active user groups. Each row includes a group's name, description, member list, and ID.
Use the search bar <img src="/docs/latest/icons/ico-search.svg" alt="Magnifying glass" className="icon size-md space-md" />
to find a specific user group by its name, description, or ID.
![User Management Page](../../img/settings_user_management_table.png#light-mode-only)
![User Management Page](../../img/settings_user_management_table_dark.png#dark-mode-only)

View File

@@ -37,7 +37,7 @@ Click the profile menu button <img src="/docs/latest/icons/ico-me.svg" alt="Prof
in the top right corner of the web UI screen to access the following:
* **Settings** - Navigate to ClearML's user [Settings](settings/webapp_settings_profile.md) page:
* Set [WebApp preferences](settings/webapp_settings_profile.md)
* Manage [workspace API credentials](settings/webapp_settings_profile.md#clearml-credentials)
* Manage [workspace API credentials](settings/webapp_settings_profile.md#clearml-api-credentials)
* Configure [cloud storage access credentials](settings/webapp_settings_profile.md#browser-cloud-storage-access) for the ClearML Web UI
* ClearML Hosted service specific options
* Manage [users and workspaces](settings/webapp_settings_users.md)