You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* DOC-5565 RS 7.22.2 release notes draft
* DOC-5565 Added resolved issues and more details about customer-managed internode encryption certs to RS 7.22.2 release notes
* RS: Customer-managed certificates for internode encryption (#2010)
* DOC-5210 RS: Added ccs_internode_encryption and data_internode_encryption to certificates table
* DOC-5210 Added more details to the INE certificate descriptions
* DOC-5210 Added new section for customer-managed internode encryption certificates
* DOC-5210 Copy edits
* Add <img> handling to show full size image on click, similar to image shortcode
* DOC-5210 More copy edits
* Reduce top margin when headers immediately follow other headers with no regular text in between
* DOC-5564 Added link to customer-provided internode encryption certs in release notes
* DOC-5210 Updated rladmin and REST API examples for customer-provided INE certs
* DOC-5210 Updated rladmin cluster certificate reference for customer-provided INE certs
* DOC-5210 Updated certificate REST API requests reference for customer-provided INE certs
* Added deprecation of PUT /v1/cluster/update_cert to RS 7.22.2 release notes
* DOC-5210 Added new customer_managed_ine_certificates to v2 Prometheus metrics
* DOC-5210 Added new PUT /v1/cluster/certificates examples for updating certs in RS 7.22.2 and later
* Attempting to fix broken img in RS update certs
* DOC-5210 Feedback update to clarify when new certs are used
* DOC-5210 Feedback update to clarify rladmin cluster certificate reference - divided command options into 2 sections
* DOC-5210 Feedback update for auto-copying certs to new nodes
* DOC-5210 Feedback update to add shared and separate INE cert examples for rladmin and REST API
* DOC-5210 Fixed typo
* DOC-5210 Fixed multitabs IDs
* DOC-5210 Updated screenshot for cluster certs screen that includes INE certs section
* DOC-5566 Added build number and checksums to 7.22.2 Sept release notes, removed bug fix that will be in a future maintenance release, mentioned bug fixes in highlights/description
* DOC-5210 Feedback update to add RSA key requirement for customer-provided INE certs
* DOC-5564 Updated RS 7.22.2 release notes build number and checksums
Copy file name to clipboardExpand all lines: content/embeds/rs-prometheus-metrics-v2.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,6 +51,7 @@
51
51
| <spanclass="break-all">node_available_memory_no_overbooking_bytes</span> | gauge | Available RAM in the node (bytes) without taking into account overbooking |
52
52
| node_bigstore_free_bytes | gauge | Sum of free space of back-end flash (used by flash database's [BigRedis]) on all cluster nodes (bytes); returned only when BigRedis is enabled |
53
53
| <spanclass="break-all">node_cert_expires_in_seconds</span> | gauge | Certificate expiration (in seconds) per given node; read more about [certificates in Redis Enterprise]({{< relref "/operate/rs/security/certificates" >}}) and [monitoring certificates]({{< relref "/operate/rs/security/certificates/monitor-certificates" >}}) |
54
+
| <spanclass="break-all">customer_managed_ine_certificates</span> | gauge | Indicates whether customer-provided internode encryption certificates are in use<br />0=No<br />1=Yes |
54
55
| <spanclass="break-all">node_ephemeral_storage_avail_bytes</span> | gauge | Disk space available to RLEC processes on configured ephemeral disk (bytes) |
55
56
| <spanclass="break-all">node_ephemeral_storage_free_bytes</span> | gauge | Free disk space on configured ephemeral disk (bytes) |
56
57
| node_memory_MemFree_bytes | gauge | Free memory in the node (bytes) |
Copy file name to clipboardExpand all lines: content/operate/rs/references/cli-utilities/rladmin/cluster/certificate.md
+46-6Lines changed: 46 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ categories:
5
5
- docs
6
6
- operate
7
7
- rs
8
-
description: Sets the cluster certificate.
8
+
description: Sets cluster certificates.
9
9
headerRange: '[1-2]'
10
10
linkTitle: certificate
11
11
tags:
@@ -14,13 +14,14 @@ toc: 'true'
14
14
weight: $weight
15
15
---
16
16
17
+
## `cluster certificate set <certificate_name>`
18
+
17
19
Sets a cluster certificate to a specified PEM file.
18
20
19
21
```sh
20
-
rladmin cluster certificate
21
-
set<certificate name>
22
-
certificate_file <certificate filepath>
23
-
[ key_file <key filepath> ]
22
+
rladmin cluster certificate set<certificate_name>
23
+
certificate_file <filepath>
24
+
[ key_file <filepath> ]
24
25
```
25
26
26
27
To set a certificate for a specific service, use the corresponding certificate name. See the [certificates table]({{< relref "/operate/rs/security/certificates" >}}) for the list of cluster certificates and their descriptions.
@@ -29,7 +30,7 @@ To set a certificate for a specific service, use the corresponding certificate n
29
30
30
31
| Parameter | Type/Value | Description |
31
32
|-----------|------------|-------------|
32
-
|certificate name | 'cm'<br /> 'api'<br /> 'proxy'<br /> 'syncer'<br /> 'metrics_exporter' | Name of the certificate to update |
33
+
|certificate_name | 'cm'<br /> 'api'<br /> 'proxy'<br /> 'syncer'<br /> 'metrics_exporter' | Name of the certificate to update. See the [certificates table]({{< relref "/operate/rs/security/certificates" >}}) for descriptions.|
33
34
| certificate_file | filepath | Path to the certificate file |
34
35
| key_file | filepath | Path to the key file (optional) |
35
36
@@ -39,8 +40,47 @@ Reports that the certificate was set to the specified file. Returns an error mes
39
40
40
41
### Example
41
42
43
+
Update the proxy certificate:
44
+
42
45
```sh
43
46
$ rladmin cluster certificate set proxy \
44
47
certificate_file /tmp/proxy.pem
45
48
Set proxy certificate to contents of file /tmp/proxy.pem
| dpine_certificate_file | filepath | Path to the data plane internode encryption (DPINE) certificate file |
68
+
| dpine_key_file | filepath | Path to the data plane internode encryption (DPINE) key file |
69
+
| cpine_certificate_file | filepath | Path to the control plane internode encryption (CPINE) certificate file |
70
+
| cpine_key_file | filepath | Path to the control plane internode encryption (CPINE) key file |
71
+
72
+
### Returns
73
+
74
+
Reports that the internal certificates were set to the specified files. Returns an error message if the certificates fail to update.
75
+
76
+
### Example
77
+
78
+
Set up [customer-provided internode encryption certificates]({{<relref "/operate/rs/security/encryption/internode-encryption#customer-provided-certificates">}}):
description: An object that represents a certificate
9
+
linkTitle: certificates
10
+
weight: $weight
11
+
---
12
+
13
+
An API object that represents a certificate used by a Redis Enterprise Software cluster.
14
+
15
+
| Name | Type/Value | Description |
16
+
|------|------------|-------------|
17
+
| name |`cm`<br />`api`<br />`mtls_trusted_ca`<br />`proxy`<br />`metrics_exporter`<br />`syncer`<br />`ldap_client`<br />`ccs_internode_encryption`<br />`data_internode_encryption`| Certificate type.<br />See the [certificates table]({{< relref "/operate/rs/security/certificates" >}}) for the list of cluster certificates and their descriptions. |
18
+
| certificate | string | The certificate in PEM format |
Replaces multiple cluster certificates with the provided certificates on all nodes within the cluster. This endpoint validates all provided certificates before actually updating the cluster.
76
+
77
+
See the [certificates table]({{< relref "/operate/rs/security/certificates" >}}) for the list of cluster certificates and their descriptions.
This REST API path is deprecated as of Redis Enterprise Software 7.22.2 and will be removed in a future version. Use [`PUT /v1/cluster/certificates`](#put-cluster-certificates) instead.
141
+
{{</note>}}
142
+
74
143
Replaces an existing certificate on all nodes within the cluster with a new certificate. The new certificate must pass validation before it can replace the old certificate.
75
144
76
145
See the [certificates table]({{< relref "/operate/rs/security/certificates" >}}) for the list of cluster certificates and their descriptions.
@@ -105,12 +174,12 @@ Otherwise, retry the certificate update in case the failure was due to a tempora
105
174
106
175
| Code | Description |
107
176
|------|-------------|
108
-
|[200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1)| No error |
109
-
|[400 Bad Request](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1)| Failed, invalid certificate. |
|[404 Not Found](https://www.rfc-editor.org/rfc/rfc9110.html#name-404-not-found)| Failed, requested deletion of an unknown certificate |
217
+
|[403 Forbidden](https://www.rfc-editor.org/rfc/rfc9110.html#name-403-forbidden)| Failed, requested deletion of a required certificate |
218
+
|[500 Internal Server Error](https://www.rfc-editor.org/rfc/rfc9110.html#name-500-internal-server-error)| Failed, error while deleting certificate from disk |
Copy file name to clipboardExpand all lines: content/operate/rs/release-notes/rs-7-22-releases/_index.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,6 +55,8 @@ For more detailed release notes, select a build version from the following table
55
55
56
56
- Deprecated the `data_files` option for the `recovery_plan` specified in [`POST /v2/bdbs`]({{<relref "/operate/rs/references/rest-api/requests/bdbs#post-bdbs-v2">}}) requests. Use the new `original_bdb_shards` option to recover a database from the provided list of shards instead.
57
57
58
+
- Deprecated [`PUT /v1/cluster/update_cert`]({{<relref "/operate/rs/references/rest-api/requests/cluster/certificates#put-cluster-update_cert">}}) REST API requests as of Redis Enterprise Software version 7.22.2. Use [`PUT /v1/cluster/certificates`]({{<relref "/operate/rs/references/rest-api/requests/cluster/certificates#put-cluster-certificates">}}) to update cluster certificates instead.
59
+
58
60
#### Internal monitoring and v1 Prometheus metrics deprecation
59
61
60
62
The existing [internal monitoring engine]({{<relref "/operate/rs/monitoring/v1_monitoring">}}) is deprecated. We recommend transitioning to the new [metrics stream engine]({{<relref "/operate/rs/monitoring/metrics_stream_engine">}}) for improved performance, enhanced integration capabilities, and modernized metrics streaming.
0 commit comments