Skip to content

Commit 5f1c0b8

Browse files
rrelledgerrelledge
committed
DOC-5737 Updated create roles instructions and screenshots for 7.22 CM UI
1 parent 6cd8ef0 commit 5f1c0b8

File tree

8 files changed

+137
-154
lines changed

8 files changed

+137
-154
lines changed

‎content/operate/rs/security/access-control/create-cluster-roles.md‎

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -51,33 +51,33 @@ Here's a summary of the Cluster Manager UI actions permitted by each default man
5151

5252
You can use the [Cluster Manager UI](#create-roles-ui) or the [REST API](#define-roles-rest-api) to create a role that grants cluster access but does not grant access to any databases.
5353

54-
### Cluster Manager UI method {#create-roles-ui}
54+
{{< multitabs id="create-cluster-role"
55+
tab1="Cluster Manager UI"
56+
tab2="REST API" >}}
5557

56-
To create a role that grants cluster access:
58+
To create a role that grants cluster access using the Cluster Manager UI:
5759

5860
1. From **Access Control** > **Roles**, you can:
5961

60-
- Point to a role and select {{< image filename="/images/rs/buttons/edit-button.png#no-click" alt="The Edit button" width="25px" class="inline" >}} to edit an existing role.
62+
- Select a role from the list of existing roles to edit it.
6163

62-
- Select **+ Add role** to create a new role.
64+
- Click **+ Add role** to create a new role.
6365

64-
{{<image filename="images/rs/access-control-role-panel.png" alt="Add role with name" >}}
66+
<img src="../../../../../images/rs/screenshots/access-control/7-22-updates/roles-screen.png" alt="Add role with name">
6567

6668
1. Enter a descriptive name for the role.
6769

68-
1. Choose a **Cluster management role** to determine cluster management permissions.
70+
1. Choose a **Management role** to determine cluster management permissions.
6971

70-
{{<image filename="images/rs/screenshots/access-control/rbac-create-role-cluster-only.png" alt="Select a cluster management role to set the level of cluster management permissions for the new role." >}}
72+
<img src="../../../../../images/rs/screenshots/access-control/7-22-updates/rbac-create-role-cluster-only.png" alt="Select a cluster management role to set the level of cluster management permissions for the new role.">
7173

7274
1. To prevent database access when using this role, do not add any ACLs.
7375

74-
1. Select **Save**.
76+
1. Click **Save**.
7577

76-
You can [assign the new role to users]({{<relref "/operate/rs/security/access-control/create-users#assign-roles-to-users">}}) to grant cluster access.
77-
78-
### REST API method {#define-roles-rest-api}
78+
-tab-sep-
7979

80-
To [create a role]({{<relref "/operate/rs/references/rest-api/requests/roles#post-role">}}) that grants cluster access:
80+
To [create a role]({{<relref "/operate/rs/references/rest-api/requests/roles#post-role">}}) that grants cluster access using the REST API:
8181

8282
```sh
8383
POST /v1/roles
@@ -86,3 +86,6 @@ POST /v1/roles
8686
"management": "db_viewer | db_member | cluster_viewer | cluster_member | user_manager | admin"
8787
}
8888
```
89+
{{< /multitabs >}}
90+
91+
You can [assign the new role to users]({{<relref "/operate/rs/security/access-control/create-users#assign-roles-to-users">}}) to grant cluster access.

‎content/operate/rs/security/access-control/create-combined-roles.md‎

Lines changed: 61 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -14,37 +14,31 @@ To create a role that grants database access privileges and allows access to the
1414

1515
1. [Define Redis ACLs](#define-redis-acls) that determine database access privileges.
1616

17-
1. [Create a role with ACLs](#create-role) added and choose a **Cluster management role** other than **None**.
17+
1. [Create a role with ACLs](#create-role) added and choose a **Management role** other than **None**.
1818

1919
## Define Redis ACLs
2020

2121
You can use the [Cluster Manager UI](#define-acls-ui) or the [REST API](#define-acls-rest-api) to define Redis ACL rules that you can assign to roles.
2222

23-
### Cluster Manager UI method {#define-acls-ui}
23+
{{< multitabs id="define-redis-acls"
24+
tab1="Cluster Manager UI"
25+
tab2="REST API" >}}
2426

2527
To define a Redis ACL rule using the Cluster Manager UI:
2628

27-
1. From **Access Control > Redis ACLs**, you can either:
29+
1. From **Access Control > Roles > Data ACLs**, you can either:
2830

29-
- Point to a Redis ACL and select {{< image filename="/images/rs/buttons/edit-button.png#no-click" alt="The Edit button" width="25px" class="inline" >}} to edit an existing Redis ACL.
31+
- Select an existing Redis ACL from the list to edit it.
3032

31-
- Select **+ Add Redis ACL** to create a new Redis ACL.
33+
- Click **+ Add Redis ACL** to create a new Redis ACL.
3234

3335
1. Enter a descriptive name for the Redis ACL. This will be used to associate the ACL rule with the role.
3436

3537
1. Define the ACL rule. For more information about Redis ACL rules and syntax, see the [Redis ACL overview]({{<relref "/operate/rs/security/access-control/redis-acl-overview">}}).
3638

37-
{{<note>}}
38-
The **ACL builder** does not support selectors and key permissions. Use **Free text command** to manually define them instead.
39-
{{</note>}}
39+
1. Click **Save**.
4040

41-
1. Select **Save**.
42-
43-
{{<note>}}
44-
For multi-key commands on multi-slot keys, the return value is `failure`, but the command runs on the keys that are allowed.
45-
{{</note>}}
46-
47-
### REST API method {#define-acls-rest-api}
41+
-tab-sep-
4842

4943
To define a Redis ACL rule using the REST API, use a [create Redis ACL]({{<relref "/operate/rs/references/rest-api/requests/redis_acls#post-redis_acl">}}) request. For more information about Redis ACL rules and syntax, see the [Redis ACL overview]({{<relref "/operate/rs/security/access-control/redis-acl-overview">}}).
5044

@@ -68,92 +62,89 @@ Example response body:
6862
}
6963
```
7064

71-
To associate the Redis ACL with a role and database, use the `uid` from the response as the `redis_acl_uid` when you add `roles_permissions` to the database. See [Associate a database with roles and Redis ACLs](#associate-roles-acls-rest-api) for an example request.
65+
To associate the Redis ACL with a role and database, use the `uid` from the response as the `redis_acl_uid` when you add `roles_permissions` to the database.
66+
67+
{{< /multitabs >}}
68+
69+
{{<note>}}
70+
For multi-key commands on multi-slot keys, the return value is `failure`, but the command runs on the keys that are allowed.
71+
{{</note>}}
7272

7373
## Create roles with ACLs and cluster access {#create-role}
7474

7575
You can create a role that grants database access privileges and allows access to the Cluster Management UI and REST API.
7676

77-
### Cluster Manager UI method {#create-roles-ui}
77+
{{< multitabs id="create-combined-roles"
78+
tab1="Cluster Manager UI"
79+
tab2="REST API" >}}
7880

7981
To define a role for combined access using the Cluster Manager UI:
8082

8183
1. From **Access Control** > **Roles**, you can:
8284

83-
- Point to a role and select {{< image filename="/images/rs/buttons/edit-button.png#no-click" alt="The Edit button" width="25px" class="inline" >}} to edit an existing role.
85+
- Select a role from the list of existing roles to edit it.
8486

85-
- Select **+ Add role** to create a new role.
87+
- Click **+ Add role** to create a new role.
8688

87-
{{<image filename="images/rs/access-control-role-panel.png" alt="Add role with name">}}
89+
<img src="../../../../../images/rs/screenshots/access-control/7-22-updates/roles-screen.png" alt="Add role with name">
8890

8991
1. Enter a descriptive name for the role. This will be used to reference the role when configuring users.
9092

91-
1. Choose a **Cluster management role** other than **None**. For details about permissions granted by each role, see [Cluster Manager UI permissions]({{<relref "/operate/rs/security/access-control/create-cluster-roles#cluster-manager-ui-permissions">}}) and [REST API permissions]({{<relref "/operate/rs/references/rest-api/permissions">}}).
93+
1. Choose a **Management role** other than **None**. For details about permissions granted by each role, see [Cluster Manager UI permissions]({{<relref "/operate/rs/security/access-control/create-cluster-roles#cluster-manager-ui-permissions">}}) and [REST API permissions]({{<relref "/operate/rs/references/rest-api/permissions">}}).
9294

93-
{{<image filename="images/rs/screenshots/access-control/rbac-create-combined-role-select-cm-role.png" alt="Add role with name">}}
95+
<img src="../../../../../images/rs/screenshots/access-control/7-22-updates/create-role-combined-access-select-management-role.png" alt="Add role with name">
9496

95-
1. Select **+ Add ACL**.
96-
97-
{{<image filename="images/rs/access-control-role-acl.png" alt="Add role database acl">}}
97+
1. Click **+ Add ACL**.
9898

9999
1. Choose a Redis ACL and databases to associate with the role.
100100

101-
{{<image filename="images/rs/screenshots/access-control/access-control-role-databases.png" alt="Add databases to access">}}
102-
103-
1. Select the check mark {{< image filename="/images/rs/buttons/checkmark-button.png#no-click" alt="The Check button" width="25px" class="inline" >}} to confirm.
101+
<img src="../../../../../images/rs/screenshots/access-control/7-22-updates/create-role-combined-access-select-db.png" alt="Add databases to access">
104102

105-
1. Select **Save**.
103+
1. Click the check mark to confirm.
106104

107-
{{<image filename="images/rs/screenshots/access-control/rbac-save-combined-role.png" alt="Add databases to access">}}
108-
109-
You can [assign the new role to users]({{<relref "/operate/rs/security/access-control/create-users#assign-roles-to-users">}}) to grant database access and access to the Cluster Manager UI and REST API.
105+
1. Click **Save**.
110106

111-
### REST API method {#define-roles-rest-api}
107+
-tab-sep-
112108

113109
To define a role for combined access using the REST API:
114110

115-
1. [Create a role.](#create-role-rest-api)
116-
117-
1. [Associate a database with roles and Redis ACLs.](#associate-roles-acls-rest-api)
118-
119-
#### Create a role {#create-role-rest-api}
120-
121-
To [create a role]({{<relref "/operate/rs/references/rest-api/requests/roles#post-role">}}) using the REST API:
122-
123-
```sh
124-
POST /v1/roles
125-
{
126-
"name": "<role-name>",
127-
"management": "db_viewer | db_member | cluster_viewer | cluster_member | admin"
128-
}
129-
```
111+
1. Use a [create role]({{<relref "/operate/rs/references/rest-api/requests/roles#post-role">}}) request:
130112

131-
Example response body:
132-
133-
```json
134-
{
135-
"management": "admin",
136-
"name": "<role-name>",
137-
"uid": 7
138-
}
139-
```
113+
```sh
114+
POST /v1/roles
115+
{
116+
"name": "<role-name>",
117+
"management": "db_viewer | db_member | cluster_viewer | cluster_member | admin"
118+
}
119+
```
140120

141-
To associate the role with a Redis ACL and database, use the `uid` from the response as the `role_uid` when you add `roles_permissions` to the database. See [Associate a database with roles and Redis ACLs](#associate-roles-acls-rest-api) for an example request.
121+
Example response body:
142122

123+
```json
124+
{
125+
"management": "admin",
126+
"name": "<role-name>",
127+
"uid": 7
128+
}
129+
```
143130

144-
#### Associate a database with roles and Redis ACLs {#associate-roles-acls-rest-api}
131+
To associate the role with a Redis ACL and database, use the `uid` from the response as the `role_uid` when you add `roles_permissions` to the database.
145132

146-
[Update a database's configuration]({{<relref "/operate/rs/references/rest-api/requests/bdbs#put-bdbs">}}) to add `roles_permissions` with the role and Redis ACL:
133+
2. [Update a database's configuration]({{<relref "/operate/rs/references/rest-api/requests/bdbs#put-bdbs">}}) to add `roles_permissions` with the role and Redis ACL:
147134
148-
```sh
149-
POST /v1/bdbs/<database-id>
150-
{
151-
"roles_permissions":
152-
[
135+
```sh
136+
POST /v1/bdbs/<database-id>
153137
{
154-
"role_uid": <integer>,
155-
"redis_acl_uid": <integer>
138+
"roles_permissions":
139+
[
140+
{
141+
"role_uid": <integer>,
142+
"redis_acl_uid": <integer>
143+
}
144+
]
156145
}
157-
]
158-
}
159-
```
146+
```
147+
148+
{{< /multitabs >}}
149+
150+
You can [assign the new role to users]({{<relref "/operate/rs/security/access-control/create-users#assign-roles-to-users">}}) to grant database access and access to the Cluster Manager UI and REST API.

0 commit comments

Comments
 (0)