Skip to content

RS: Add RS 7.8 versioned docs #1351

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

Open
wants to merge 24 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
f5e5968
DOC-4928 RS: Add RS 7.8 versioned docs
rrelledge Apr 1, 2025
591379e
DOC-4928 Removed duplicate aliases from 7.8 versioned docs
rrelledge Apr 1, 2025
a2469b9
DOC-4928 Added missing prometheus metrics references to RS 7.8 versio…
rrelledge Apr 1, 2025
5bdc67d
DOC-4928 Added missing networking docs to RS 7.8 versioned docs
rrelledge Apr 1, 2025
06a1496
DOC-4928 Added missing v1 monitoring doc to RS 7.8 versioned docs
rrelledge Apr 1, 2025
8816439
Fix versioned relrefs
paoloredis Apr 2, 2025
ad42634
Merge branch 'main' into DOC-4928
rrelledge Apr 2, 2025
7387902
DOC-4928 Added 7.8 version banner
rrelledge Apr 2, 2025
f765719
Merge branch 'main' into DOC-4928
rrelledge Apr 8, 2025
13a4c6b
Merge branch 'main' into DOC-4928
rrelledge Apr 10, 2025
9169331
DOC-5034 Copy missing job_scheduler REST API references to RS v7.8
rrelledge Apr 10, 2025
011cac2
Fixed links to RS release notes in versioned docs
rrelledge Apr 10, 2025
e9f1ddf
Merge branch 'main' into DOC-4928
rrelledge Apr 11, 2025
db9489f
DOC-3605 Copy support package CM UI options to RS 7.8 version
rrelledge Apr 11, 2025
9bd705d
Merge branch 'main' into DOC-4928
rrelledge Apr 11, 2025
50393dd
Merge branch 'main' into DOC-4928
rrelledge Apr 14, 2025
534bd5a
DOC-4986 Copy rladmin cluster config s3_ca_cert step to import/export…
rrelledge Apr 14, 2025
854288e
Merge branch 'main' into DOC-4928
rrelledge Apr 30, 2025
c16bd7b
Copy certificate landing page edits to RS v7.8 docs
rrelledge Apr 30, 2025
d70b44e
Copied required_version bootstrap API deprecation to RS v7.8 docs
rrelledge Apr 30, 2025
190197a
Merge branch 'main' into DOC-4928
rrelledge May 5, 2025
89ae4b4
Copied fix for broken download center link to RS 7.8 version
rrelledge May 5, 2025
7e2c47b
Merge branch 'main' into DOC-4928
rrelledge May 8, 2025
3473480
DOC-5216 Copied bigstore_enabled to RS 7.8 node REST API reference
rrelledge May 8, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
82 changes: 82 additions & 0 deletions content/operate/rs/7.8/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
Title: Redis Enterprise Software
alwaysopen: false
categories:
- docs
- operate
- rs
description: The self-managed, enterprise-grade version of Redis.
hideListLinks: true
weight: 10
linkTitle: 7.8
url: '/operate/rs/7.8/'
---

