Skip to content

Commit fb34bb7

Browse files
rrelledgekaitlynmichael
rrelledge
authored and
kaitlynmichael
committed
RS: 7.8.6 release docs (#1295)
* DOC-4961 DOC-4962 RS: Added dry_run option to user and role REST API requests * DOC-4904 RS: Created release notes draft for RS 7.8.6 * DOC-4964 RS: Added change_password_hashing_algorithm REST API request reference * DOC-4964 RS: Added change_password_hashing_algorithm to rladmin reference * DOC-4904 Added new features to RS March release notes draft * Small copy edits for change_password_hashing_algorithm reference pages * DOC-4904 Added resolved issues to RS 7.8.6 release notes draft * DOC-4964 RS: Added change password hashing algorithm page under set password policies section and updated the password hashing note on the index page * DOC-4904 Added metrics stream engine GA placeholder to 7.8.6 release notes * Removed preview notes from metrics stream engine docs * DOC-4904 Added deprecation for internal monitoring and v1 Prometheus metrics to 7.8.6 release notes * DOC-4903 Added build number and checksums to release notes * DOC-4904 Removed metrics stream engine GA mentions from RS 7.8.6 release notes * Revert removal of preview tag/notes from metrics stream engine docs
1 parent d706a72 commit fb34bb7

File tree

9 files changed

+444
-3
lines changed

9 files changed

+444
-3
lines changed

Diff for: ‎assets/css/index.css

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ section.prose {
4848
}
4949

5050
.prose h1 {
51-
@apply text-4xl;
51+
@apply text-4xl break-words;
5252
}
5353

5454
.prose h1[id],

Diff for: ‎content/operate/rs/monitoring/metrics_stream_engine.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,4 @@ The v2 scraping endpoint also exposes metrics for `node_exporter` version 1.8.1.
3636

3737
## Transition from Prometheus v1 to Prometheus v2
3838

39-
If you are already using the existing scraping endpoint for integration, follow [this guide]({{<relref "/integrate/prometheus-with-redis-enterprise/prometheus-metrics-v1-to-v2">}}) to transition and try the new engine. It is possible to scrape both existing and new endpoints simultaneously, allowing advanced dashboard preparation and a smooth transition.
39+
If you are already using the existing scraping endpoint for integration, follow [this guide]({{<relref "/operate/rs/references/metrics/prometheus-metrics-v1-to-v2">}}) to transition and try the new engine. It is possible to scrape both existing and new endpoints simultaneously, allowing advanced dashboard preparation and a smooth transition.

Diff for: ‎content/operate/rs/references/cli-utilities/rladmin/cluster/change_password_hashing_algorithm.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
Title: rladmin cluster change_password_hashing_algorithm
3+
alwaysopen: false
4+
categories:
5+
- docs
6+
- operate
7+
- rs
8+
description: Changes the password hashing algorithm.
9+
headerRange: '[1-2]'
10+
linkTitle: change_password_hashing_algorithm
11+
tags:
12+
- configured
13+
toc: 'true'
14+
weight: $weight
15+
---
16+
17+
Changes the password hashing algorithm for the entire cluster. When you change the hashing algorithm, it rehashes the administrator password and passwords for all users, including default users.
18+
19+
```sh
20+
rladmin cluster change_password_hashing_algorithm <algorithm>
21+
```
22+
23+
### Parameters
24+
25+
| Parameter | Type/Value | Description |
26+
|-----------|------------|-------------|
27+
| algorithm | SHA-256<br />PBKDF2 | Change to the specified hashing algorithm. The default hashing algorithm is `SHA-256`. |
28+
29+
### Returns
30+
31+
Reports whether the algorithm change succeeded or an error occurred.
32+
33+
### Example
34+
35+
```sh
36+
$ rladmin cluster change_password_hashing_algorithm PBKDF2
37+
Please confirm changing the password hashing algorithm
38+
Please confirm [Y/N]: y
39+
Algorithm changed
40+
```

Diff for: ‎content/operate/rs/references/rest-api/requests/cluster/change_password_hashing_algorithm.md

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
Title: Change password hashing algorithm requests
3+
alwaysopen: false
4+
categories:
5+
- docs
6+
- operate
7+
- rs
8+
description: REST API requests to change the hashing algorithm for user passwords.
9+
headerRange: '[1-2]'
10+
linkTitle: change_password_hashing_algorithm
11+
weight: $weight
12+
---
13+
14+
| Method | Path | Description |
15+
|--------|------|-------------|
16+
| [PATCH](#patch-change-password-hashing-algorithm) | `/v1/cluster/change_password_hashing_algorithm` | Change the hashing policy for user passwords |
17+
18+
## Change password hashing algorithm {#patch-change-password-hashing-algorithm}
19+
20+
PATCH /v1/cluster/change_password_hashing_algorithm
21+
22+
Changes the password hashing algorithm for the entire cluster. When you change the hashing algorithm, it rehashes the administrator password and passwords for all users, including default users.
23+
24+
The hashing algorithm options are `SHA-256` or `PBKDF2`. The default hashing algorithm is `SHA-256`.
25+
26+
#### Required permissions
27+
28+
| Permission name |
29+
|-----------------|
30+
| [update_cluster]({{< relref "/operate/rs/references/rest-api/permissions#update_cluster" >}}) |
31+
32+
### Request {#patch-request}
33+
34+
#### Example HTTP request
35+
36+
PATCH /v1/cluster/change_password_hashing_algorithm
37+
38+
#### Example JSON body
39+
40+
```json
41+
{ "algorithm": "PBKDF2" }
42+
```
43+
44+
#### Request headers
45+
46+
| Key | Value | Description |
47+
|-----|-------|-------------|
48+
| Host | cnm.cluster.fqdn | Domain name |
49+
| Accept | application/json | Accepted media type |
50+
51+
#### Request body
52+
53+
Include a JSON object `{ "algorithm": "<option>" }` in the request body. The hashing algorithm options are `SHA-256` or `PBKDF2`.
54+
55+
### Response {#patch-response}
56+
57+
Returns a status code that indicates the success or failure of the update.
58+
59+
### Status codes {#patch-status-codes}
60+
61+
| Code | Description |
62+
|------|-------------|
63+
| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | Success |
64+
| [400 Bad Request](https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request) | Supported algorithm must be provided, or this algorithm is already set |

Diff for: ‎content/operate/rs/references/rest-api/requests/roles/_index.md

+16
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,17 @@ PUT /v1/roles/17
199199
| Host | cnm.cluster.fqdn | Domain name |
200200
| Accept | application/json | Accepted media type |
201201

202+
#### Query parameters
203+
204+
| Field | Type | Description |
205+
|---------|------|---------------|
206+
| dry_run | | Validate the updated [role object]({{< relref "/operate/rs/references/rest-api/objects/role" >}}) but don't apply the update. |
207+
208+
#### URL parameters
209+
210+
| Field | Type | Description |
211+
|-------|------|-------------|
212+
| uid | integer | The role's unique ID. |
202213

203214
#### Body
204215

@@ -275,6 +286,11 @@ POST /v1/roles
275286
| Host | cnm.cluster.fqdn | Domain name |
276287
| Accept | application/json | Accepted media type |
277288

289+
#### Query parameters
290+
291+
| Field | Type | Description |
292+
|---------|------|---------------|
293+
| dry_run | | Validate the new [role object]({{< relref "/operate/rs/references/rest-api/objects/role" >}}) but don't apply the update. |
278294

279295
#### Body
280296

Diff for: ‎content/operate/rs/references/rest-api/requests/users/_index.md

+11
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,11 @@ PUT /v1/users/1
190190
| Host | cnm.cluster.fqdn | Domain name |
191191
| Accept | application/json | Accepted media type |
192192

193+
#### Query parameters
194+
195+
| Field | Type | Description |
196+
|---------|------|---------------|
197+
| dry_run | | Validate the updated [user object]({{< relref "/operate/rs/references/rest-api/objects/user" >}}) but don't apply the update. |
193198

194199
#### URL parameters
195200

@@ -274,6 +279,12 @@ POST /v1/users
274279
| Host | cnm.cluster.fqdn | Domain name |
275280
| Accept | application/json | Accepted media type |
276281

282+
#### Query parameters
283+
284+
| Field | Type | Description |
285+
|---------|------|---------------|
286+
| dry_run | | Validate the new [user object]({{< relref "/operate/rs/references/rest-api/objects/user" >}}) but don't apply the update. |
287+
277288
#### Body
278289

279290
Include a single [user object]({{< relref "/operate/rs/references/rest-api/objects/user" >}}) in the request body. The user object must have an email, password, and role.

0 commit comments

Comments
 (0)