Skip to content

Commit 612491c

Browse files
RS: Access control doc improvements (#349)
* DOC-3840 RS: Rename manage users and manage passwords * DOC-3687 DOC-3689 Reorganize RS access control docs * DOC-3685 Revise admin console security to recommended security practices * DOC-3688 A few create roles updates * DOC-3688 Update create roles for cluster access only * DOC-3688 New cluster-only role screenshot and db-only role instructions * DOC-3688 Update create db-only roles * DOC-3688 Update create combined access role instructions and screenshots * DOC-3688 Separate Redis ACL overview from create db-only roles * DOC-3686 Update access control index page * DOC-3683 Update security index page * Feedback update to visually separate autogenerated links from default user section * Apply suggestions from code review Co-authored-by: mich-elle-luna <153109578+mich-elle-luna@users.noreply.github.com> * Replace RBAC diagram * Feedback update to mention that passwords are stored using SHA-256 encryption * Typo fix * Feedback updates for security index table * Feedback updates for RBAC docs --------- Co-authored-by: mich-elle-luna <153109578+mich-elle-luna@users.noreply.github.com>
1 parent dd17f92 commit 612491c

36 files changed

+422
-398
lines changed

content/operate/kubernetes/security/ldap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ weight: 95
1212

1313
## LDAP support for Redis Enterprise Software
1414

15-
Redis Enterprise Software supports LDAP authentication and authorization through [role-based access controls]({{< relref "/operate/rs/security/access-control/" >}}) (RBAC). You can map LDAP groups to [Redis Enterprise roles]({{< relref "/operate/rs/security/access-control/rbac/create-roles" >}}) to control access to your database and the [admin console]({{< relref "/operate/rs/security/admin-console-security/" >}}). For more details on how LDAP works with Redis Enterprise, see [LDAP authentication]({{< relref "/operate/rs/security/access-control/ldap/" >}}).
15+
Redis Enterprise Software supports LDAP authentication and authorization through [role-based access controls]({{< relref "/operate/rs/security/access-control/" >}}) (RBAC). You can map LDAP groups to [Redis Enterprise roles]({{< relref "/operate/rs/security/access-control/create-roles" >}}) to control access to your database and the [admin console]({{< relref "/operate/rs/security/recommended-security-practices/" >}}). For more details on how LDAP works with Redis Enterprise, see [LDAP authentication]({{< relref "/operate/rs/security/access-control/ldap/" >}}).
1616

1717
Redis Enterprise for Kubernetes supports enabling and configuring LDAP authentication using the `RedisEnterpriseCluster` (REC) custom resource. Currently, the Redis Enterprise cluster (REC) only supports configuration related to the LDAP server, such as server addresses, connection details, credentials, and query configuration.
1818

content/operate/kubernetes/security/manage-rec-credentials.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ The credentials can be used to access the Redis Enterprise admin console or the
110110

111111
1. [Connect to the admin console]({{< relref "/operate/kubernetes/re-clusters/connect-to-admin-console.md" >}})
112112

113-
1. [Add another admin user]({{< relref "/operate/rs/security/access-control/manage-users/add-users" >}}) and choose a new password.
113+
1. [Add another admin user]({{< relref "/operate/rs/security/access-control/create-users" >}}) and choose a new password.
114114

115115
1. Specify the new username in the `username` field of your REC custom resource spec.
116116

content/operate/rs/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Create and manage a [Redis database]({{< relref "/operate/rs/databases" >}}) on
4242
## Security
4343
[Manage secure connections]({{< relref "/operate/rs/security" >}}) to the cluster and databases.
4444
- [Access control]({{< relref "/operate/rs/security/access-control" >}})
45-
- [Users]({{< relref "/operate/rs/security/access-control/manage-users" >}}) & [roles]({{< relref "/operate/rs/security/access-control/rbac/create-roles" >}})
45+
- [Users]({{< relref "/operate/rs/security/access-control/manage-users" >}}) & [roles]({{< relref "/operate/rs/security/access-control/create-roles" >}})
4646
- [Certificates]({{< relref "/operate/rs/security/certificates" >}})
4747
- [TLS]({{< relref "/operate/rs/security/encryption/tls" >}}) & [Encryption]({{< relref "/operate/rs/security/encryption" >}})
4848

content/operate/rs/databases/active-active/create.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -197,17 +197,17 @@ You cannot enable or turn off database clustering after the Active-Active databa
197197
198198
Creating a database without ACLs enables a *default* user with full access to the database. You can secure default user access by requiring a password.
199199
200-
- **Access Control List** - You can specify the [user roles]({{< relref "/operate/rs/security/access-control/rbac/create-roles" >}}) that have access to the database and the [Redis ACLs]({{< relref "/operate/rs/security/access-control/rbac/configure-acl" >}}) that apply to those connections.
200+
- **Access Control List** - You can specify the [user roles]({{< relref "/operate/rs/security/access-control/create-roles" >}}) that have access to the database and the [Redis ACLs]({{< relref "/operate/rs/security/access-control/create-db-roles" >}}) that apply to those connections.
201201
202202
You can only configure access control after the Active-Active database is created. In each participating cluster, add ACLs after database creation.
203203
204204
To define an access control list for a database:
205205
206206
1. In **Security > Access Control > Access Control List**, select **+ Add ACL**.
207207
208-
1. Select a [role]({{< relref "/operate/rs/security/access-control/rbac/create-roles" >}}) to grant database access.
208+
1. Select a [role]({{< relref "/operate/rs/security/access-control/create-roles" >}}) to grant database access.
209209
210-
1. Associate a [Redis ACL]({{< relref "/operate/rs/security/access-control/rbac/configure-acl" >}}) with the role and database.
210+
1. Associate a [Redis ACL]({{< relref "/operate/rs/security/access-control/create-db-roles" >}}) with the role and database.
211211
212212
1. Select the check mark to add the ACL.
213213

content/operate/rs/databases/configure/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,15 +155,15 @@ You can require [**TLS**]({{< relref "/operate/rs/security/encryption/tls/" >}})
155155

156156
Creating a database without ACLs enables a *default* user with full access to the database. You can secure default user access by requiring a password.
157157

158-
- **Access Control List** - You can specify the [user roles]({{< relref "/operate/rs/security/access-control/rbac/create-roles" >}}) that have access to the database and the [Redis ACLs]({{< relref "/operate/rs/security/access-control/rbac/configure-acl" >}}) that apply to those connections.
158+
- **Access Control List** - You can specify the [user roles]({{< relref "/operate/rs/security/access-control/create-roles" >}}) that have access to the database and the [Redis ACLs]({{< relref "/operate/rs/security/access-control/create-db-roles" >}}) that apply to those connections.
159159

160160
To define an access control list for a database:
161161

162162
1. In **Security > Access Control > Access Control List**, select **+ Add ACL**.
163163

164-
1. Select a [role]({{< relref "/operate/rs/security/access-control/rbac/create-roles" >}}) to grant database access.
164+
1. Select a [role]({{< relref "/operate/rs/security/access-control/create-roles" >}}) to grant database access.
165165

166-
1. Associate a [Redis ACL]({{< relref "/operate/rs/security/access-control/rbac/configure-acl" >}}) with the role and database.
166+
1. Associate a [Redis ACL]({{< relref "/operate/rs/security/access-control/create-db-roles" >}}) with the role and database.
167167

168168
1. Select the check mark to add the ACL.
169169

content/operate/rs/installing-upgrading/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ More information is available to help with customization and related questions:
6363

6464
After you install Redis Enterprise Software and set up your cluster, you can:
6565

66-
- [Add users]({{< relref "/operate/rs/security/access-control/manage-users/add-users" >}}) to the cluster with specific permissions. To begin, start with [Access control]({{< relref "/operate/rs/security/access-control" >}}).
66+
- [Add users]({{< relref "/operate/rs/security/access-control/create-users" >}}) to the cluster with specific permissions. To begin, start with [Access control]({{< relref "/operate/rs/security/access-control" >}}).
6767

6868
- [Create databases]({{< relref "/operate/rs/databases/create" >}}) to use with your applications.
6969

content/operate/rs/installing-upgrading/install/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,6 @@ To learn more about customization and find answers to related questions, see:
5555

5656
After your cluster is set up with nodes, you can:
5757

58-
- [Add users]({{< relref "/operate/rs/security/access-control/manage-users/add-users" >}}) to the cluster with specific permissions. To begin, start with [Access control]({{< relref "/operate/rs/security/access-control" >}}).
58+
- [Add users]({{< relref "/operate/rs/security/access-control/create-users" >}}) to the cluster with specific permissions. To begin, start with [Access control]({{< relref "/operate/rs/security/access-control" >}}).
5959
- [Create databases]({{< relref "/operate/rs/databases/create" >}}) to use with your applications.
6060

content/operate/rs/installing-upgrading/install/install-on-linux.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,4 +134,4 @@ As a workaround to install Redis Enterprise Software without using any root dire
134134
135135
For geo-distributed Active-Active replication, create an [Active-Active]({{< relref "/operate/rs/databases/active-active/create.md" >}}) database.
136136
137-
1. [Add users]({{< relref "/operate/rs/security/access-control/manage-users/add-users" >}}) to the cluster with specific permissions. To begin, start with [Access control]({{< relref "/operate/rs/security/access-control" >}}).
137+
1. [Add users]({{< relref "/operate/rs/security/access-control/create-users" >}}) to the cluster with specific permissions. To begin, start with [Access control]({{< relref "/operate/rs/security/access-control" >}}).

content/operate/rs/references/rest-api/objects/redis_acl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ linkTitle: redis_acl
1010
weight: $weight
1111
---
1212

13-
An API object that represents a Redis [access control list (ACL)]({{< relref "/operate/rs/security/access-control/rbac/configure-acl" >}})
13+
An API object that represents a Redis [access control list (ACL)]({{< relref "/operate/rs/security/access-control/create-db-roles" >}})
1414

1515
| Name | Type/Value | Description |
1616
|------|------------|-------------|

content/operate/rs/references/rest-api/permissions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ weight: 60
1313

1414
Some Redis Enterprise [REST API requests]({{< relref "/operate/rs/references/rest-api/requests" >}}) may require the user to have specific permissions.
1515

16-
Administrators can assign a predefined role to a user with the [Cluster Manager UI]({{< relref "/operate/rs/security/access-control/manage-users/add-users" >}}) or a [<nobr>`PUT /users/{uid}`</nobr> API request]({{< relref "/operate/rs/references/rest-api/requests/users#put-user" >}}) to grant necessary permissions to them.
16+
Administrators can assign a predefined role to a user with the [Cluster Manager UI]({{< relref "/operate/rs/security/access-control/create-users" >}}) or a [<nobr>`PUT /users/{uid}`</nobr> API request]({{< relref "/operate/rs/references/rest-api/requests/users#put-user" >}}) to grant necessary permissions to them.
1717

1818
## Roles
1919

0 commit comments

Comments
 (0)