Skip to content

Commit dd8c2ca

Browse files
bankerIAmATeaPot418bmansheim
authored
Redis Enterprise Software Security (#918)
* Initial security page * Create _index.md * Create _index.md * Create _index.md * Update _index.md * Update _index.md * Delete _index.md * Delete _index.md * Create control-plane-security * Delete control-plane-security * Create _index.md * Create _index.md * Create _index.md * Create _index.md * WIP Mostly RBAC * finalization of first draft. * minor: edits * Fix broken links * Reorganize * Fix build * Update ldap.md * Simplify org and improve checklist style * Improve Log docs * Improve database and control plane articles * Formatting and typos * Lower case admin console * Replace web UI with admin console * Limit description text in database maintenance overview * Add Database Security to database maintenance * Add installation prerequisite for security * Fix broken links * minor: rename * minor: fix broken links * minor: aliases * minor: reorganize * Refactoring Co-authored-by: Jamie Scott <jamie.scott@uconn.edu> Co-authored-by: Ben Mansheim <github@mansheim.com>
1 parent 4e57312 commit dd8c2ca

File tree

79 files changed

+1146
-885
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+1146
-885
lines changed

Diff for: content/contribution-guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ and the concepts must explain any background information that is needed to know
114114

115115
1. To create service accounts, on each participating cluster:
116116

117-
1. In your web browser, open the web UI of the cluster that you want to connect to in order to create the CRDB.
117+
1. In your web browser, open the admin console of the cluster that you want to connect to in order to create the CRDB.
118118
By default, the address is: `https://<RS_address>:8443`
119119
1. Go to **settings > team** and click ![Add](/images/rs/icon_add.png#no-click "Add").
120120
1. Enter the name, email, and password for the user, select the **Admin** role,

Diff for: content/embeds/backup-locations.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,6 @@ You can find the client and key details in your service account in the GCP conso
110110
- Make sure that the service account has the `Storage Legacy Bucket Writer` permission on the target bucket.
111111
- Make sure that the bucket doesn't use a retention policy because it can interfere with the process.
112112
- The format of the private key from the downloaded JSON is in a single string where new lines are marked with `\n` characters.
113-
When you paste the key into the RS web UI, replace each `\n` character with a new line.
113+
When you paste the key into the RS admin console, replace each `\n` character with a new line.
114114
115115
{{< /note >}}

Diff for: content/embeds/create-db.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
1. In your web browser, open the web UI of the cluster that you want to connect to in order to create the { { < field "db_type" > } }.
1+
1. In your web browser, open the admin console of the cluster that you want to connect to in order to create the { { < field "db_type" > } }.
22

33
<!-- When shortcodes can run in embeds, fix field shrotcode above. -->
44

Diff for: content/modules/add-module-to-cluster.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ You can also use the `/v1/modules` endpoint, but modules with dependencies are b
7777

7878
To add a module package to the cluster using the admin console:
7979

80-
1. In the Redis Enterprise web UI, go to the: **settings**
80+
1. In the Redis Enterprise admin console, go to the: **settings**
8181
1. In **redis modules**, click **Add Module**.
8282

8383
![upgrade_module](/images/rs/upgrade_module.png)

Diff for: content/modules/packaging-modules.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ require six steps:
2626
1. Compile the module
2727
1. Install ramp-packer utility
2828
1. Wrap the custom module using ramp utility
29-
1. Deploy the custom module to the cluster using the web UI
29+
1. Deploy the custom module to the cluster using the admin console
3030
1. Create a database that utilizes the module
3131

3232
### Get the module from GitHub

Diff for: content/modules/redisearch/redisearch-2-upgrade.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ Make sure that you have Python 3 (`sudo apt install python3`) installed on the h
4141

4242
To replicate a RediSearch 1.x database to a RediSearch 2.x database:
4343

44-
1. Log in to the web UI of the RS cluster that you want to host the new database with RediSearch 2.x.
44+
1. Log in to the admin console of the RS cluster that you want to host the new database with RediSearch 2.x.
4545
1. Add the RediSearch 2.x module to the cluster:
4646
1. Go to the [Redis Labs Download Center](https://redislabs.com/download-center/modules/) and download the RediSearch 2.x module package.
47-
1. In the Redis Enterprise web UI, go to the: **settings**
47+
1. In the Redis Enterprise admin console, go to the: **settings**
4848
1. In **redis modules**, click **Add Module**.
4949

5050
![upgrade_module](/images/rs/upgrade_module.png)
@@ -69,8 +69,8 @@ To replicate a RediSearch 1.x database to a RediSearch 2.x database:
6969

7070
Where:
7171

72-
- `destination url` - The replication URL of the RediSearch 2.x database that you see when you click on **Get Replica of source URL** in the database configuration in the web UI.
73-
- `source url` - The replication URL of the RediSearch 1.x database that you see when you click on **Get Replica of source URL** in the database configuration in the web UI.
72+
- `destination url` - The replication URL of the RediSearch 2.x database that you see when you click on **Get Replica of source URL** in the database configuration in the admin console.
73+
- `source url` - The replication URL of the RediSearch 1.x database that you see when you click on **Get Replica of source URL** in the database configuration in the admin console.
7474
- `--add-prefix <prefix>` (optional) - Adds a prefix to all of the hashes that are replicated to the new database.
7575

7676
{{< note >}}

Diff for: content/platforms/faqs/_index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ kubectl describe rec my-cluster-name
3838
The cluster admin user password is created by the Operator during the deployment of the Redis Enterprise cluster and is stored in a Kubernetes secret.
3939

4040
{{< warning >}}
41-
Do not change the default admin user password in the Redis Enterprise web UI.
41+
Do not change the default admin user password in the Redis Enterprise admin console.
4242
Changing the admin password impacts the proper operation of the K8s deployment.
4343
{{< /warning >}}
4444

@@ -152,7 +152,7 @@ echo "Q2h5N1BBY28=" | base64 –-decode
152152
```
153153

154154
{{< warning >}}
155-
Do not change the default admin user password in the Redis Enterprise web UI.
155+
Do not change the default admin user password in the Redis Enterprise admin console.
156156
Changing the admin password impacts the proper operation of the K8s deployment.
157157
{{< /warning >}}
158158

@@ -165,7 +165,7 @@ Retrieve your password by selecting “Reveal Secret.”
165165
![openshift-password-retrieval]( /images/rs/openshift-password-retrieval.png )
166166

167167
{{< warning >}}
168-
Do not change the default admin user password in the Redis Enterprise web UI.
168+
Do not change the default admin user password in the Redis Enterprise admin console.
169169
Changing the admin password impacts the proper operation of the K8s deployment.
170170
{{< /warning >}}
171171

Diff for: content/platforms/kubernetes/concepts/db-controller.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ also updated with the generated database password.
221221

222222
### `enforceClientAuthentication`
223223

224-
A boolean that indicates whether [client authentication]({{< relref "/rs/administering/designing-production/security/client-connections.md">}}) should be enforced (default: `true`).
224+
A boolean that indicates whether [client authentication]({{< relref "/rs/security/tls-ssl.md">}}) should be enforced (default: `true`).
225225

226226
### `evictionPolicy`
227227

@@ -275,7 +275,7 @@ The number of [database shards]({{< relref "/rs/concepts/high-availability/clust
275275

276276
### `tlsMode`
277277

278-
Controls SSL [authentication and encryption]({{< relref "/rs/administering/designing-production/security/tls-configuration.md">}}) for connections to the database.
278+
Controls SSL [authentication and encryption]({{< relref "/rs/security/tls-ssl.md">}}) for connections to the database.
279279

280280
| Value | Description |
281281
| ----- | ----------- |

Diff for: content/platforms/kubernetes/getting-started/openshift/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,7 @@ In order to create your database, we will log in to the Redis Enterprise UI.
323323
- Retrieve your password by selecting “Reveal Secret.”
324324

325325
{{< warning >}}
326-
Do not change the default admin user password in the Redis Enterprise web UI.
326+
Do not change the default admin user password in the Redis Enterprise admin console.
327327
Changing the admin password impacts the proper operation of the K8s deployment.
328328
{{< /warning >}}
329329

Diff for: content/platforms/kubernetes/getting-started/openshift/openshift-cli.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -311,14 +311,14 @@ To create your database:
311311

312312
Next, create your database.
313313

314-
1. Open a browser window and navigate to the Redis Enterprise web UI at: `localhost:8443`
314+
1. Open a browser window and navigate to the Redis Enterprise admin console at: `localhost:8443`
315315

316316
![getting-started-kubernetes-openshift-image5]( /images/rs/getting-started-kubernetes-openshift-image5.png )
317317

318318
1. To get your password from the OpenShift management console, go `Resources > Secrets > your_cluster_name`, select your project name, and select **Reveal Secret**.
319319

320320
{{< warning >}}
321-
Do not change the default admin user password in the Redis Enterprise web UI.
321+
Do not change the default admin user password in the Redis Enterprise admin console.
322322
Changing the admin password can cause unextpected results in your K8s deployment.
323323
{{< /warning >}}
324324

Diff for: content/platforms/kubernetes/getting-started/openshift/openshift-operatorhub.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ the operator. The generated password is stored in a Kubernetes secret.
243243
- The Openshift UI provides tools for creating additional routing options, including external routes. These are covered in [RedHat Openshift documentation](https://docs.openshift.com/container-platform/4.3/dev_guide/routes.html).
244244
{{< /note >}}
245245

246-
1. In a browser, go to localhost:8443 to open the Redis Enterprise web UI:
246+
1. In a browser, go to localhost:8443 to open the Redis Enterprise admin console:
247247

248248
![getting-started-kubernetes-openshift-image5]( /images/rs/getting-started-kubernetes-openshift-image5.png )
249249

@@ -259,7 +259,7 @@ database.
259259

260260
### Step 3: Inspect your database services
261261

262-
After you create your database in the Redis Enterprise web UI, the operator
262+
After you create your database in the Redis Enterprise admin console, the operator
263263
detects the change and creates Kubernetes services that expose the database. The
264264
databases are named according to the database name. For example, if you
265265
called your database "`test`", kubectl shows these services:

Diff for: content/platforms/kubernetes/getting-started/tanzu/_index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -400,7 +400,7 @@ In order to create your database, you will log in to the Redis Enterprise UI.
400400
dgeil7
401401
```
402402

403-
1. There are two primary options for accessing the Web UI:
403+
1. There are two primary options for accessing the admin console:
404404
1. If your PKS cluster has a load balancer service setup with a public IP you have access to or otherwise a routable IP address from your machine:
405405
- Determine that IP address:
406406

@@ -433,7 +433,7 @@ In order to create your database, you will log in to the Redis Enterprise UI.
433433

434434
- Use `localhost` followed by port number 8443 in your browser address bar: `https://localhost:8443`
435435

436-
1. Log in to the Web UI with the username defined in your REC yaml and the password.
436+
1. Log in to the admin console with the username defined in your REC yaml and the password.
437437

438438
![getting-started-kubernetes-openshift-image5]( /images/rs/getting-started-kubernetes-openshift-image5.png )
439439

Diff for: content/platforms/kubernetes/reference/db-options.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ also updated with the generated database password.
4141
4242
### `enforceClientAuthentication`
4343

44-
A boolean that indicates whether [client authentication]({{< relref "/rs/administering/designing-production/security/client-connections.md">}}) should be enforced (default: `true`).
44+
A boolean that indicates whether [client authentication]({{< relref "/rs/security/tls-ssl.md">}}) should be enforced (default: `true`).
4545

4646
### `evictionPolicy`
4747

@@ -95,7 +95,7 @@ The number of [database shards]({{< relref "/rs/concepts/high-availability/clust
9595

9696
### `tlsMode`
9797

98-
Controls SSL [authentication and encryption]({{< relref "/rs/administering/designing-production/security/tls-configuration.md">}}) for connections to the database.
98+
Controls SSL [authentication and encryption]({{< relref "/rs/security/tls-ssl.md">}}) for connections to the database.
9999

100100
| Value | Description |
101101
| ----- | ----------- |

Diff for: content/platforms/pcf/using-pcf.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,15 @@ Available service plans are listed in either:
4949
5050
## Accessing the Redis Enterprise cluster UI
5151
52-
1. Connect to the Redis Enterprise Admin Console by placing the **Cluster Management Console Subdomain** in the host part of the following URL: `https://[Cluster Management Console Subdomain].[System Domain]`.
52+
1. Connect to the Redis Enterprise admin console by placing the **Cluster Management Console Subdomain** in the host part of the following URL: `https://[Cluster Management Console Subdomain].[System Domain]`.
5353
5454
For example: `https://console-redis.sys.my-domain.cf-app.com`
5555
5656
1. Log in using the Administrator email account and password you specified in the tile configuration above.
5757
5858
{{< note >}}
5959
Do not create or delete databases through the Redis Enterprise Cluster UI.
60-
Use the cf creates/delete/update-service commands or use the Pivotal Apps Manager web UI to create and manage databases through available plans.
60+
Use the cf creates/delete/update-service commands or use the Pivotal Apps Manager admin console to create and manage databases through available plans.
6161
{{< /note >}}
6262
6363
## Installing a license key in an existing cluster

Diff for: content/rc/administration/account-team-settings.md

+98
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,101 @@ You can also:
1313
- Change the account Time Zone
1414
- Add a new Relic license key
1515
- Configure Multi-Factor Authentication (MFA)
16+
17+
When you set up [SSL/TLS]({{< relref "/rc/security/database-security/tls-ssl.md" >}}) for your account,
18+
you must enter the downloadable Redis Labs CA Certificate from this page.
19+
20+
![settings](/images/rc/settings.png)
21+
22+
## Team management
23+
24+
To manage the team of people who have access to the account, click on
25+
the "Team" tab and you will be presented with the current list of team
26+
members on this account.
27+
28+
- To add more team members, click ![Add](/images/rs/icon_add.png#no-click "Add").
29+
- To edit an existing team member, click ![Edit](/images/rc/icon_edit.png#no-click "Edit").
30+
31+
Team members can have different roles to the account:
32+
33+
- **Owner** - Can view, create, and edit any settings in the account
34+
- **Member** - Can view, create, and edit databases
35+
- **Viewer** - Can view all databases and their configurations (including database secrets)
36+
37+
### Team management for GCP Marketplace customers
38+
39+
If you subscribed to Redis Cloud using GCP Marketplace, you can manage your team from the IAM section of the GCP console.
40+
To grant Redis Cloud access to a GCP user, assign one of these roles to the user:
41+
42+
- **Viewer** - serviceusage.serviceUsageViewer and redisenterprisecloud.viewer
43+
- **Owner** - serviceusage.serviceUsageViewer and redisenterprisecloud.admin
44+
45+
Users must log in using SSO to Redis Cloud at least once for them to be added to the team.
46+
47+
## Multi-Factor Authentication (MFA)
48+
49+
To reduce the chances of unauthorized access to the Redis Cloud admin console, each user can enable MFA to require an authentication code at login.
50+
The account owner can also enable MFA enforcement for all users in the account so that users cannot log in without MFA.
51+
52+
When MFA is enabled it forces users to enter their username, password, and an authentication code sent to them by text message or generated by an app on their smartphone. MFA authentication requires a phone that can receive text messages.
53+
54+
### Using MFA for a user account
55+
56+
Each user can enable and configure MFA for their user account.
57+
The default MFA configuration sends an authentication code by text message that you must enter when you log in.
58+
59+
To configure MFA for your user account:
60+
61+
1. Log into your account.
62+
2. In the menu, click on your name.
63+
3. In your user profile, click **Multi-Factor Authentication**.
64+
4. Click **Activate Now**
65+
5. Enter your mobile phone number and enter the confirmation code sent to you by text message.
66+
67+
Your account is now configured for MFA.
68+
When you log in to the Redis Cloud admin console, you are sent an authentication code by text message that you must enter.
69+
70+
To change the mobile phone number, click **Configure** for the text message code and enter the new mobile phone number.
71+
72+
{{< note >}}
73+
We recommend that you also configure MFA for an Authenticator app as a second method of MFA.
74+
If you cannot login to your account because of MFA, contact [Support](https://support.redislabs.com).
75+
76+
If your mobile phone is lost or stolen, make sure that you update the MFA configuration to prevent unauthorized logins.
77+
{{< /note >}}
78+
79+
#### Configuring MFA for an authenticator app
80+
81+
After you configure MFA for text messages, you can also configure MFA to work with a Time-based One-Time Password (TOTP) app such as Google Authenticator.
82+
Then when you log in to the Redis Cloud admin console, you can select to use either an authentication code sent by text message or an authentication code shown in the Authenticator app for MFA.
83+
84+
To configure MFA for the Authenticator app:
85+
86+
1. Install the Google Authenticator app on your phone from the Apple Store or Google Play.
87+
1. Add Redis Cloud to the app:
88+
1. In your profile in your Redis Cloud account, click **Multi-Factor Authentication**.
89+
1. Click **Configure** for the authenticator app.
90+
1. On your phone, open the Authenticator app.
91+
1. Press the plus sign and press **Scan a barcode**.
92+
1. Scan the Redis Cloud barcode.
93+
94+
When you log in to the Redis Cloud admin console, you can do MFA either with a text message or the Authenticator app.
95+
If you do MFA with the Authenticator app, you must open the Authenticator app and enter the Redis Labs code into the Redis Cloud login.
96+
97+
#### Deactivating MFA
98+
99+
You can deactivate MFA for your user account. To deactivate MFA, go to your profile, click **Multi-Factor Authentication**, and click **Deactivate**.
100+
101+
### Enforcing MFA for all user accounts
102+
103+
Account owner users can enable MFA enforcement for all users in their account.
104+
After MFA is enforced for the account, all users that do not have MFA enabled are required to configure MFA the next time they log in to the Redis Cloud admin console.
105+
106+
- When you enable MFA enforcement, users cannot disable MFA for their account.
107+
- When you disable MFA enforcement, users can disable MFA for their account.
108+
109+
{{< tip >}}
110+
We recommend that you send an email to all the Redis Cloud admin console users to notify them of this change before you enable MFA enforcement.
111+
{{< /tip >}}
112+
113+
To enable MFA enforcement for all user accounts, the account owner must enable **MFA enforcement** in **Settings** > **Account**.

Diff for: content/rc/administration/setup/create-database.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ You must configure [VPC Peering]({{< relref "/rc/administration/setup/edit-subsc
4242
between the VPC that this database is on and the VPC that the destination database is on.
4343
{{< /note >}}
4444

45-
- **Access Control & Security**
45+
- [**Access Control & Security**]({{< relref "/rs/security/tls-ssl.md" >}}) - You can:
4646
- Enable the **Default User** for the database.
4747
We recommend that you use a complex password between 8 and 128 characters, and with at least one uppercase letter (A-Z), one lowercase letter (a-z), one number (0-9), and one special character.
4848
- Specify the **Source IP/Subnet** addresses that your database receives

Diff for: content/rc/api/concepts/metrics.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ categories: ["RC"]
77
draft: true
88
---
99
Metrics API provides programmatic access to database usage and performance data.
10-
The metrics API shows data that similar to the data that the Redis Cloud Admin Console shows in the database metrics.
10+
The metrics API shows data that similar to the data that the Redis Cloud admin console shows in the database metrics.
1111

1212
## Metric spans and intervals
1313

Diff for: content/rc/api/how-to/create-api-keys-for-your-team.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Title: Creating API Keys
3-
description: How to use the Redis Cloud Admin Console to create and manage API Keys for your Account's team owners
3+
description: How to use the Redis Cloud admin console to create and manage API Keys for your Account's team owners
44
weight: 20
55
alwaysopen: false
66
categories: ["RC"]

Diff for: content/rc/api/how-to/manage-api-keys.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
Title: Managing API Keys
3-
description: Managing API Keys using the Redis Cloud Admin Console
2+
Title: Manage API Keys
3+
description: Managing API Keys using the Redis Cloud admin console
44
weight: 30
55
alwaysopen: false
66
categories: ["RC"]

0 commit comments

Comments
 (0)