Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
  •  
  •  
  •  
84 changes: 84 additions & 0 deletions content/operate/rs/7.22/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
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.22
bannerText: This documentation applies to version 7.22.
bannerChildren: true
url: '/operate/rs/7.22/'
---

[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.22/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}})
- [Docker quickstart]({{< relref "/operate/rs/7.22/installing-upgrading/quickstarts/docker-quickstart" >}})
- [Get started with Active-Active]({{< relref "/operate/rs/7.22/databases/active-active/get-started" >}})

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

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

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

## Reference
Use command-line utilities and the REST API to manage the cluster and databases.
- [rladmin]({{< relref "/operate/rs/7.22/references/cli-utilities/rladmin" >}}), [crdb-cli]({{< relref "/operate/rs/7.22/references/cli-utilities/crdb-cli" >}}), & [other utilities]({{< relref "/operate/rs/7.22/references/cli-utilities" >}})
- [REST API reference]({{< relref "/operate/rs/7.22/references/rest-api" >}}) & [examples]({{< relref "/operate/rs/7.22/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 Open Source]({{< 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.22/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.22/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.22/references/cli-utilities/rladmin" >}}), [redis-cli]({{< relref "/develop/tools/cli" >}}), [crdb-cli]({{< relref "/operate/rs/7.22/references/cli-utilities/crdb-cli" >}}))
- [REST API]({{< relref "/operate/rs/7.22/references/rest-api/_index.md" >}})
95 changes: 95 additions & 0 deletions content/operate/rs/7.22/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.22/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.22/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.22/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.22/installing-upgrading" >}}) on a clean installation
of a [supported operating system]({{< relref "/operate/rs/7.22/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.22/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.22/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}), or leave the default path.

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

1. To enable [*Auto Tiering*]({{< relref "/operate/rs/7.22/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.22/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.22/references/cli-utilities/rlcheck" >}}) utility from the node's command line.
105 changes: 105 additions & 0 deletions content/operate/rs/7.22/clusters/change-node-role.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
---
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.22/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

{{< multitabs id="demote-node"
tab1="Cluster Manager UI"
tab2="rladmin" >}}

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

1. On the **Nodes** screen, click the **More actions** button (**&vellip;**) for the primary node you want to demote.

<img src="../../../../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.

<img src="../../../../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**.

-tab-sep-

To demote the primary node to a secondary node using `rladmin`:

1. Identify the primary node's ID with [`rladmin cluster master`]({{<relref "/operate/rs/7.22/references/cli-utilities/rladmin/cluster/master">}}):

```sh
$ rladmin cluster master
Node <primary-node-id> is the cluster master node
```

1. Run [`rladmin node enslave`]({{<relref "/operate/rs/7.22/references/cli-utilities/rladmin/node/enslave/#node-enslave">}}) with the `demote_node` option:

```sh
rladmin node <primary-node-ID> enslave demote_node
```

Replace `<primary-node-ID>` with the ID returned by `rladmin cluster master`.

{{< /multitabs >}}

## Promote secondary node

{{< multitabs id="promote-node"
tab1="Cluster Manager UI"
tab2="rladmin" >}}

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

1. On the **Nodes** screen, click the **More actions** button (**&vellip;**) for the secondary node you want to promote.

<img src="../../../../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**.


-tab-sep-

To promote a secondary node to become the primary node using `rladmin`:

1. To find the IDs of secondary nodes, run [`rladmin status nodes`]({{<relref "/operate/rs/7.22/references/cli-utilities/rladmin/status#status-nodes">}}):

```sh
$ rladmin status nodes
CLUSTER NODES:
NODE:ID ROLE ADDRESS EXTERNAL_ADDRESS HOSTNAME SHARDS CORES FREE_RAM PROVISIONAL_RAM VERSION STATUS
node:1 master 198.51.100.2 3d99db1fdf4b 4/100 6 14.74GB/19.54GB 10.73GB/16.02GB 7.22.0-250 OK
*node:3 slave 198.51.100.4 b87cc06c830f 0/100 6 14.74GB/19.54GB 11.22GB/16.02GB 7.22.0-250 OK
node:2 slave 198.51.100.3 fc7a3d332458 0/100 6 14.74GB/19.54GB 11.22GB/16.02GB 7.22.0-250 OK
```

Nodes with the `slave` role are secondary nodes.

1. Run [`rladmin cluster master set`]({{<relref "/operate/rs/7.22/references/cli-utilities/rladmin/cluster/master">}}):

```sh
rladmin cluster master set <secondary-node-ID>
```

Replace `<secondary-node-ID>` with the ID of the secondary node you want to promote.

{{< /multitabs >}}

After this node becomes the primary node, all cluster management traffic is directed to it.
Loading