Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
fa3bd17
DOC-6183 RS: 8.0.14 release notes draft
rrelledge Feb 13, 2026
1e45f6d
Merge branch 'main' into DOC-6167
rrelledge Feb 19, 2026
cb947ea
DOC-6167 Added more detail to release notes for consolidated health r…
rrelledge Feb 19, 2026
b9a8822
Parameter fix
rrelledge Feb 19, 2026
e33d4df
DOC-2692 RS: Created new monitoring health report page
rrelledge Feb 19, 2026
8f20fca
DOC-2692 RS: Added more details and screenshots to health report page
rrelledge Feb 19, 2026
69689a6
DOC-2692 Added node health section and more screenshots
rrelledge Feb 20, 2026
a79aecc
DOC-6183 Changed 8.0.14 release notes draft to 8.0.16
rrelledge Feb 23, 2026
a63a7a2
DOC-2692 Removed CRDB mention from health report page
rrelledge Feb 23, 2026
bc433c7
DOC-6249 RS: Added global and local config sections to manage Active-…
rrelledge Feb 24, 2026
c69ea1e
DOC-6183 Added more details and links to RS 8.0.16 release notes
rrelledge Feb 24, 2026
94400a6
Merge branch 'main' into DOC-6167
rrelledge Feb 26, 2026
db8b1eb
Fixed RS 8.0 release notes order
rrelledge Feb 26, 2026
d6f12bf
Merge branch 'main' into DOC-6167
rrelledge Mar 2, 2026
7f2d82c
Merge branch 'main' into DOC-6167
rrelledge Mar 4, 2026
426bd08
DOC-6183 Added more resolved issues to RS 8.0.16 release notes
rrelledge Mar 4, 2026
d0bbb1c
DOC-6183 Added API deprecations to RS 8.0.16 release notes
rrelledge Mar 4, 2026
2a2ea22
DOC-6183 Added API enhancements and another resolved issue to RS 8.0.…
rrelledge Mar 5, 2026
8b1c730
Update rs-8-0-16-tba.md
rrelledge Mar 6, 2026
734047d
Update health-report.md
rrelledge Mar 6, 2026
fe206db
Merge branch 'main' into DOC-6167
rrelledge Mar 13, 2026
f3ce95c
DOC-6183 Added a few more resolved issues to the RS 8.0.16 release no…
rrelledge Mar 13, 2026
4742172
Merge branch 'main' into DOC-6167
rrelledge Mar 18, 2026
80d78be
DOC-6183 Added fix for LDAP filter breaking change to RS 8.0.16 relea…
rrelledge Mar 18, 2026
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
93 changes: 89 additions & 4 deletions content/operate/rs/databases/active-active/manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,98 @@ weight: 30

You can configure and manage your Active-Active database from either the Cluster Manager UI or the command line.

To change the global configuration of the Active-Active database, use [`crdb-cli`]({{< relref "/operate/rs/references/cli-utilities/crdb-cli" >}}).

If you need to apply changes locally to one database instance, you use the Cluster Manager UI or [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}).

## Database settings

Many Active-Active database settings can be changed after database creation. One notable exception is database clustering. Database clustering can't be turned on or off after the database has been created.
Most Active-Active database settings can be changed after database creation. One notable exception is database clustering, which can't be turned on or off after the database has been created.

