Add user management section (#809)

This commit is contained in:
pollfly 2024-03-24 11:04:13 +02:00 committed by GitHub
parent e6868cb81f
commit e401c963da
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 71 additions and 1 deletions

View File

@ -0,0 +1,15 @@
---
title: Access Rules
---
:::important Enterprise Feature
Access Rules are available under the ClearML Enterprise plan
:::
Workspace administrators can use Access Rules to specify which users, service accounts and/or [user groups](user_groups.md)
have access to various workspace resources: projects, tasks, models, dataviews, hyper-datasets and queues. Admins can
specify **Read Only** or **Read & Modify** access to resources.
Through access rules, administrators can enforce and maintain workspace information security.
For more information see [Access Rules](../webapp/webapp_profile.md#access-rules).

View File

@ -0,0 +1,20 @@
---
title: Administrator Vaults
---
:::important Enterprise Feature
Administrator Vaults are available under the ClearML Enterprise plan
:::
Administrators can set configuration for users, [service accounts](../webapp/webapp_profile.md#service-accounts),
and [user groups](../webapp/webapp_profile.md#user-groups) within a ClearML workspace by using central configuration
stores--or Administrator Vaults.
Administrators can define multiple [configuration vaults](../webapp/webapp_profile.md#configuration-vault) which will
each be applied to their designated [user groups](../webapp/webapp_profile.md#user-groups), allowing for custom settings.
Configuration vault values are applied to tasks run by members of the designated user groups. When applied, the configuration
vaults extend and/or override entries in the local ClearML [configuration file](../configs/clearml_conf.md)
where a ClearML task is executed.
For more information see [Administrator Vaults](../webapp/webapp_profile.md#administrator-vaults).

View File

@ -0,0 +1,15 @@
---
title: Identity Providers
---
:::important Enterprise Feature
This feature is available under the ClearML Enterprise plan
:::
Administrators can seamlessly connect ClearML with their identity service providers to easily implement Single Sign On
(SSO). On top of authenticating users, this also allows ClearML to retrieve user information and more. Once an identity
provider connection is configured and enabled, the option appears in your server login page.
ClearML supports standard protocols such as OIDC and SAML, and popular providers, including Auth0, Google, Okta, and more.
For more information see [Identity Providers](../webapp/webapp_profile.md#identity-providers).

View File

@ -0,0 +1,14 @@
---
title: User Groups
---
:::important Enterprise Feature
User Groups are available under the ClearML Enterprise plan
:::
Administrators can define user groups, which can be used for access privilege management. User groups facilitate easy
configuration and access control administration by allowing administrators to assign administrator vaults and access
rules at the group level rather than for each user and/or [service account](../webapp/webapp_profile.md#service-accounts)
individually. Administrators have the flexibility to create user groups, and add or remove members as needed.
For more information see [User Groups](../webapp/webapp_profile.md#user-groups)

View File

@ -146,7 +146,13 @@ module.exports = {
'webapp/webapp_profile']
},
{'Configuring ClearML': ['configs/configuring_clearml', 'configs/clearml_conf', 'configs/env_vars']},
//'References': ['references/clearml_ref','references/clearml_agent_ref'],
{'User Management': [
'user_management/user_groups',
'user_management/access_rules',
'user_management/admin_vaults',
'user_management/identity_providers'
]
},
{'ClearML Server': ['deploying_clearml/clearml_server',
{
'Deploying ClearML Server': ['deploying_clearml/clearml_server_aws_ec2_ami', 'deploying_clearml/clearml_server_gcp',