Release new docs to master

milvus-io · Dec 23, 2024 · 315371d · 315371d
1 parent ea0a46e
commit 315371d
Show file tree

Hide file tree

Showing 10 changed files with 2,332 additions and 351 deletions.
diff --git a/v2.5.x/assets/privilege_group_illustrated.png b/v2.5.x/assets/privilege_group_illustrated.png
diff --git a/v2.5.x/assets/users_roles_privileges.png b/v2.5.x/assets/users_roles_privileges.png
diff --git a/v2.5.x/site/en/adminGuide/drop_users_roles.md b/v2.5.x/site/en/adminGuide/drop_users_roles.md
@@ -0,0 +1,232 @@
+---
+id: drop_users_roles.md
+related_key: enable RBAC
+summary: To ensure data security, it is recommend that you drop users and roles that are no longer in use. This guide introduces how to drop users and roles.
+title: Drop Users & Roles
+---
+
+# Drop Users & Roles
+
+To ensure data security, it is recommend that you drop users and roles that are no longer in use. This guide introduces how to drop users and roles.
+
+## Drop a user
+
+The following example demonstrates how to drop the user `user_1`. 
+
+<div class="alert note">
+
+The `root` user cannot be dropped.
+
+</div>
+
+<div class="multipleCode">
+  <a href="#python">Python </a>
+  <a href="#java">Java</a>
+  <a href="#javascript">Node.js</a>
+  <a href="#shell">cURL</a>
+</div>
+
+```python
+from pymilvus import MilvusClient
+
+client = MilvusClient(
+    uri="http://localhost:19530",
+    token="root:Milvus"
+)
+
+# create a user
+client.drop_user(user_name="user_1")
+
+```
+
+```java
+import io.milvus.v2.client.ConnectConfig
+import io.milvus.v2.client.MilvusClientV2
+import io.milvus.v2.service.rbac.request.DropUserReq
+
+ConnectConfig connectConfig = ConnectConfig.builder()
+        .uri("http://localhost:19530")
+        .token("root:Milvus")
+        .build();
+        
+MilvusClientV2 client = new MilvusClientV2(connectConfig);
+
+DropUserReq dropUserReq = DropUserReq.builder()
+        .userName("user_1")
+        .build();
+client.dropUser(dropUserReq);
+
+```
+
+```javascript
+const { MilvusClient, DataType } = require("@zilliz/milvus2-sdk-node")
+
+const address = "http://localhost:19530";
+const token = "root:Milvus";
+const client = new MilvusClient({address, token});
+
+milvusClient.deleteUser({
+    username: 'user_1'
+})
+
+```
+
+```shell
+export CLUSTER_ENDPOINT="http://localhost:19530"
+export TOKEN="root:Milvus"
+
+curl --request POST \
+--url "${CLUSTER_ENDPOINT}/v2/vectordb/users/drop" \
+--header "Authorization: Bearer ${TOKEN}" \
+--header "Content-Type: application/json" \
+-d '{
+    "userName": "user_1"
+}'
+
+```
+
+Once the user is dropped, you can list all existing users to check if the drop operation is successful. 
+
+<div class="multipleCode">
+  <a href="#python">Python </a>
+  <a href="#java">Java</a>
+  <a href="#javascript">Node.js</a>
+  <a href="#shell">cURL</a>
+</div>
+
+```python
+from pymilvus import MilvusClient
+
+client.list_users()
+
+```
+
+```java
+import io.milvus.v2.service.rbac.request.listUsersReq
+
+List<String> resp = client.listUsers();
+
+```
+
+```javascript
+const { MilvusClient, DataType } = require("@zilliz/milvus2-sdk-node")
+
+milvusClient.listUsers()
+
+```
+
+```shell
+curl --request POST \
+--url "${CLUSTER_ENDPOINT}/v2/vectordb/users/list" \
+--header "Authorization: Bearer ${TOKEN}" \
+--header "Content-Type: application/json" \
+-d '{}'
+
+```
+
+Below is an example output. There is no `user_1` in the list. The drop operation is successful.
+
+```
+['root']
+
+```
+
+## Drop a role
+
+The following example demonstrates how to drop the role `role_a`.
+
+<div class="alert note">
+
+The built-in role `admin` cannot be dropped.
+
+</div>
+
+<div class="multipleCode">
+  <a href="#python">Python </a>
+  <a href="#java">Java</a>
+  <a href="#javascript">Node.js</a>
+  <a href="#shell">cURL</a>
+</div>
+
+```python
+from pymilvus import MilvusClient
+
+client.drop_role(role_name="role_a")
+
+```
+
+```java
+import io.milvus.v2.service.rbac.request.DropRoleReq
+
+DropRoleReq dropRoleReq = DropRoleReq.builder()
+        .roleName("role_a")
+        .build();
+client.dropRole(dropRoleReq);
+
+```
+
+```javascript
+const { MilvusClient, DataType } = require("@zilliz/milvus2-sdk-node")
+
+milvusClient.dropRole({
+   roleName: 'role_a',
+ })
+
+```
+
+```shell
+curl --request POST \
+--url "${CLUSTER_ENDPOINT}/v2/vectordb/roles/drop" \
+--header "Authorization: Bearer ${TOKEN}" \
+--header "Content-Type: application/json" \
+-d '{
+    "roleName": "role_a"
+}'
+
+```
+
+Once the role is dropped, you can list all existing roles to check if the drop operation is successful. 
+
+<div class="multipleCode">
+  <a href="#python">Python </a>
+  <a href="#java">Java</a>
+  <a href="#javascript">Node.js</a>
+  <a href="#shell">cURL</a>
+</div>
+
+```python
+from pymilvus import MilvusClient
+
+client.list_roles()
+
+```
+
+```java
+List<String> resp = client.listRoles();
+
+```
+
+```javascript
+const { MilvusClient, DataType } = require("@zilliz/milvus2-sdk-node")
+
+milvusClient.listRoles(
+    includeUserInfo: True
+)
+
+```
+
+```shell
+curl --request POST \
+--url "${CLUSTER_ENDPOINT}/v2/vectordb/roles/list" \
+--header "Authorization: Bearer ${TOKEN}" \
+--header "Content-Type: application/json" \
+-d '{}'
+
+```
+
+Below is an example output. There is no `role_a` in the list. The drop operation is successful.
+
+```
+['admin']
+
+```