Skip to content

Commit e932096

Browse files
RS: Add RS 7.8 versioned docs (#1351)
* DOC-4928 RS: Add RS 7.8 versioned docs * DOC-4928 Removed duplicate aliases from 7.8 versioned docs * DOC-4928 Added missing prometheus metrics references to RS 7.8 versioned docs * DOC-4928 Added missing networking docs to RS 7.8 versioned docs * DOC-4928 Added missing v1 monitoring doc to RS 7.8 versioned docs * Fix versioned relrefs * DOC-4928 Added 7.8 version banner * DOC-5034 Copy missing job_scheduler REST API references to RS v7.8 * Fixed links to RS release notes in versioned docs * DOC-3605 Copy support package CM UI options to RS 7.8 version * DOC-4986 Copy rladmin cluster config s3_ca_cert step to import/export/backup DB in 7.4/7.8 versions * Copy certificate landing page edits to RS v7.8 docs * Copied required_version bootstrap API deprecation to RS v7.8 docs * Copied fix for broken download center link to RS 7.8 version * DOC-5216 Copied bigstore_enabled to RS 7.8 node REST API reference * DOC-5232 RS: Copied ccs directory typo fix for cluster recovery to 7.8 version * DOC-4692 RS: Copied certificate-based authentication to 7.8 version * DOC-5159 Copy update DNS step for rolling upgrades to RS 7.8 and 7.4 versions * DOC-5216 Copied additional bigstore_enabled details to 7.8 version * Fixed some versioned RS links * Copied Redis Open Source name to RS 7.8 version * Copied updated configure proxy policy REST API example with endpoint to RS 7.8 version --------- Co-authored-by: paoloredis <paolo.lazzari@redis.com>
1 parent 2b9b249 commit e932096

File tree

449 files changed

+40760
-55
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

449 files changed

+40760
-55
lines changed

content/operate/rs/7.4/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Build a small-scale cluster with the Redis Enterprise Software container image.
3636
[Install & set up]({{< relref "/operate/rs/7.4/installing-upgrading" >}}) a Redis Enterprise Software cluster.
3737
- [Networking]({{< relref "/operate/rs/7.4/networking" >}})
3838
- [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" >}})
39-
- [Release notes]({{< relref "/operate/rs/release-notes" >}})
39+
- [Release notes](https://redis.io/docs/latest/operate/rs/release-notes/)
4040

4141
## Databases
4242
Create and manage a [Redis database]({{< relref "/operate/rs/7.4/databases" >}}) on a cluster.

content/operate/rs/7.4/clusters/configure/rack-zone-awareness.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Rack-zone awareness affects various cluster, node, and database actions, such as
3131
The rack-zone ID must comply with the following rules:
3232

3333
- Maximum length of 63 characters.
34-
- 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" >}}).
34+
- Characters consist of letters, digits, and hyphens ('-'). Underscores ('_') are also accepted as of Redis Enterprise Software 6.4.2-61.
3535
- ID starts with a letter and ends with a letter or a digit.
3636

3737
{{< note >}}

content/operate/rs/7.4/databases/auto-tiering/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Redis Enterprise’s auto tiering is based on a high-performance storage engine
2424

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

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

2929
## Use cases
3030

content/operate/rs/7.4/databases/import-export/export-data.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -161,13 +161,25 @@ To export data to an [Amazon Web Services](https://aws.amazon.com/) (AWS) Simple
161161

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

164-
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">}}):
164+
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.
165165

166-
```sh
167-
rladmin cluster config s3_url <URL>
168-
```
166+
To connect to an S3-compatible storage location:
167+
168+
1. Configure the S3 URL with [`rladmin cluster config`]({{<relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config">}}):
169+
170+
```sh
171+
rladmin cluster config s3_url <URL>
172+
```
173+
174+
Replace `<URL>` with the hostname or IP address of the S3-compatible storage location.
175+
176+
1. Configure the S3 CA certificate:
177+
178+
```sh
179+
rladmin cluster config s3_ca_cert <filepath>
180+
```
169181

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

172184
### Google Cloud Storage
173185

content/operate/rs/7.4/databases/import-export/import-data.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -156,13 +156,25 @@ In the Redis Enterprise Software Cluster Manager UI, when you enter the export l
156156

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

159-
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">}}):
159+
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.
160160

161-
```sh
162-
rladmin cluster config s3_url <URL>
163-
```
161+
To connect to an S3-compatible storage location:
162+
163+
1. Configure the S3 URL with [`rladmin cluster config`]({{<relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config">}}):
164+
165+
```sh
166+
rladmin cluster config s3_url <URL>
167+
```
168+
169+
Replace `<URL>` with the hostname or IP address of the S3-compatible storage location.
170+
171+
1. Configure the S3 CA certificate:
172+
173+
```sh
174+
rladmin cluster config s3_ca_cert <filepath>
175+
```
164176

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

167179
### Google Cloud Storage
168180

content/operate/rs/7.4/databases/import-export/schedule-backups.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -210,13 +210,25 @@ To store backups in an Amazon Web Services (AWS) Simple Storage Service (S3) [bu
210210

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

213-
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">}}):
213+
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.
214214

215-
```sh
216-
rladmin cluster config s3_url <URL>
217-
```
215+
To connect to an S3-compatible storage location:
216+
217+
1. Configure the S3 URL with [`rladmin cluster config`]({{<relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config">}}):
218+
219+
```sh
220+
rladmin cluster config s3_url <URL>
221+
```
222+
223+
Replace `<URL>` with the hostname or IP address of the S3-compatible storage location.
224+
225+
1. Configure the S3 CA certificate:
226+
227+
```sh
228+
rladmin cluster config s3_ca_cert <filepath>
229+
```
218230

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

221233
### Google Cloud Storage
222234

content/operate/rs/7.4/installing-upgrading/upgrading/upgrade-cluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Before upgrading a cluster:
2323

2424
- 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
2525

26-
- 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.
26+
- 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.
2727

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

content/operate/rs/7.4/installing-upgrading/upgrading/upgrade-database.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The upgrade policy is only relevant for Redis Enterprise Software versions 6.2.4
4040

4141
Before upgrading a database:
4242

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

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

content/operate/rs/7.4/installing-upgrading/upgrading/upgrade-os.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Before you upgrade a cluster's operating system:
2525

2626
1. If the cluster contains databases that use modules:
2727

28-
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.
28+
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.
2929

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

@@ -79,6 +79,8 @@ To upgrade the cluster's operating system, use one of the following rolling upgr
7979

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

82+
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.
83+
8284
1. [Remove one node]({{< relref "/operate/rs/7.4/clusters/remove-node#remove-a-node" >}}) running the earlier OS version from the cluster.
8385

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

110+
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.
111+
108112
1. Verify node health:
109113

110114
1. Run `rlcheck` on all nodes:

content/operate/rs/7.4/references/rest-api/objects/cluster/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ An API object that represents the cluster.
5555
| proxy_max_ccs_disconnection_time | integer | Cluster-wide proxy timeout policy between proxy and CCS |
5656
| rack_aware | boolean | Cluster operates in a rack-aware mode (read-only) |
5757
| 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"]`) |
58+
| s3_ca_cert | string | Filepath to the PEM-encoded CA certificate to use for validating TLS connections to the S3 server |
5859
| s3_url | string | Specifies the URL for S3 export and import |
5960
| saslauthd_ldap_conf | string | saslauthd LDAP configuration |
6061
| 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. |

content/operate/rs/7.4/release-notes/_index.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

content/operate/rs/7.4/release-notes/legacy-release-notes/_index.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

content/operate/rs/7.4/security/access-control/ldap/migrate-to-role-based-ldap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ weight: 55
1111
url: '/operate/rs/7.4/security/access-control/ldap/migrate-to-role-based-ldap/'
1212
---
1313

14-
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" >}}).
14+
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.
1515

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

content/operate/rs/7.4/security/certificates/create-certificates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ You can renew these certificates by replacing them with new self-signed certific
1717

1818
## Renew self-signed certificates
1919

20-
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.
20+
As of v6.2.18-70, Redis Enterprise Software includes a script to generate self-signed certificates.
2121

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

content/operate/rs/7.8/_index.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
Title: Redis Enterprise Software
3+
alwaysopen: false
4+
categories:
5+
- docs
6+
- operate
7+
- rs
8+
description: The self-managed, enterprise-grade version of Redis.
9+
hideListLinks: true
10+
weight: 10
11+
linkTitle: 7.8
12+
url: '/operate/rs/7.8/'
13+
bannerText: This documentation applies to Redis Software versions 7.8.x.
14+
bannerChildren: true
15+
---
16+
17+
[Redis Enterprise](https://redis.io/enterprise/) is a self-managed, enterprise-grade version of Redis.
18+
19+
With Redis Enterprise, you get many enterprise-grade capabilities, including:
20+
- Linear scalability
21+
- High availability, backups, and recovery
22+
- Predictable performance
23+
- 24/7 support
24+
25+
You can run self-managed Redis Enterprise Software in an on-premises data center or on your preferred cloud platform.
26+
27+
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.
28+
29+
## Get started
30+
Build a small-scale cluster with the Redis Enterprise Software container image.
31+
- [Linux quickstart]({{< relref "/operate/rs/7.8/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}})
32+
- [Docker quickstart]({{< relref "/operate/rs/7.8/installing-upgrading/quickstarts/docker-quickstart" >}})
33+
- [Get started with Active-Active]({{< relref "/operate/rs/7.8/databases/active-active/get-started" >}})
34+
35+
## Install & setup
36+
[Install & set up]({{< relref "/operate/rs/7.8/installing-upgrading" >}}) a Redis Enterprise Software cluster.
37+
- [Networking]({{< relref "/operate/rs/7.8/networking" >}})
38+
- [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" >}})
39+
- [Release notes](https://redis.io/docs/latest/operate/rs/release-notes/)
40+
41+
## Databases
42+
Create and manage a [Redis database]({{< relref "/operate/rs/7.8/databases" >}}) on a cluster.
43+
- [Create a Redis Enterprise Software database]({{< relref "/operate/rs/7.8/databases/create" >}})
44+
- [Configure database]({{< relref "/operate/rs/7.8/databases/configure" >}})
45+
- [Create Active-Active database]({{< relref "/operate/rs/7.8/databases/active-active/create" >}})
46+
- [Edit Active-Active database]({{< relref "/operate/rs/7.8/databases/active-active/manage.md" >}})
47+
48+
## Security
49+
[Manage secure connections]({{< relref "/operate/rs/7.8/security" >}}) to the cluster and databases.
50+
- [Access control]({{< relref "/operate/rs/7.8/security/access-control" >}})
51+
- [Users]({{< relref "/operate/rs/7.8/security/access-control/manage-users" >}}) & [roles]({{< relref "/operate/rs/7.8/security/access-control" >}})
52+
- [Certificates]({{< relref "/operate/rs/7.8/security/certificates" >}})
53+
- [TLS]({{< relref "/operate/rs/7.8/security/encryption/tls" >}}) & [Encryption]({{< relref "/operate/rs/7.8/security/encryption" >}})
54+
55+
## Reference
56+
Use command-line utilities and the REST API to manage the cluster and databases.
57+
- [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" >}})
58+
- [REST API reference]({{< relref "/operate/rs/7.8/references/rest-api" >}}) & [examples]({{< relref "/operate/rs/7.8/references/rest-api/quick-start" >}})
59+
- [Redis commands]({{< relref "/commands" >}})
60+
61+
## Archive
62+
63+
You can use the version selector in the navigation menu to view documentation for Redis Enterprise Software versions 7.4 and later.
64+
65+
To view documentation earlier than version 7.4, see the archived website:
66+
67+
- [Redis Enterprise Software v7.2 documentation archive](https://docs.redis.com/7.2/rs/)
68+
69+
- [Redis Enterprise Software v6.4 documentation archive](https://docs.redis.com/6.4/rs/)
70+
71+
- [Redis Enterprise Software v6.2 documentation archive](https://docs.redis.com/6.2/rs/)
72+
73+
- [Redis Enterprise Software v6.0 documentation archive](https://docs.redis.com/6.0/rs/)
74+
75+
76+
## Related info
77+
- [Redis Cloud]({{< relref "/operate/rc" >}})
78+
- [Redis Open Source]({{< relref "/operate/oss_and_stack" >}})
79+
- [Redis Stack]({{< relref "/operate/oss_and_stack/stack-with-enterprise" >}})
80+
- [Glossary]({{< relref "/glossary" >}})
81+
82+
## Continue learning with Redis University
83+
84+
See the [Get started with Redis Software learning path](https://university.redis.io/learningpath/an0mgw5bjpjfbe?_gl=1*4gjdoe*_gcl_au*MTkyMTIyOTY3Mi4xNzM5MTk5Mjc4) for courses.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
Title: Manage clusters
3+
alwaysopen: false
4+
categories:
5+
- docs
6+
- operate
7+
- rs
8+
description: Administrative tasks and information related to the Redis Enterprise
9+
cluster.
10+
hideListLinks: false
11+
linktitle: Clusters
12+
weight: 36
13+
url: '/operate/rs/7.8/clusters/'
14+
---
15+
16+
You can manage your Redis Enterprise Software clusters with several different tools:
17+
18+
- Cluster Manager UI (the web-based user interface)
19+
- 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" >}}))
20+
- [REST API]({{< relref "/operate/rs/7.8/references/rest-api/_index.md" >}})

0 commit comments

Comments
 (0)