Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RS: 7.8.6 release docs #1295

Merged
merged 15 commits into from
Mar 27, 2025
Merged
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion assets/css/index.css
Original file line number Diff line number Diff line change
@@ -48,7 +48,7 @@ section.prose {
}

.prose h1 {
@apply text-4xl;
@apply text-4xl break-words;
}

.prose h1[id],
2 changes: 1 addition & 1 deletion content/operate/rs/monitoring/metrics_stream_engine.md
Original file line number Diff line number Diff line change
@@ -36,4 +36,4 @@ The v2 scraping endpoint also exposes metrics for `node_exporter` version 1.8.1.

## Transition from Prometheus v1 to Prometheus v2

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.
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.
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
Title: rladmin cluster change_password_hashing_algorithm
alwaysopen: false
categories:
- docs
- operate
- rs
description: Changes the password hashing algorithm.
headerRange: '[1-2]'
linkTitle: change_password_hashing_algorithm
tags:
- configured
toc: 'true'
weight: $weight
---

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.

```sh
rladmin cluster change_password_hashing_algorithm <algorithm>
```

### Parameters

| Parameter | Type/Value | Description |
|-----------|------------|-------------|
| algorithm | SHA-256<br />PBKDF2 | Change to the specified hashing algorithm. The default hashing algorithm is `SHA-256`. |

### Returns

Reports whether the algorithm change succeeded or an error occurred.

### Example

```sh
$ rladmin cluster change_password_hashing_algorithm PBKDF2
Please confirm changing the password hashing algorithm
Please confirm [Y/N]: y
Algorithm changed
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
Title: Change password hashing algorithm requests
alwaysopen: false
categories:
- docs
- operate
- rs
description: REST API requests to change the hashing algorithm for user passwords.
headerRange: '[1-2]'
linkTitle: change_password_hashing_algorithm
weight: $weight
---

| Method | Path | Description |
|--------|------|-------------|
| [PATCH](#patch-change-password-hashing-algorithm) | `/v1/cluster/change_password_hashing_algorithm` | Change the hashing policy for user passwords |

## Change password hashing algorithm {#patch-change-password-hashing-algorithm}

PATCH /v1/cluster/change_password_hashing_algorithm

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.

The hashing algorithm options are `SHA-256` or `PBKDF2`. The default hashing algorithm is `SHA-256`.

#### Required permissions

| Permission name |
|-----------------|
| [update_cluster]({{< relref "/operate/rs/references/rest-api/permissions#update_cluster" >}}) |

### Request {#patch-request}

#### Example HTTP request

PATCH /v1/cluster/change_password_hashing_algorithm

#### Example JSON body

```json
{ "algorithm": "PBKDF2" }
```

#### Request headers

| Key | Value | Description |
|-----|-------|-------------|
| Host | cnm.cluster.fqdn | Domain name |
| Accept | application/json | Accepted media type |

#### Request body

Include a JSON object `{ "algorithm": "<option>" }` in the request body. The hashing algorithm options are `SHA-256` or `PBKDF2`.

### Response {#patch-response}

Returns a status code that indicates the success or failure of the update.

### Status codes {#patch-status-codes}

| Code | Description |
|------|-------------|
| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | Success |
| [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 |
16 changes: 16 additions & 0 deletions content/operate/rs/references/rest-api/requests/roles/_index.md
Original file line number Diff line number Diff line change
@@ -199,6 +199,17 @@ PUT /v1/roles/17
| Host | cnm.cluster.fqdn | Domain name |
| Accept | application/json | Accepted media type |

#### Query parameters

| Field | Type | Description |
|---------|------|---------------|
| dry_run | | Validate the updated [role object]({{< relref "/operate/rs/references/rest-api/objects/role" >}}) but don't apply the update. |

#### URL parameters

| Field | Type | Description |
|-------|------|-------------|
| uid | integer | The role's unique ID. |

#### Body

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

#### Query parameters

| Field | Type | Description |
|---------|------|---------------|
| dry_run | | Validate the new [role object]({{< relref "/operate/rs/references/rest-api/objects/role" >}}) but don't apply the update. |

#### Body

11 changes: 11 additions & 0 deletions content/operate/rs/references/rest-api/requests/users/_index.md
Original file line number Diff line number Diff line change
@@ -190,6 +190,11 @@ PUT /v1/users/1
| Host | cnm.cluster.fqdn | Domain name |
| Accept | application/json | Accepted media type |

#### Query parameters

| Field | Type | Description |
|---------|------|---------------|
| dry_run | | Validate the updated [user object]({{< relref "/operate/rs/references/rest-api/objects/user" >}}) but don't apply the update. |

#### URL parameters

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

#### Query parameters

| Field | Type | Description |
|---------|------|---------------|
| dry_run | | Validate the new [user object]({{< relref "/operate/rs/references/rest-api/objects/user" >}}) but don't apply the update. |

#### Body

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.
Loading