Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
  •  
  •  
  •  
64 changes: 64 additions & 0 deletions content/operate/rs/7.4/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
Title: Redis Enterprise Software
alwaysopen: false
categories:
- docs
- operate
- rs
description: The self-managed, enterprise-grade version of Redis.
hideListLinks: true
weight: 10
url: '/operate/rs/7.4/'
linkTitle: 7.4
---

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

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

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

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

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

## 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" >}})

20 changes: 20 additions & 0 deletions content/operate/rs/7.4/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.4/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/references/cli-utilities/rladmin" >}}), [redis-cli]({{< relref "/develop/connect/cli" >}}), [crdb-cli]({{< relref "/operate/rs/references/cli-utilities/crdb-cli" >}}))
- [REST API]({{< relref "/operate/rs/references/rest-api/_index.md" >}})
82 changes: 82 additions & 0 deletions content/operate/rs/7.4/clusters/add-node.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
Title: Add a cluster 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.4/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.

{{< note >}}
Before you add a node to the cluster:

- The clocks on all nodes must always be [synchronized]({{< relref "/operate/rs/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/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.
{{< /note >}}

To add a node to an existing cluster:

1. [Install the Redis Enterprise Software installation package]({{< relref "/operate/rs/installing-upgrading" >}}) on a clean installation
of a [supported operating system]({{< relref "/operate/rs/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/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/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}), or leave the default path.

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

1. To enable [*Auto Tiering*]({{< relref "/operate/rs/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/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.

{{< tip >}}
We recommend that you run the [rlcheck utility]({{< relref "/operate/rs/references/cli-utilities/rlcheck" >}}) to verify that the node is functioning properly.
{{< /tip >}}

115 changes: 115 additions & 0 deletions content/operate/rs/7.4/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.4/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/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/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/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/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/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/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/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/databases/recover.md" >}}).
21 changes: 21 additions & 0 deletions content/operate/rs/7.4/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.4/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/references/cli-utilities/rladmin" >}}), [redis-cli]({{< relref "/develop/connect/cli" >}}), [crdb-cli]({{< relref "/operate/rs/references/cli-utilities/crdb-cli" >}}))
- [REST API]({{< relref "/operate/rs/references/rest-api/_index.md" >}})



64 changes: 64 additions & 0 deletions content/operate/rs/7.4/clusters/configure/cluster-settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
Title: Cluster settings
alwaysopen: false
categories:
- docs
- operate
- rs
description: You can view and set various cluster settings such as cluster name, email
service, time zone, and license.
linktitle: Cluster settings
toc: 'true'
weight: 10
url: '/operate/rs/7.4/clusters/configure/cluster-settings/'
---
You can view and set various cluster settings, such as cluster name, email service, time zone, and license, on the **Cluster > Configuration** page.

## General configuration tab

### Upload cluster license key

After purchasing a cluster license and if your account has the "Admin" role,
you can upload the cluster license key, either during initial
cluster creation or at any time afterward. The license key defines various
cluster settings, such as the maximum number of shards you can have in
the cluster. For more detailed information see [Cluster license
keys]({{< relref "/operate/rs/clusters/configure/license-keys.md" >}}).

### View max number of allowed shards

The maximum number of allowed shards, which is determined by the cluster license
key, appears in the **Max number of shards** field in the **License** section.

### View cluster name

The cluster name appears in the **Cluster name** field in the **License** section. This gives a
common name that your team or Redis support can refer to. It is
especially helpful if you have multiple clusters.

### Set time zone

You can change the **Time zone** field to ensure the date, time fields, and log entries in the Cluster Manager UI are shown in your preferred time zone. This setting doesn't affect other system logs or services.

## Alert settings tab

The **Alert Settings** tab lets you configure alerts that are relevant to the entire cluster, such as alerts for cluster utilization, nodes, node utilization, security, and database utilization.

You can also configure email server settings and [send alerts by email]({{< relref "/operate/rs/clusters/monitoring#send-alerts-by-email" >}}) to relevant users.

### Configure email server settings

To enable email alerts:

1. Enter your email
server details in the **Email server settings** section.

1. Select a connection security method:

- TLS/SSL

- STARTTLS

- None

1. Send a test email to verify your email server settings.
Loading
Loading