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 17 commits into
base: main
Choose a base branch
from
Open
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
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion content/operate/rs/7.4/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Build a small-scale cluster with the Redis Enterprise Software container image.
[Install & set up]({{< relref "/operate/rs/7.4/installing-upgrading" >}}) a Redis Enterprise Software cluster.
- [Networking]({{< relref "/operate/rs/7.4/networking" >}})
- [Set up]({{< relref "/operate/rs/7.4/clusters/new-cluster-setup" >}}) & [configure]({{< relref "/operate/rs/7.4/clusters/configure" >}}) a [cluster]({{< relref "/operate/rs/7.4/clusters" >}})
- [Release notes]({{< relref "/operate/rs/release-notes" >}})
- [Release notes](https://redis.io/docs/latest/operate/rs/release-notes/)

## Databases
Create and manage a [Redis database]({{< relref "/operate/rs/7.4/databases" >}}) on a cluster.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Rack-zone awareness affects various cluster, node, and database actions, such as
The rack-zone ID must comply with the following rules:

- Maximum length of 63 characters.
- Characters consist of letters, digits, and hyphens ('-'). Underscores ('_') are also accepted as of Redis Enterprise Software [6.4.2-61]({{< relref "/operate/rs/release-notes/rs-6-4-2-releases/rs-6-4-2-61" >}}).
- Characters consist of letters, digits, and hyphens ('-'). Underscores ('_') are also accepted as of Redis Enterprise Software 6.4.2-61.
- ID starts with a letter and ends with a letter or a digit.

{{< note >}}
Expand Down
22 changes: 17 additions & 5 deletions content/operate/rs/7.4/databases/import-export/export-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,13 +161,25 @@ To export data to an [Amazon Web Services](https://aws.amazon.com/) (AWS) Simple

- In the **Secret access key** field, enter the secret access key.

You can also connect to a storage service that uses the S3 protocol but is not hosted by Amazon AWS. The storage service must have a valid SSL certificate. To connect to an S3-compatible storage location, run [`rladmin cluster config`]({{<relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config">}}):
You can also connect to a storage service that uses the S3 protocol but is not hosted by Amazon AWS. The storage service must have a valid SSL certificate.

```sh
rladmin cluster config s3_url <URL>
```
To connect to an S3-compatible storage location:

1. Configure the S3 URL with [`rladmin cluster config`]({{<relref "/operate/rs/references/cli-utilities/rladmin/cluster/config">}}):

```sh
rladmin cluster config s3_url <URL>
```

Replace `<URL>` with the hostname or IP address of the S3-compatible storage location.

1. Configure the S3 CA certificate:

```sh
rladmin cluster config s3_ca_cert <filepath>
```

Replace `<URL>` with the hostname or IP address of the S3-compatible storage location.
Replace `<filepath>` with the location of the S3 CA certificate `ca.pem`.

### Google Cloud Storage

Expand Down
22 changes: 17 additions & 5 deletions content/operate/rs/7.4/databases/import-export/import-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,13 +156,25 @@ In the Redis Enterprise Software Cluster Manager UI, when you enter the export l

- In the **Secret access key** field, enter the secret access key.

You can also connect to a storage service that uses the S3 protocol but is not hosted by Amazon AWS. The storage service must have a valid SSL certificate. To connect to an S3-compatible storage location, run [`rladmin cluster config`]({{<relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config">}}):
You can also connect to a storage service that uses the S3 protocol but is not hosted by Amazon AWS. The storage service must have a valid SSL certificate.

```sh
rladmin cluster config s3_url <URL>
```
To connect to an S3-compatible storage location:

1. Configure the S3 URL with [`rladmin cluster config`]({{<relref "/operate/rs/references/cli-utilities/rladmin/cluster/config">}}):

```sh
rladmin cluster config s3_url <URL>
```

Replace `<URL>` with the hostname or IP address of the S3-compatible storage location.

1. Configure the S3 CA certificate:

```sh
rladmin cluster config s3_ca_cert <filepath>
```

Replace `<URL>` with the hostname or IP address of the S3-compatible storage location.
Replace `<filepath>` with the location of the S3 CA certificate `ca.pem`.

### Google Cloud Storage

Expand Down
22 changes: 17 additions & 5 deletions content/operate/rs/7.4/databases/import-export/schedule-backups.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,13 +210,25 @@ To store backups in an Amazon Web Services (AWS) Simple Storage Service (S3) [bu

- In the **Secret Access Key** field, enter the secret access key.

You can also connect to a storage service that uses the S3 protocol but is not hosted by Amazon AWS. The storage service must have a valid SSL certificate. To connect to an S3-compatible storage location, run [`rladmin cluster config`]({{<relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config">}}):
You can also connect to a storage service that uses the S3 protocol but is not hosted by Amazon AWS. The storage service must have a valid SSL certificate.

```sh
rladmin cluster config s3_url <URL>
```
To connect to an S3-compatible storage location:

1. Configure the S3 URL with [`rladmin cluster config`]({{<relref "/operate/rs/references/cli-utilities/rladmin/cluster/config">}}):

```sh
rladmin cluster config s3_url <URL>
```

Replace `<URL>` with the hostname or IP address of the S3-compatible storage location.

1. Configure the S3 CA certificate:

```sh
rladmin cluster config s3_ca_cert <filepath>
```

Replace `<URL>` with the hostname or IP address of the S3-compatible storage location.
Replace `<filepath>` with the location of the S3 CA certificate `ca.pem`.

### Google Cloud Storage

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Before upgrading a cluster:

- Verify access to [rlcheck]({{< relref "/operate/rs/7.4/references/cli-utilities/rlcheck/" >}}) and [rladmin]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/#use-the-rladmin-shell" >}}) commands

- Verify that you meet the upgrade path requirements for your desired cluster version and review the relevant [release notes]({{< relref "/operate/rs/release-notes" >}}) for any preparation instructions.
- Verify that you meet the upgrade path requirements for your desired cluster version and review the relevant [release notes](https://redis.io/docs/latest/operate/rs/release-notes/) for any preparation instructions.

- Avoid changing the database configuration or performing other cluster management operations during the upgrade process, as this might cause unexpected results.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The upgrade policy is only relevant for Redis Enterprise Software versions 6.2.4

Before upgrading a database:

- Review the relevant [release notes]({{< relref "/operate/rs/release-notes" >}}) for any preparation instructions.
- Review the relevant [release notes](https://redis.io/docs/latest/operate/rs/release-notes/) for any preparation instructions.

- Verify that the database version meets the minimums specified earlier.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Before you upgrade a cluster's operating system:

1. If the cluster contains databases that use modules:

1. Update all nodes in the cluster to [Redis Enterprise Software version 7.2.4-52]({{< relref "/operate/rs/release-notes/rs-7-2-4-releases" >}}) or later before you upgrade the OS.
1. Update all nodes in the cluster to [Redis Enterprise Software version 7.2.4-52](https://redis.io/docs/latest/operate/rs/release-notes/rs-7-2-4-releases) or later before you upgrade the OS.

1. Check the status of modules using [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}):

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ An API object that represents the cluster.
| proxy_max_ccs_disconnection_time | integer | Cluster-wide proxy timeout policy between proxy and CCS |
| rack_aware | boolean | Cluster operates in a rack-aware mode (read-only) |
| reserved_ports | array of strings | List of reserved ports and/or port ranges to avoid using for database endpoints (for example `"reserved_ports": ["11000", "13000-13010"]`) |
| s3_ca_cert | string | Filepath to the PEM-encoded CA certificate to use for validating TLS connections to the S3 server |
| s3_url | string | Specifies the URL for S3 export and import |
| saslauthd_ldap_conf | string | saslauthd LDAP configuration |
| sentinel_cipher_suites | array | Specifies the list of enabled ciphers for the sentinel service. The supported ciphers are those implemented by the [cipher_suites.go](<https://golang.org/src/crypto/tls/cipher_suites.go>) package. |
Expand Down
16 changes: 0 additions & 16 deletions content/operate/rs/7.4/release-notes/_index.md

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ weight: 55
url: '/operate/rs/7.4/security/access-control/ldap/migrate-to-role-based-ldap/'
---

Redis Enterprise Software supports LDAP through a [role-based mechanism]({{< relref "/operate/rs/7.4/security/access-control/ldap/" >}}), first introduced [in v6.0.20]({{< relref "/operate/rs/release-notes/rs-6-0-20-april-2021" >}}).
Redis Enterprise Software supports LDAP through a [role-based mechanism]({{< relref "/operate/rs/7.4/security/access-control/ldap/" >}}), first introduced in v6.0.20.

Earlier versions of Redis Enterprise Software supported a cluster-based mechanism; however, that mechanism was removed in v6.2.12.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ You can renew these certificates by replacing them with new self-signed certific

## Renew self-signed certificates

As of [v6.2.18-70]({{< relref "/operate/rs/release-notes/rs-6-2-18-releases/rs-6-2-18-70" >}}), Redis Enterprise Software includes a script to generate self-signed certificates.
As of v6.2.18-70, Redis Enterprise Software includes a script to generate self-signed certificates.

By default, the `generate_self_signed_certs.sh` script is located in `/opt/redislabs/utils/`.

Expand Down
84 changes: 84 additions & 0 deletions content/operate/rs/7.8/_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.8
url: '/operate/rs/7.8/'
bannerText: This documentation applies to Redis Software versions 7.8.x.
bannerChildren: true
---

[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](https://redis.io/docs/latest/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.
Loading