Skip to content

Commit a7eccaa

Browse files
committed
DOC-5210 Added new PUT /v1/cluster/certificates examples for updating certs in RS 7.22.2 and later
1 parent 2e915cc commit a7eccaa

File tree

2 files changed

+54
-16
lines changed

2 files changed

+54
-16
lines changed

content/operate/rs/security/certificates/certificate-based-authentication.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,23 @@ To set up certificate-based authentication:
2626

2727
### Add mtls_trusted_ca certificate {#add-cert}
2828

29-
Add a trusted CA certificate `mtls_trusted_ca` to the cluster using an [update cluster certificate]({{<relref "/operate/rs/references/rest-api/requests/cluster/certificates#put-cluster-update_cert">}}) request:
29+
To add a trusted CA certificate `mtls_trusted_ca` to the cluster, use an [update cluster certificates]({{<relref "/operate/rs/references/rest-api/requests/cluster/certificates">}}) request.
30+
31+
For Redis Enterprise Software versions 7.22.2 and later, use:
32+
33+
```sh
34+
PUT /v1/cluster/certificates
35+
{
36+
"certificates": [
37+
{
38+
"name": "mtls_trusted_ca",
39+
"certificate": "<content of certificate PEM file>"
40+
}
41+
]
42+
}
43+
```
44+
45+
For Redis Enterprise Software versions 7.22.0 and earlier, use:
3046

3147
```sh
3248
PUT /v1/cluster/update_cert

content/operate/rs/security/certificates/updating-certificates.md

Lines changed: 37 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,10 @@ When you update the certificates, the new certificate replaces the same certific
1818

1919
You can use the [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}) command-line interface (CLI) or the [REST API]({{< relref "/operate/rs/references/rest-api" >}}) to update certificates. The Cluster Manager UI lets you update proxy, syncer, and internode encryption certificates on the **Cluster > Security > Certificates** screen.
2020

21-
The new certificates are used the next time the clients connect to the database.
22-
23-
When you upgrade Redis Enterprise Software, the upgrade process copies the certificates that are on the first upgraded node to all of the nodes in the cluster.
24-
25-
{{<note>}}
26-
Don't manually overwrite the files located in `/etc/opt/redislabs`. Instead, upload new certificates to a temporary location on one of the cluster nodes, such as the `/tmp` directory.
27-
{{</note>}}
28-
29-
### Use the Cluster Manager UI
21+
{{< multitabs id="get-module-versions"
22+
tab1="Cluster Manager UI"
23+
tab2="rladmin"
24+
tab3="REST API" >}}
3025

3126
To replace proxy or syncer certificates using the Cluster Manager UI:
3227

@@ -37,19 +32,19 @@ To replace proxy or syncer certificates using the Cluster Manager UI:
3732
- For the proxy certificate, expand **Server authentication**.
3833
- For the syncer certificate, expand **Replica Of and Active-Active authentication**.
3934

40-
{{<image filename="images/rs/screenshots/cluster/security-expand-proxy-cert.png" alt="Expanded proxy certificate for server authentication.">}}
35+
<img src="/images/rs/screenshots/cluster/security-expand-proxy-cert.png" alt="Expanded proxy certificate for server authentication.">
4136

4237
1. Click **Replace Certificate** to open the dialog.
4338

44-
{{<image filename="images/rs/screenshots/cluster/security-replace-proxy-cert.png" alt="Replace proxy certificate dialog.">}}
39+
<img src="/images/rs/screenshots/cluster/security-replace-proxy-cert.png" alt="Replace proxy certificate dialog.">
4540

4641
1. Upload the key file.
4742

4843
1. Upload the new certificate.
4944

5045
1. Click **Save**.
5146

52-
### Use the CLI
47+
-tab-sep-
5348

5449
To replace certificates with the `rladmin` CLI, run the [`cluster certificate set`]({{< relref "/operate/rs/references/cli-utilities/rladmin/cluster/certificate" >}}) command:
5550

@@ -69,12 +64,29 @@ For example, to replace the Cluster Manager UI (`cm`) certificate with the priva
6964
rladmin cluster certificate set cm certificate_file cluster.pem key_file key.pem
7065
```
7166

72-
### Use the REST API
67+
-tab-sep-
68+
69+
To replace a certificate using the REST API, use an [update cluster certificates]({{<relref "/operate/rs/references/rest-api/requests/cluster/certificates">}}) request.
70+
71+
For Redis Enterprise Software versions 7.22.2 and later, use:
72+
73+
```sh
74+
PUT https://<host>:<port>/v1/cluster/certificates
75+
{
76+
"certificates": [
77+
{
78+
"name": "<cert_name>",
79+
"certificate": "<cert>",
80+
"key": "<key>"
81+
}
82+
]
83+
}
84+
```
7385

74-
To replace a certificate using the REST API, use [`PUT /v1/cluster/update_cert`]({{< relref "/operate/rs/references/rest-api/requests/cluster/certificates#put-cluster-update_cert" >}}):
86+
For Redis Enterprise Software versions 7.22.0 and earlier, use:
7587

7688
```sh
77-
PUT https://[host][:port]/v1/cluster/update_cert
89+
PUT https://<host>:<port>/v1/cluster/update_cert
7890
'{ "name": "<cert_name>", "key": "<key>", "certificate": "<cert>" }'
7991
```
8092

@@ -91,6 +103,16 @@ Replace the following variables with your own values:
91103

92104
- `<cert>` - The contents of the \*\_cert.pem file
93105

106+
{{< /multitabs >}}
107+
108+
The new certificates are used the next time the clients connect to the database.
109+
110+
When you upgrade Redis Enterprise Software, the upgrade process copies the certificates that are on the first upgraded node to all of the nodes in the cluster.
111+
112+
{{<note>}}
113+
Don't manually overwrite the files located in `/etc/opt/redislabs`. Instead, upload new certificates to a temporary location on one of the cluster nodes, such as the `/tmp` directory.
114+
{{</note>}}
115+
94116
## Replica Of database certificates
95117

96118
This section describes how to update certificates for Replica Of databases.

0 commit comments

Comments
 (0)