As of Redis Software version 8.0.16, the Cluster Manager UI supports both [global](#change-global-configuration) and [local](#change-local-configuration) configuration changes for Active-Active databases. In earlier versions, configuration changes made in the Cluster Manager UI applied only to the local instance and required additional manual updates for each participating cluster.

### Change global configuration

Global configuration changes are applied to all participating clusters in the Active-Active database. However, if your Active-Active mesh contains local configurations, they will continue to override global settings on the database instances where they are applied.

{{< warning >}}
Applying global configuration changes will override any local settings created using the API or earlier Cluster Manager UI versions. To keep local changes, manage them in the [**Local** configuration tab](#change-local-configuration).
{{< /warning >}}

<br />

{{< multitabs id="change-global-config-methods"
tab1="Cluster Manager UI"
tab2="crdb-cli" >}}

To make global configuration changes in the Cluster Manager UI:

1. Select the Active-Active database from the **Databases** list and go to its **Configuration** screen.

1. While on the **Global** tab, click **Edit**.

<img src="../../../../../images/rs/screenshots/databases/active-active-databases/global-config-tab.png" alt="The global configuration tab is selected.">

1. Make your configuration changes.

1. Click **Save** to apply the changes globally to all participating clusters.

-tab-sep-

To change the global configuration from the command line, use [`crdb-cli crdb update`]({{< relref "/operate/rs/references/cli-utilities/crdb-cli/crdb/update" >}}):

```sh
crdb-cli crdb update --crdb-guid <guid> --<setting-name> <setting-value>
```

Replace the placeholders `<placeholder>` with your own values.

{{< /multitabs >}}

### Change local configuration

Local configuration changes override global configuration settings and are applied only to the database instance on the current cluster.

To apply changes to a local Active-Active database instance, use one of the following methods:

{{< multitabs id="change-local-config-methods"
tab1="Cluster Manager UI"
tab2="rladmin" >}}

To change the local configuration in the Cluster Manager UI:

1. Select the Active-Active database from the **Databases** list and go to its **Configuration** screen.

1. Go to the **Local** tab.

<img src="../../../../../images/rs/screenshots/databases/active-active-databases/local-config-tab.png" alt="The local configuration tab is selected.">

1. Click **Edit**, then make your configuration changes.

1. Click **Save** to apply the changes to the current database instance only.

-tab-sep-

To change the local configuration from the command line, use [`rladmin tune db`]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-db" >}}):

```sh
rladmin tune db { db:<id> | <name> } <setting-name> <setting-value>
```
Replace the placeholders `<placeholder>` with your own values.
{{< /multitabs >}}
### View differences between global and local configuration
In the Cluster Manager UI, an Active-Active database's **Global** configuration tab indicates when a local configuration differs from the global configuration:
{{<image filename="images/rs/screenshots/databases/active-active-databases/local-config-warning.png" alt="On the global configuration tab, a warning is visible that says: 'This Active Active mesh contains local configurations which will not be affected by the global settings'." >}}
If a warning symbol appears next to a setting on the **Global** configuration tab, point to the warning symbol to show details about the local configuration differences:
{{<image filename="images/rs/screenshots/databases/active-active-databases/local-config-warning-details.png" alt="An example that shows memory eviction is set to noeviction globally but allkeys-lru locally." >}}
On the **Local** configuration tab, any locally configured settings that differ from the global settings are marked with a **Local configuration** label:
{{<image filename="images/rs/screenshots/databases/active-active-databases/local-config-tag.png" alt="A local configuration label appears next to Memory eviction allkeys-lru." >}}
## Participating clusters
Expand Down
142 changes: 142 additions & 0 deletions content/operate/rs/monitoring/health-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
---
Title: Consolidated health report
alwaysopen: false
categories:
- docs
- operate
- rs
description: View the consolidated health report to get a read-only snapshot of a Redis Software cluster's current system health.
linkTitle: Consolidated health report
weight: 78
tocEmbedHeaders: true
---

The consolidated health report is a read-only, consolidated snapshot of a cluster's current system health, including:

- License and certificate status

- Nodes and services health

- Node memory breakdown, including free and provisioned memory

- Running actions status

- Active alerts

- Basic database status and version

- High availability health

The consolidated health report consolidates cluster and database health information that was previously scattered across multiple APIs and CLI commands, such as [`rladmin status extra all`]({{<relref "/operate/rs/references/cli-utilities/rladmin/status">}}) and required SSH access to view.

As of Redis Software version 8.0.16, you can access the cluster and database health reports using the [Cluster manager UI](#view-health-overview) or [REST API requests](#health-rest-api-requests).

## View health overview {#view-health-overview}

You can access the cluster and database health reports using the **Overview** screen in the Cluster Manager UI.

You can view node health

{{<image filename="images/rs/screenshots/overview/health-report-overview.png" alt="The health report screen.">}}

### Cluster info

The **Cluster Info** section provides basic cluster details, including:

- Overall cluster status

- Redis Software cluster version

- License usage and expiration date

### Cluster storage

The **Cluster Storage** section provides memory usage details, including used memory, free memory, and total memory for RAM, flash, persistent storage, and ephemeral storage on the cluster.

### Nodes

The **Nodes** section shows the status of nodes in the cluster and indicates which node is the leader or primary node.

### Databases

In the **Databases** section, you can check each database's status and Redis version. You can click the number listed by each field to display the relevant database names and click on the database links to view database details.

{{<image filename="images/rs/screenshots/overview/db-status-hover.png" alt="Active database names and links are displayed.">}}

### Certificates

The **Certificates** section shows whether the cluster's certificates are still valid. If a certificate appears as no longer valid, you can click the **Certificates** link to update the certificate.

{{<image filename="images/rs/screenshots/overview/cert-expires-soon.png" alt="The certificates section shows an alert that the SSO service certificate expires soon.">}}

### Actions

In the **Actions** section, you can view currently running actions.

{{<image filename="images/rs/screenshots/overview/running-actions.png" alt="The Actions section shows a database upgrade is in progress.">}}

### Alerts and services

If a configured alert threshold is reached or a running service stops, an alert will appear in the **Alerts & Services** section.

{{<image filename="images/rs/screenshots/overview/active-alerts.png" alt="Active alerts are displayed ephemeral and persistent storage have reached 90% capacity.">}}

## View node health {#view-node-health}

On the **Nodes** screen of the Cluster Manager UI, you can click on a node to go to its **Node configuration** tab and view node health details.

{{<image filename="images/rs/screenshots/nodes/node-config-screen.png" alt="Node configuration screen.">}}

### Verify nodes

You can check if nodes are functioning properly using one of the following methods:

{{< multitabs id="verify-nodes"
tab1="Verify all nodes"
tab2="Verify specific node" >}}

On the **Nodes** screen, click **Verify all nodes**.

-tab-sep-

1. On the **Nodes** screen, find the node you want verify in the list and click the **More actions** button (**&vellip;**).

1. Select **Verify node** from the list.

<img src="../../../../images/rs/screenshots/nodes/primary-node-more-actions-8-0.png" alt="Click the more actions button for a node to access node actions.">

{{< /multitabs >}}

### Node storage

The **Node storage** section of the **Node configuration** tab provides memory usage details, including used memory, free memory, and total memory for RAM, flash, persistent storage, and ephemeral storage on the node.

### Services

In the **Services** section **Node configuration** tab, you can view the list of services running on the node and the most recent status of each.

{{<image filename="images/rs/screenshots/nodes/node-stopped-service.png" alt="The services section shows most services running and one stopped service.">}}

### Shards

When viewing a node's configuration, you can click the **Shards** tab to view a list of database shards running on the node and related details such as each shard's ID, current status, role, and slot range.

{{<image filename="images/rs/screenshots/nodes/node-shards.png" alt="A list of database shards on the node.">}}

## Health report REST API requests {#health-rest-api-requests}

### Cluster health report requests

[Cluster health report]({{<relref "/operate/rs/references/rest-api/api-reference/#tag/Cluster/operation/cluster_cluster_health_report">}}) REST API requests provide overall health information for a cluster:

```sh
GET https://<host>:<port>/v4/cluster/health
```

### Database health report requests

[Database health report]({{<relref "/operate/rs/references/rest-api/api-reference/#tag/Database/operation/cluster_database_health_report">}}) REST API requests provide detailed health information for a specific database:

```sh
GET https://<host>:<port>/v4/bdb/<database_id>/health
```
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ An API object that represents the cluster.
| smtp_tls_mode | "none"<br />"starttls"<br />"tls" | Specifies which TLS mode to use for SMTP access |
| smtp_use_tls | boolean (default: false) | Use TLS for SMTP access (deprecated as of Redis Software v4.3.3, use smtp_tls_mode field instead) |
| smtp_username | string | SMTP server username (pattern does not allow special characters &,\<,>,") |
| <span class="break-all">state_machine_smart_client_handoffs_delay_ms</span> | integer (range: 0-10000) (default: 2000) | For smart client handoffs feature, the time in milliseconds to pause the state machine between sending the notification to clients and performing the operation |
| syncer_certificate | string | Cluster's syncer certificate |
| upgrade_mode | boolean (default: false) | Is cluster currently in upgrade mode |
| use_external_ipv6 | boolean (default: true) | Should redislabs services listen on ipv6 |
Expand Down
4 changes: 3 additions & 1 deletion content/operate/rs/release-notes/rs-8-0-releases/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ For more detailed release notes, select a build version from the following table

### Breaking changes

- LDAP filters for `user_dn_query` and `dn_group_query` now strictly require parentheses to function correctly. Filters that previously worked without parentheses will no longer work after upgrading to Redis Software 8.0.x. For example, you must include the parentheses in `(sAMAccountName=%u)`.
- For Redis Software versions 8.0.2 through 8.0.10, LDAP filters for `user_dn_query` and `dn_group_query` strictly require parentheses to function correctly. Filters that previously worked without parentheses will no longer work after upgrading to these versions. For example, you must include the parentheses in `(sAMAccountName=%u)`. As of version 8.0.16, this breaking change no longer applies, and both `(sAMAccountName=%u)` and `sAMAccountName=%u` are valid filters.

- Redis Software installation script changes:

Expand Down Expand Up @@ -145,6 +145,8 @@ See [Ports and port ranges used by Redis Software]({{<relref "/operate/rs/networ

- Deprecated the `module_args` field for [database]({{<relref "/operate/rs/references/rest-api/requests/bdbs">}}) REST API requests. Use the new module configuration objects `search`, `timeseries`, and `probabilistic` instead.

- Deprecated `event_archive_cleanup_task_settings` for `job_scheduler` REST API requests.

#### Redis Search deprecations

- Deprecated commands: `FT.ADD`, `FT.SAFEADD`, `FT.DEL`, `FT.GET`, `FT.MGET`, `FT.SYNADD`, `FT.DROP`, `FT._DROPIFX`, and `FT.CONFIG`.
Expand Down
Loading
Loading