From d7fea150512605e9b696a4e161fcd673ff14e999 Mon Sep 17 00:00:00 2001 From: AnthonyTsu1984 <115786031+AnthonyTsu1984@users.noreply.github.com> Date: Wed, 5 Feb 2025 15:28:28 +0800 Subject: [PATCH] update rbac Signed-off-by: AnthonyTsu1984 <115786031+AnthonyTsu1984@users.noreply.github.com> --- site/en/adminGuide/grant_privileges.md | 118 ++++++++++++------------- site/en/adminGuide/privilege_group.md | 24 ++--- site/en/adminGuide/rbac.md | 10 +-- site/en/menuStructure/en.json | 33 +++++-- 4 files changed, 102 insertions(+), 83 deletions(-) diff --git a/site/en/adminGuide/grant_privileges.md b/site/en/adminGuide/grant_privileges.md index f5ea0d796..1009e2940 100644 --- a/site/en/adminGuide/grant_privileges.md +++ b/site/en/adminGuide/grant_privileges.md @@ -71,7 +71,7 @@ Milvus 2.5 introduces a new version of API which streamlines the grant operation -- **Privilege**: The specific privilege or [privilege group](https://zilliverse.feishu.cn/wiki/GpoUwWH7kiAF3bkKqokcTAS4n5d) that you need to grant to a role. Currently, Milvus provides 56 types of privileges that you can grant. The table below lists the privileges in Milvus.​ +- **Privilege**: The specific privilege or [privilege group](privilege_group.md) that you need to grant to a role. Currently, Milvus provides 56 types of privileges that you can grant. The table below lists the privileges in Milvus.​
@@ -79,13 +79,13 @@ Milvus 2.5 introduces a new version of API which streamlines the grant operation
-

**Type **​

+

Type ​

-

**Privilege**​

+

Privilege​

-

**Description**​

+

Description​

-

**Relevant API description on the client side**​

+

Relevant API description on the client side​

Database Privileges​

@@ -93,31 +93,31 @@ Milvus 2.5 introduces a new version of API which streamlines the grant operation

View all databases in the current instance​

-

[ListDatabases](https://milvus.io/docs/manage_databases.md)​

+

ListDatabases​

DescribeDatabase​

View the details of a database​

-

[DescribeDatabase](https://milvus.io/docs/manage_databases.md)​

+

DescribeDatabase​

CreateDatabase​

Create a database​

-

[CreateDatabase](https://milvus.io/docs/manage_databases.md)​

+

CreateDatabase​

DropDatabase​

Drop a database​

-

[DropDatabase](https://milvus.io/docs/manage_databases.md)​

+

DropDatabase​

AlterDatabase​

Modify the properties of a database​

-

[AlterDatabase](https://milvus.io/docs/manage_databases.md)​

+

AlterDatabase​

Collection Privileges​

@@ -127,73 +127,73 @@ Milvus 2.5 introduces a new version of API which streamlines the grant operation

Check the status of the collection flush operation​

-

[GetFlushState](https://milvus.io/api-reference/pymilvus/v2.5.x/ORM/Collection/flush.md)​

+

GetFlushState​

GetLoadState​

Check the load status of a collection​

-

[GetLoadState](https://milvus.io/api-reference/restful/v2.5.x/v2/Collection%20(v2)/Get%20Load%20State.md)​

+

GetLoadState​

GetLoadingProgress​

Check the loading progress of a collection​

-

[GetLoadingProgress](https://milvus.io/api-reference/pymilvus/v2.5.x/ORM/utility/loading_progress.md)​

+

GetLoadingProgress​

ShowCollections​

View all collections with collection privileges​

-

[ShowCollections](https://milvus.io/docs/view-collections.md)​

+

ShowCollections​

ListAliases​

View all aliases of a collection​

-

[ListAliases](https://milvus.io/api-reference/pymilvus/v2.5.x/MilvusClient/Collections/list_aliases.md)​

+

ListAliases​

DescribeCollection​

View the details of a collection​

-

[DescribeCollection](https://milvus.io/api-reference/pymilvus/v2.5.x/MilvusClient/Collections/describe_collection.md)​

+

DescribeCollection​

DescribeAlias​

View the details of an alias​

-

[DescribeAlias](https://milvus.io/api-reference/pymilvus/v2.5.x/MilvusClient/Collections/describe_alias.md)​

+

DescribeAlias​

GetStatistics​

Obtain the statistics of a collection (eg. The number of entities in a collection)​

-

[GetCollectionStatistics](https://milvus.io/api-reference/pymilvus/v2.5.x/MilvusClient/Collections/get_collection_stats.md)​

+

GetCollectionStatistics​

CreateCollection​

Create a collection​

-

[CreateCollection](https://milvus.io/docs/create-collection.md)​

+

CreateCollection​

DropCollection​

Drop a collection​

-

[DropCollection](https://milvus.io/docs/drop-collection.md)​

+

DropCollection​

Load​

Load a collection​

-

[LoadCollection](https://milvus.io/docs/load-and-release.md)/[GetLoadingProgress](https://milvus.io/api-reference/pymilvus/v2.5.x/ORM/utility/loading_progress.md)/[GetLoadState](https://milvus.io/api-reference/restful/v2.5.x/v2/Collection%20(v2)/Get%20Load%20State.md)​

+

Release​

Release a collection​

-

[ReleaseCollection](https://milvus.io/docs/load-and-release.md)​

+

ReleaseCollection​

Flush​

@@ -201,37 +201,37 @@ Milvus 2.5 introduces a new version of API which streamlines the grant operation

Persist all entities in a collection to a sealed segment. Any entity inserted after the flush operation will be stored in a new segment.​

-

[Flush](https://milvus.io/api-reference/pymilvus/v2.5.x/ORM/Collection/flush.md)/[GetFlushState](https://milvus.io/api-reference/pymilvus/v2.5.x/ORM/Collection/flush.md)​

+

Compaction​

Manually trigger compaction​

-

[Compact](https://milvus.io/docs/v2.0.x/compact_data.md)​

+

Compact​

RenameCollection​

Rename a collection​

-

[RenameCollection](https://milvus.io/docs/modify-collection.md)​

+

RenameCollection​

CreateAlias​

Create an alias for a collection​

-

[CreateAlias](https://milvus.io/docs/manage-aliases.md)​

+

CreateAlias​

DropAlias​

Drop the alias of a collection​

-

[DropAlias](https://milvus.io/docs/manage-aliases.md)​

+

DropAlias​

FlushAll​

Flush all collections in a database​

-

[FlushAll](https://milvus.io/api-reference/pymilvus/v2.5.x/ORM/utility/flush_all.md)​

+

FlushAll​

Partition Privileges​

@@ -239,25 +239,25 @@ Milvus 2.5 introduces a new version of API which streamlines the grant operation

Check whether a partition exists​

-

[HasPartition](https://milvus.io/docs/manage-partitions.md)​

+

HasPartition​

ShowPartitions​

View all partitions in a collection​

-

[ShowPartitions](https://milvus.io/docs/manage-partitions.md)​

+

ShowPartitions​

CreatePartition​

Create a partition​

-

[CreatePartition](https://milvus.io/docs/manage-partitions.md)​

+

CreatePartition​

DropPartition​

Drop a partition​

-

[DropPartition](https://milvus.io/docs/manage-partitions.md)​

+

DropPartition​

Index Privileges​

@@ -267,19 +267,19 @@ Milvus 2.5 introduces a new version of API which streamlines the grant operation

​

-

[DescribeIndex/GetIndexState/GetIndexBuildProgress](https://milvus.io/docs/index-vector-fields.md?tab=floating)​

+

DescribeIndex/GetIndexState/GetIndexBuildProgress​

CreateIndex​

Create an index​

-

[CreateIndex](https://milvus.io/docs/index-vector-fields.md?tab=floating)​

+

CreateIndex​

DropIndex​

Drop an index​

-

[DropIndex](https://milvus.io/docs/index-vector-fields.md?tab=floating)​

+

DropIndex​

Resource Management Privileges​

@@ -289,49 +289,49 @@ Milvus 2.5 introduces a new version of API which streamlines the grant operation

Achieve load balance​

-

[LoadBalance](https://milvus.io/docs/resource_group.md)​

+

LoadBalance​

CreateResourceGroup​

Create a resource group​

-

[CreateResourceGroup](https://milvus.io/api-reference/pymilvus/v2.5.x/ORM/utility/create_resource_group.md)​

+

CreateResourceGroup​

DropResourceGroup​

Drop a resource group​

-

[DropResourceGroup](https://milvus.io/docs/resource_group.md)​

+

DropResourceGroup​

UpdateResourceGroups​

Update a resource group​

-

[UpdateResourceGroups](https://milvus.io/docs/resource_group.md)​

+

UpdateResourceGroups​

DescribeResourceGroup​

View the details of a resource group​

-

[DescribeResourceGroup](https://milvus.io/docs/resource_group.md)​

+

DescribeResourceGroup​

ListResourceGroups​

View all resource groups of the current instance​

-

[ListResourceGroups](https://milvus.io/docs/resource_group.md)​

+

ListResourceGroups​

TransferNode​

Transfer nodes between resource groups​

-

[TransferNode](https://milvus.io/docs/resource_group.md)​

+

TransferNode​

TransferReplica​

Transfer replicas between resource groups​

-

[TransferReplica](https://milvus.io/docs/resource_group.md)​

+

TransferReplica​

BackupRBAC​

@@ -353,37 +353,37 @@ Milvus 2.5 introduces a new version of API which streamlines the grant operation

Conduct a query​

-

[Query](https://milvus.io/docs/get-and-scalar-query.md)​

+

Query​

Search​

Conduct a search​

-

[Search](https://milvus.io/docs/single-vector-search.md)​

+

Search​

Insert​

Insert entities​

-

[Insert](https://milvus.io/docs/insert-update-delete.md)​

+

Insert​

Delete​

Delete entities​

-

[Delete](https://milvus.io/docs/delete-entities.md)​

+

Delete​

Upsert​

Upsert entities​

-

[Upsert](https://milvus.io/docs/upsert-entities.md)​

+

Upsert​

Import​

Bulk insert or import entities​

-

[BulkInsert/Import](https://milvus.io/docs/import-data.md)​

+

BulkInsert/Import​

RBAC Privileges​

@@ -391,61 +391,61 @@ Milvus 2.5 introduces a new version of API which streamlines the grant operation

Create a user or a role​

-

[CreateUser/CreateRole](https://zilliverse.feishu.cn/wiki/CnzkwQBW3i7bE3kVtLzcqQLtn9d)​

+

CreateUser/CreateRole​

UpdateUser​

Update the password of a user​

-

[UpdateCredential](https://zilliverse.feishu.cn/wiki/CnzkwQBW3i7bE3kVtLzcqQLtn9d)​

+

UpdateCredential​

DropOwnership​

Drop a user password or a role​

-

[DeleteCredential/DropRole](https://zilliverse.feishu.cn/wiki/OqZnwJHrJilLPukfvp5cSgnmnTh)​

+

DeleteCredential/DropRole​

SelectOwnership​

View all users that are granted a specific role ​

-

[SelectRole/SelectGrant](https://zilliverse.feishu.cn/wiki/ZsNZwn1MkiOtH9kFU35cyRgVnue)​

+

SelectRole/SelectGrant​

ManageOwnership​

Manage a user or a role or grant a role to a user​

-

[OperateUserRole/OperatePrivilege/OperatePrivilegeV2](https://zilliverse.feishu.cn/wiki/ZsNZwn1MkiOtH9kFU35cyRgVnue)​

+

OperateUserRole/OperatePrivilege/OperatePrivilegeV2​

SelectUser​

View all roles granted to a user​

-

[SelectUser](https://zilliverse.feishu.cn/wiki/ZsNZwn1MkiOtH9kFU35cyRgVnue)​

+

SelectUser​

CreatePrivilegeGroup​

Create a privilege group​

-

[CreatePrivilegeGroup](https://zilliverse.feishu.cn/wiki/FpV8wdWcZiDwnQkBloucYF7wnUg)​

+

CreatePrivilegeGroup​

DropPrivilegeGroup​

Drop a privilege group​

-

[DropPrivilegeGroup](https://zilliverse.feishu.cn/wiki/FpV8wdWcZiDwnQkBloucYF7wnUg)​

+

DropPrivilegeGroup​

ListPrivilegeGroups​

View all privilege groups in the current instance​

-

[ListPrivilegeGroups](https://zilliverse.feishu.cn/wiki/FpV8wdWcZiDwnQkBloucYF7wnUg)​

+

ListPrivilegeGroups​

OperatePrivilegeGroup​

Add privileges to or remove privileges from a privilege group​

-

[OperatePrivilegeGroup](https://zilliverse.feishu.cn/wiki/FpV8wdWcZiDwnQkBloucYF7wnUg)​

+

OperatePrivilegeGroup​

diff --git a/site/en/adminGuide/privilege_group.md b/site/en/adminGuide/privilege_group.md index 1c3c9f825..b0fdccb26 100644 --- a/site/en/adminGuide/privilege_group.md +++ b/site/en/adminGuide/privilege_group.md @@ -45,13 +45,13 @@ The following tables explains the privileges includes in each of the built-in pr The table below lists the specific privileges included in the three built-in privilege groups at the collection level:​ -

**Privilege**​

+

Privilege​

-

**CollectionReadOnly**​

+

CollectionReadOnly​

-

**CollectionReadWrite**​

+

CollectionReadWrite​

-

**CollectionAdmin**​

+

CollectionAdmin​

Query​

@@ -281,13 +281,13 @@ The table below lists the specific privileges included in the three built-in pri The table below lists the specific privileges included in the three built-in privilege groups at the database level:​ -

**Privilege**​

+

Privilege​

-

**DatabaseReadOnly**​

+

DatabaseReadOnly​

-

**DatabaseReadWrite**​

+

DatabaseReadWrite​

-

**DatabaseAdmin**​

+

DatabaseAdmin​

ShowCollections​

@@ -341,13 +341,13 @@ The table below lists the specific privileges included in the three built-in pri The table below lists the specific privileges included in the three built-in privilege groups at the instance level:​ -

**Privilege**​

+

Privilege​

-

**ClusterReadOnly**​

+

ClusterReadOnly​

-

**ClusterReadWrite**​

+

ClusterReadWrite​

-

**ClusterAdmin**​

+

ClusterAdmin​

ListDatabases​

diff --git a/site/en/adminGuide/rbac.md b/site/en/adminGuide/rbac.md index d8f9aca84..6edce943c 100644 --- a/site/en/adminGuide/rbac.md +++ b/site/en/adminGuide/rbac.md @@ -19,15 +19,15 @@ The RBAC model can improve the efficiency of access control management. For exam There are four major components in the RBAC model.​ -- **Resource: **The resource entity that can be accessed. There are three levels of resources in Milvus - instance, database, and collection.​ +- **Resource**: The resource entity that can be accessed. There are three levels of resources in Milvus - instance, database, and collection.​ -- **Privilege: **The permission to perform certain operations on Milvus resources (eg. create collections, insert data, etc). ​ +- **Privilege**: The permission to perform certain operations on Milvus resources (eg. create collections, insert data, etc). ​ -- **Privilege group: **A group of multiple privileges.​ +- **Privilege group**: A group of multiple privileges.​ -- **Role: **A role consists of two parts-privileges and resources. Privileges define the type of operations that a role can perform while resources define the target resources that the operations can be performed on. For example, the database administrator role can perform read, write, and manage operations on certain databases.​ +- **Role**: A role consists of two parts-privileges and resources. Privileges define the type of operations that a role can perform while resources define the target resources that the operations can be performed on. For example, the database administrator role can perform read, write, and manage operations on certain databases.​ -- **User: **A user is someone who uses Milvus. Each user has a unique ID and is granted a role or multiple roles. ​ +- **User**: A user is someone who uses Milvus. Each user has a unique ID and is granted a role or multiple roles. ​ ## Procedures​ diff --git a/site/en/menuStructure/en.json b/site/en/menuStructure/en.json index a6f33f5d1..4733337b6 100644 --- a/site/en/menuStructure/en.json +++ b/site/en/menuStructure/en.json @@ -1426,18 +1426,37 @@ "order": 0, "children": [] }, - { - "label": "Users, Privileges, and Roles", - "id": "users_and_roles.md", - "order": 10, - "children": [] - }, { "label": "Enable RBAC", "id": "rbac.md", "order": 1, "isMenu": true, - "children": [] + "children": [ + { + "label": "Users, Privileges, and Roles", + "id": "users_and_roles.md", + "order": 0, + "children": [] + }, + { + "label": "Privilege Group", + "id": "privilege_group.md", + "order": 1, + "children": [] + }, + { + "label": "Grant Privileges", + "id": "grant_privileges.md", + "order": 2, + "children": [] + }, + { + "label": "Grant Roles", + "id": "grant_roles.md", + "order": 3, + "children": [] + } + ] }, { "label": "Encryption in Transit",