[Redis Enterprise](https://redis.io/enterprise/) is a self-managed, enterprise-grade version of Redis.

With Redis Enterprise, you get many enterprise-grade capabilities, including:
- Linear scalability
- High availability, backups, and recovery
- Predictable performance
- 24/7 support

You can run self-managed Redis Enterprise Software in an on-premises data center or on your preferred cloud platform.

If you prefer a fully managed Redis database-as-a-service, available on major public cloud services, consider setting up a [Redis Cloud]({{<relref "/operate/rc">}}) subscription. You can [try Redis Cloud](https://redis.io/try-free/) for free.

## Get started
Build a small-scale cluster with the Redis Enterprise Software container image.
- [Linux quickstart]({{< relref "/operate/rs/7.8/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}})
- [Docker quickstart]({{< relref "/operate/rs/7.8/installing-upgrading/quickstarts/docker-quickstart" >}})
- [Get started with Active-Active]({{< relref "/operate/rs/7.8/databases/active-active/get-started" >}})

## Install & setup
[Install & set up]({{< relref "/operate/rs/7.8/installing-upgrading" >}}) a Redis Enterprise Software cluster.
- [Networking]({{< relref "/operate/rs/7.8/networking" >}})
- [Set up]({{< relref "/operate/rs/7.8/clusters/new-cluster-setup" >}}) & [configure]({{< relref "/operate/rs/7.8/clusters/configure" >}}) a [cluster]({{< relref "/operate/rs/7.8/clusters" >}})
- [Release notes]({{< relref "/operate/rs/release-notes" >}})

## Databases
Create and manage a [Redis database]({{< relref "/operate/rs/7.8/databases" >}}) on a cluster.
- [Create a Redis Enterprise Software database]({{< relref "/operate/rs/7.8/databases/create" >}})
- [Configure database]({{< relref "/operate/rs/7.8/databases/configure" >}})
- [Create Active-Active database]({{< relref "/operate/rs/7.8/databases/active-active/create" >}})
- [Edit Active-Active database]({{< relref "/operate/rs/7.8/databases/active-active/manage.md" >}})

## Security
[Manage secure connections]({{< relref "/operate/rs/7.8/security" >}}) to the cluster and databases.
- [Access control]({{< relref "/operate/rs/7.8/security/access-control" >}})
- [Users]({{< relref "/operate/rs/7.8/security/access-control/manage-users" >}}) & [roles]({{< relref "/operate/rs/7.8/security/access-control" >}})
- [Certificates]({{< relref "/operate/rs/7.8/security/certificates" >}})
- [TLS]({{< relref "/operate/rs/7.8/security/encryption/tls" >}}) & [Encryption]({{< relref "/operate/rs/7.8/security/encryption" >}})

## Reference
Use command-line utilities and the REST API to manage the cluster and databases.
- [rladmin]({{< relref "/operate/rs/7.8/references/cli-utilities/rladmin" >}}), [crdb-cli]({{< relref "/operate/rs/7.8/references/cli-utilities/crdb-cli" >}}), & [other utilities]({{< relref "/operate/rs/7.8/references/cli-utilities" >}})
- [REST API reference]({{< relref "/operate/rs/7.8/references/rest-api" >}}) & [examples]({{< relref "/operate/rs/7.8/references/rest-api/quick-start" >}})
- [Redis commands]({{< relref "/commands" >}})

## Archive

You can use the version selector in the navigation menu to view documentation for Redis Enterprise Software versions 7.4 and later.

To view documentation earlier than version 7.4, see the archived website:

- [Redis Enterprise Software v7.2 documentation archive](https://docs.redis.com/7.2/rs/)

- [Redis Enterprise Software v6.4 documentation archive](https://docs.redis.com/6.4/rs/)

- [Redis Enterprise Software v6.2 documentation archive](https://docs.redis.com/6.2/rs/)

- [Redis Enterprise Software v6.0 documentation archive](https://docs.redis.com/6.0/rs/)


## Related info
- [Redis Cloud]({{< relref "/operate/rc" >}})
- [Redis Community Edition]({{< relref "/operate/oss_and_stack" >}})
- [Redis Stack]({{< relref "/operate/oss_and_stack/stack-with-enterprise" >}})
- [Glossary]({{< relref "/glossary" >}})

## Continue learning with Redis University

See the [Get started with Redis Software learning path](https://university.redis.io/learningpath/an0mgw5bjpjfbe?_gl=1*4gjdoe*_gcl_au*MTkyMTIyOTY3Mi4xNzM5MTk5Mjc4) for courses.
20 changes: 20 additions & 0 deletions content/operate/rs/7.8/clusters/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
Title: Manage clusters
alwaysopen: false
categories:
- docs
- operate
- rs
description: Administrative tasks and information related to the Redis Enterprise
cluster.
hideListLinks: false
linktitle: Clusters
weight: 36
url: '/operate/rs/7.8/clusters/'
---

You can manage your Redis Enterprise Software clusters with several different tools:

- Cluster Manager UI (the web-based user interface)
- Command-line tools ([rladmin]({{< relref "/operate/rs/7.8/references/cli-utilities/rladmin" >}}), [redis-cli]({{< relref "/develop/tools/cli" >}}), [crdb-cli]({{< relref "/operate/rs/7.8/references/cli-utilities/crdb-cli" >}}))
- [REST API]({{< relref "/operate/rs/7.8/references/rest-api/_index.md" >}})
95 changes: 95 additions & 0 deletions content/operate/rs/7.8/clusters/add-node.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
---
Title: Add a node
alwaysopen: false
categories:
- docs
- operate
- rs
description: Add a node to your existing Redis Enterprise cluster.
linktitle: Add a node
weight: 20
url: '/operate/rs/7.8/clusters/add-node/'
---
When you install Redis Enterprise Software on the first node of a cluster, you create the new cluster.
After you install the first node, you can add more nodes to the cluster.

## Prerequisites

Before you add a node to the cluster:

- The clocks on all nodes must always be [synchronized]({{< relref "/operate/rs/7.8/clusters/configure/sync-clocks.md" >}}).

If the clock in the node you are trying to join to the cluster is not synchronized with the nodes already in the cluster,
the action fails and an error message is shown indicating that you must synchronize the clocks first.

- You must [update the DNS records]({{< relref "/operate/rs/7.8/networking/cluster-dns" >}})
each time a node is added or replaced.

- We recommend that you add nodes one after the other rather than in parallel
to avoid errors that occur because the connection to the other nodes in the cluster cannot be verified.

## Add node

To add a node to an existing cluster:

1. [Install the Redis Enterprise Software installation package]({{< relref "/operate/rs/7.8/installing-upgrading" >}}) on a clean installation
of a [supported operating system]({{< relref "/operate/rs/7.8/installing-upgrading/install/plan-deployment/supported-platforms.md" >}}).

1. To connect to the Cluster Manager UI of the new Redis Enterprise Software installation, go to: <https://URL or IP address:8443>

For example, if you installed Redis Enterprise Software on a machine with IP address 10.0.1.34, go to `https://10.0.1.34:8443`.

{{< tip >}}
The management UI uses TLS encryption with a default certificate.
You can also [replace the TLS certificate]({{< relref "/operate/rs/7.8/security/certificates/updating-certificates" >}})
with a custom certificate.
{{< /tip >}}

1. Select **Join cluster**.

1. For **Cluster identification**, enter the internal IP address or DNS name of a node that is a cluster member.

If the node only has one IP address, enter that IP address.

1. For **Cluster sign in**, enter the credentials of the cluster administrator.

The cluster administrator is the user account that you create when you configure the first node in the cluster.

1. Click **Next**.

1. Configure storage and network settings:

1. Enter a path for [*Ephemeral storage*]({{< relref "/operate/rs/7.8/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}), or leave the default path.

1. Enter a path for [*Persistent storage*]({{< relref "/operate/rs/7.8/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}),
or leave the default path.

1. To enable [*Auto Tiering*]({{< relref "/operate/rs/7.8/databases/auto-tiering/" >}}),
select **Enable flash storage** and enter the path to the flash storage.

1. If the cluster is configured to support [rack-zone awareness]({{< relref "/operate/rs/7.8/clusters/configure/rack-zone-awareness.md" >}}), set the **Rack-zone ID** for the new node.

1. If your machine has multiple IP addresses, assign a single IPv4 type address for **Node-to-node communication (internal traffic)** and multiple IPv4/IPv6 type addresses for **External traffic**.

1. Select **Join cluster**.

The node is added to the cluster.
You can see it in the list of nodes in the cluster.

If you see an error when you add the node, try adding the node again.

## Verify node

We recommend that you verify the node is functioning properly using one of the following methods:

- Cluster Manager UI method:

1. On the **Nodes** screen, click {{< image filename="/images/rs/buttons/button-toggle-actions-vertical.png#no-click" alt="More actions button" width="22px" class="inline" >}} for the node you want to verify.

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

{{<image filename="images/rs/screenshots/nodes/secondary-nodes-more-actions.png" alt="Click the more actions button for a node to access node actions.">}}

- Command-line method:

Run the [`rlcheck`]({{< relref "/operate/rs/7.8/references/cli-utilities/rlcheck" >}}) utility from the node's command line.
48 changes: 48 additions & 0 deletions content/operate/rs/7.8/clusters/change-node-role.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
Title: Change node roles
alwaysopen: false
categories:
- docs
- operate
- rs
description: Change node roles to demote the primary node to a secondary node or promote a secondary node to become the primary node.
linkTitle: Change node roles
weight: 65
url: '/operate/rs/7.8/clusters/change-node-role/'
---

A Redis Software cluster contains a primary node, which coordinates cluster-wide management operations, and multiple secondary nodes. Nodes with either role can host database shards.

## Demote primary node

To demote the primary node to a secondary node using the Cluster Manager UI:

1. On the **Nodes** screen, click {{< image filename="/images/rs/buttons/button-toggle-actions-vertical.png#no-click" alt="More actions button" width="22px" class="inline" >}} for the node you want to promote.

{{<image filename="images/rs/screenshots/nodes/primary-node-more-actions.png" alt="Click the more actions button for a node to access node actions.">}}

1. Select **Set as a secondary node** from the list.

1. Select one of the options to determine the new primary node:

- **Automatically**: The cluster decides which node becomes the new primary node.

- **Choose specific node**: You can manually select which node becomes the new primary node.

{{<image filename="images/rs/screenshots/nodes/primary-node-set-as-secondary-dialog.png" alt="The Set as a secondary node dialog has two options to select the new primary node, either automatically or manually.">}}

1. Click **Confirm**.

## Promote secondary node

To promote a secondary node to become the primary node using the Cluster Manager UI:

1. On the **Nodes** screen, click {{< image filename="/images/rs/buttons/button-toggle-actions-vertical.png#no-click" alt="More actions button" width="22px" class="inline" >}} for the node you want to promote.

{{<image filename="images/rs/screenshots/nodes/secondary-nodes-more-actions.png" alt="Click the more actions button for a node to access node actions.">}}

1. Select **Set as the primary node** from the list.

1. Click **Confirm**.

After this node becomes the primary node, all cluster management traffic is directed to it.
115 changes: 115 additions & 0 deletions content/operate/rs/7.8/clusters/cluster-recovery.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
---
Title: Recover a failed cluster
alwaysopen: false
categories:
- docs
- operate
- rs
description: How to use the cluster configuration file and database data to recover
a failed cluster.
linktitle: Recover a cluster
weight: 70
url: '/operate/rs/7.8/clusters/cluster-recovery/'
---
When a Redis Enterprise Software cluster fails,
you must use the cluster configuration file and database data to recover the cluster.

{{< note >}}
For cluster recovery in a Kubernetes deployment, see [Recover a Redis Enterprise cluster on Kubernetes]({{< relref "/operate/kubernetes/re-clusters/cluster-recovery" >}}).
{{< /note >}}

Cluster failure can be caused by:

- A hardware or software failure that causes the cluster to be unresponsive to client requests or administrative actions.
- More than half of the cluster nodes lose connection with the cluster, resulting in quorum loss.

To recover a cluster and re-create it as it was before the failure,
you must restore the cluster configuration `ccs-redis.rdb` to the cluster nodes.
To recover databases in the new cluster, you must restore the databases from persistence files such as backup files, append-only files (AOF), or RDB snapshots.
These files are stored in the [persistent storage location]({{< relref "/operate/rs/7.8/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}).

The cluster recovery process includes:

1. Install Redis Enterprise Software on the nodes of the new cluster.
1. Mount the persistent storage with the recovery files from the original cluster to the nodes of the new cluster.
1. Recover the cluster configuration on the first node in the new cluster.
1. Join the remaining nodes to the new cluster.
1. [Recover the databases]({{< relref "/operate/rs/7.8/databases/recover.md" >}}).

## Prerequisites

- We recommend that you recover the cluster to clean nodes.
If you use the original nodes,
make sure there are no Redis processes running on any nodes in the new cluster.
- We recommend that you use clean persistent storage drives for the new cluster.
If you use the original storage drives,
make sure you back up the files on the original storage drives to a safe location.
- Identify the cluster configuration file that you want to use as the configuration for the recovered cluster.
The cluster configuration file is `/css/ccs-redis.rdb` on the persistent storage for each node.

## Recover the cluster

1. (Optional) If you want to recover the cluster to the original cluster nodes, uninstall Redis Enterprise Software from the nodes.

1. [Install Redis Enterprise Software]({{< relref "/operate/rs/7.8/installing-upgrading/install/install-on-linux" >}}) on the new cluster nodes.

The new servers must have the same basic hardware and software configuration as the original servers, including:

- The same number of nodes
- At least the same amount of memory
- The same Redis Enterprise Software version
- The same installation user and paths

{{< note >}}
The cluster recovery can fail if these requirements are not met.
{{< /note >}}

1. Mount the persistent storage drives with the recovery files to the new nodes.
These drives must contain the cluster configuration backup files and database persistence files.

{{< note >}}
Make sure that the user redislabs has permissions to access the storage location
of the configuration and persistence files on each of the nodes.
{{< /note >}}

If you use local persistent storage, place all of the recovery files on each of the cluster nodes.

1. To recover the original cluster configuration, run [`rladmin cluster recover`]({{< relref "/operate/rs/7.8/references/cli-utilities/rladmin/cluster/recover" >}}) on the first node in the new cluster:

```sh
rladmin cluster recover filename [ <persistent_path> | <ephemeral_path> ]<filename> node_uid <node_uid> rack_id <rack_id>
```

For example:

```sh
rladmin cluster recover filename /tmp/persist/ccs/ccs-redis.rdb node_uid 1 rack_id 5
```

When the recovery command succeeds,
this node is configured as the node from the old cluster that has ID 1.

1. To join the remaining servers to the new cluster, run [`rladmin cluster join`]({{< relref "/operate/rs/7.8/references/cli-utilities/rladmin/cluster/join" >}}) from each new node:

```sh
rladmin cluster join nodes <cluster_member_ip_address> username <username> password <password> replace_node <node_id>
```

For example:

```sh
rladmin cluster join nodes 10.142.0.4 username [email protected] password mysecret replace_node 2
```

1. Run [`rladmin status`]({{< relref "/operate/rs/7.8/references/cli-utilities/rladmin/status" >}}) to verify the recovered nodes are now active and the databases are pending recovery:

```sh
rladmin status
```

{{< note >}}
Make sure that you update your [DNS records]({{< relref "/operate/rs/7.8/networking/cluster-dns" >}})
with the IP addresses of the new nodes.
{{< /note >}}

After the cluster is recovered, you must [recover the databases]({{< relref "/operate/rs/7.8/databases/recover.md" >}}).
21 changes: 21 additions & 0 deletions content/operate/rs/7.8/clusters/configure/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
Title: Configure clusters
alwaysopen: false
categories:
- docs
- operate
- rs
description: Configuration options for your Redis Enterprise cluster.
hideListLinks: false
linktitle: Configure
weight: 50
url: '/operate/rs/7.8/clusters/configure/'
---
You can manage your Redis Enterprise Software clusters with several different tools:

- Cluster Manager UI (the web-based user interface)
- Command-line tools ([rladmin]({{< relref "/operate/rs/7.8/references/cli-utilities/rladmin" >}}), [redis-cli]({{< relref "/develop/tools/cli" >}}), [crdb-cli]({{< relref "/operate/rs/7.8/references/cli-utilities/crdb-cli" >}}))
- [REST API]({{< relref "/operate/rs/7.8/references/rest-api/_index.md" >}})



Loading