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

Merged
merged 34 commits into from
May 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 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
39d0ed6
DOC-5232 RS: Copied ccs directory typo fix for cluster recovery to 7.…
rrelledge May 12, 2025
e604e1d
Merge branch 'main' into DOC-4928
rrelledge May 12, 2025
6bd199a
DOC-4692 RS: Copied certificate-based authentication to 7.8 version
rrelledge May 12, 2025
c922045
DOC-5159 Copy update DNS step for rolling upgrades to RS 7.8 and 7.4 …
rrelledge May 16, 2025
b884862
DOC-5216 Copied additional bigstore_enabled details to 7.8 version
rrelledge May 16, 2025
148ccd7
Fixed some versioned RS links
rrelledge May 16, 2025
a90ec81
Copied Redis Open Source name to RS 7.8 version
rrelledge May 16, 2025
c2c5492
Merge branch 'main' into DOC-4928
rrelledge May 16, 2025
1cce357
Merge branch 'main' into DOC-4928
rrelledge May 19, 2025
a7e5e6e
Copied updated configure proxy policy REST API example with endpoint …
rrelledge May 19, 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
  •  
  •  
  •  
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
2 changes: 1 addition & 1 deletion content/operate/rs/7.4/databases/auto-tiering/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Redis Enterprise’s auto tiering is based on a high-performance storage engine

Just like all-RAM databases, databases with Auto Tiering enabled are compatible with existing Redis applications.

Auto Tiering is also supported on [Redis Cloud]({{< relref "/operate/rc/" >}}) and [Redis Enterprise Software for Kubernetes]({{< relref "/operate/rs/" >}}).
Auto Tiering is also supported on [Redis Cloud]({{< relref "/operate/rc/" >}}) and [Redis Enterprise Software for Kubernetes]({{< relref "/operate/kubernetes/" >}}).

## Use cases

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/7.4/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/7.4/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/7.4/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 Expand Up @@ -79,6 +79,8 @@ To upgrade the cluster's operating system, use one of the following rolling upgr

1. [Add the new node]({{< relref "/operate/rs/7.4/clusters/add-node" >}}) to the cluster.

1. If the [cluster uses DNS]({{<relref "/operate/rs/7.4/networking/cluster-dns">}}), add the new node’s IP address to the DNS records.

1. [Remove one node]({{< relref "/operate/rs/7.4/clusters/remove-node#remove-a-node" >}}) running the earlier OS version from the cluster.

1. Repeat the previous steps until all nodes with the earlier OS version are removed.
Expand All @@ -105,6 +107,8 @@ To upgrade the cluster's operating system, use one of the following rolling upgr
rladmin cluster join nodes <cluster_member_ip_address> username <username> password <password> replace_node <node_id>
```

1. If the [cluster uses DNS]({{<relref "/operate/rs/7.4/networking/cluster-dns">}}), add the new node’s IP address to the DNS records.

1. Verify node health:

1. Run `rlcheck` on all nodes:
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 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.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" >}})
Loading