Skip to content

Commit 8464e68

Browse files
authored
RS 7.22 version selector (#2279)
* DOC-3077 RS 7.22 version selector * Added flash aliases to RS 7.22 auto tiering docs * DOC-3077 Reran version selector script to fix some 7.22 URLs
1 parent 7bde631 commit 8464e68

File tree

447 files changed

+43141
-0
lines changed

Some content is hidden

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

447 files changed

+43141
-0
lines changed

content/operate/rs/7.22/_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.22
12+
bannerText: This documentation applies to version 7.22.
13+
bannerChildren: true
14+
url: '/operate/rs/7.22/'
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.22/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}})
32+
- [Docker quickstart]({{< relref "/operate/rs/7.22/installing-upgrading/quickstarts/docker-quickstart" >}})
33+
- [Get started with Active-Active]({{< relref "/operate/rs/7.22/databases/active-active/get-started" >}})
34+
35+
## Install & setup
36+
[Install & set up]({{< relref "/operate/rs/7.22/installing-upgrading" >}}) a Redis Enterprise Software cluster.
37+
- [Networking]({{< relref "/operate/rs/7.22/networking" >}})
38+
- [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" >}})
39+
- [Release notes]({{< relref "/operate/rs/release-notes" >}})
40+
41+
## Databases
42+
Create and manage a [Redis database]({{< relref "/operate/rs/7.22/databases" >}}) on a cluster.
43+
- [Create a Redis Enterprise Software database]({{< relref "/operate/rs/7.22/databases/create" >}})
44+
- [Configure database]({{< relref "/operate/rs/7.22/databases/configure" >}})
45+
- [Create Active-Active database]({{< relref "/operate/rs/7.22/databases/active-active/create" >}})
46+
- [Edit Active-Active database]({{< relref "/operate/rs/7.22/databases/active-active/manage.md" >}})
47+
48+
## Security
49+
[Manage secure connections]({{< relref "/operate/rs/7.22/security" >}}) to the cluster and databases.
50+
- [Access control]({{< relref "/operate/rs/7.22/security/access-control" >}})
51+
- [Users]({{< relref "/operate/rs/7.22/security/access-control/manage-users" >}}) & [roles]({{< relref "/operate/rs/7.22/security/access-control" >}})
52+
- [Certificates]({{< relref "/operate/rs/7.22/security/certificates" >}})
53+
- [TLS]({{< relref "/operate/rs/7.22/security/encryption/tls" >}}) & [Encryption]({{< relref "/operate/rs/7.22/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.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" >}})
58+
- [REST API reference]({{< relref "/operate/rs/7.22/references/rest-api" >}}) & [examples]({{< relref "/operate/rs/7.22/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.22/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.22/references/cli-utilities/rladmin" >}}), [redis-cli]({{< relref "/develop/tools/cli" >}}), [crdb-cli]({{< relref "/operate/rs/7.22/references/cli-utilities/crdb-cli" >}}))
20+
- [REST API]({{< relref "/operate/rs/7.22/references/rest-api/_index.md" >}})
Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
---
2+
Title: Add a node
3+
alwaysopen: false
4+
categories:
5+
- docs
6+
- operate
7+
- rs
8+
description: Add a node to your existing Redis Enterprise cluster.
9+
linktitle: Add a node
10+
weight: 20
11+
url: '/operate/rs/7.22/clusters/add-node/'
12+
---
13+
When you install Redis Enterprise Software on the first node of a cluster, you create the new cluster.
14+
After you install the first node, you can add more nodes to the cluster.
15+
16+
## Prerequisites
17+
18+
Before you add a node to the cluster:
19+
20+
- The clocks on all nodes must always be [synchronized]({{< relref "/operate/rs/7.22/clusters/configure/sync-clocks.md" >}}).
21+
22+
If the clock in the node you are trying to join to the cluster is not synchronized with the nodes already in the cluster,
23+
the action fails and an error message is shown indicating that you must synchronize the clocks first.
24+
25+
- You must [update the DNS records]({{< relref "/operate/rs/7.22/networking/cluster-dns" >}})
26+
each time a node is added or replaced.
27+
28+
- We recommend that you add nodes one after the other rather than in parallel
29+
to avoid errors that occur because the connection to the other nodes in the cluster cannot be verified.
30+
31+
## Add node
32+
33+
To add a node to an existing cluster:
34+
35+
1. [Install the Redis Enterprise Software installation package]({{< relref "/operate/rs/7.22/installing-upgrading" >}}) on a clean installation
36+
of a [supported operating system]({{< relref "/operate/rs/7.22/installing-upgrading/install/plan-deployment/supported-platforms.md" >}}).
37+
38+
1. To connect to the Cluster Manager UI of the new Redis Enterprise Software installation, go to: <https://URL or IP address:8443>
39+
40+
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`.
41+
42+
{{< tip >}}
43+
The management UI uses TLS encryption with a default certificate.
44+
You can also [replace the TLS certificate]({{< relref "/operate/rs/7.22/security/certificates/updating-certificates" >}})
45+
with a custom certificate.
46+
{{< /tip >}}
47+
48+
1. Select **Join cluster**.
49+
50+
1. For **Cluster identification**, enter the internal IP address or DNS name of a node that is a cluster member.
51+
52+
If the node only has one IP address, enter that IP address.
53+
54+
1. For **Cluster sign in**, enter the credentials of the cluster administrator.
55+
56+
The cluster administrator is the user account that you create when you configure the first node in the cluster.
57+
58+
1. Click **Next**.
59+
60+
1. Configure storage and network settings:
61+
62+
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.
63+
64+
1. Enter a path for [*Persistent storage*]({{< relref "/operate/rs/7.22/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}),
65+
or leave the default path.
66+
67+
1. To enable [*Auto Tiering*]({{< relref "/operate/rs/7.22/databases/auto-tiering/" >}}),
68+
select **Enable flash storage** and enter the path to the flash storage.
69+
70+
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.
71+
72+
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**.
73+
74+
1. Select **Join cluster**.
75+
76+
The node is added to the cluster.
77+
You can see it in the list of nodes in the cluster.
78+
79+
If you see an error when you add the node, try adding the node again.
80+
81+
## Verify node
82+
83+
We recommend that you verify the node is functioning properly using one of the following methods:
84+
85+
- Cluster Manager UI method:
86+
87+
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.
88+
89+
1. Select **Verify node** from the list.
90+
91+
{{<image filename="images/rs/screenshots/nodes/secondary-nodes-more-actions.png" alt="Click the more actions button for a node to access node actions.">}}
92+
93+
- Command-line method:
94+
95+
Run the [`rlcheck`]({{< relref "/operate/rs/7.22/references/cli-utilities/rlcheck" >}}) utility from the node's command line.
Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
---
2+
Title: Change node roles
3+
alwaysopen: false
4+
categories:
5+
- docs
6+
- operate
7+
- rs
8+
description: Change node roles to demote the primary node to a secondary node or promote a secondary node to become the primary node.
9+
linkTitle: Change node roles
10+
weight: 65
11+
url: '/operate/rs/7.22/clusters/change-node-role/'
12+
---
13+
14+
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.
15+
16+
## Demote primary node
17+
18+
{{< multitabs id="demote-node"
19+
tab1="Cluster Manager UI"
20+
tab2="rladmin" >}}
21+
22+
To demote the primary node to a secondary node using the Cluster Manager UI:
23+
24+
1. On the **Nodes** screen, click the **More actions** button (**&vellip;**) for the primary node you want to demote.
25+
26+
<img src="../../../../images/rs/screenshots/nodes/primary-node-more-actions.png" alt="Click the more actions button for a node to access node actions.">
27+
28+
1. Select **Set as a secondary node** from the list.
29+
30+
1. Select one of the options to determine the new primary node:
31+
32+
- **Automatically**: The cluster decides which node becomes the new primary node.
33+
34+
- **Choose specific node**: You can manually select which node becomes the new primary node.
35+
36+
<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.">
37+
38+
1. Click **Confirm**.
39+
40+
-tab-sep-
41+
42+
To demote the primary node to a secondary node using `rladmin`:
43+
44+
1. Identify the primary node's ID with [`rladmin cluster master`]({{<relref "/operate/rs/7.22/references/cli-utilities/rladmin/cluster/master">}}):
45+
46+
```sh
47+
$ rladmin cluster master
48+
Node <primary-node-id> is the cluster master node
49+
```
50+
51+
1. Run [`rladmin node enslave`]({{<relref "/operate/rs/7.22/references/cli-utilities/rladmin/node/enslave/#node-enslave">}}) with the `demote_node` option:
52+
53+
```sh
54+
rladmin node <primary-node-ID> enslave demote_node
55+
```
56+
57+
Replace `<primary-node-ID>` with the ID returned by `rladmin cluster master`.
58+
59+
{{< /multitabs >}}
60+
61+
## Promote secondary node
62+
63+
{{< multitabs id="promote-node"
64+
tab1="Cluster Manager UI"
65+
tab2="rladmin" >}}
66+
67+
To promote a secondary node to become the primary node using the Cluster Manager UI:
68+
69+
1. On the **Nodes** screen, click the **More actions** button (**&vellip;**) for the secondary node you want to promote.
70+
71+
<img src="../../../../images/rs/screenshots/nodes/secondary-nodes-more-actions.png" alt="Click the more actions button for a node to access node actions.">
72+
73+
1. Select **Set as the primary node** from the list.
74+
75+
1. Click **Confirm**.
76+
77+
78+
-tab-sep-
79+
80+
To promote a secondary node to become the primary node using `rladmin`:
81+
82+
1. To find the IDs of secondary nodes, run [`rladmin status nodes`]({{<relref "/operate/rs/7.22/references/cli-utilities/rladmin/status#status-nodes">}}):
83+
84+
```sh
85+
$ rladmin status nodes
86+
CLUSTER NODES:
87+
NODE:ID ROLE ADDRESS EXTERNAL_ADDRESS HOSTNAME SHARDS CORES FREE_RAM PROVISIONAL_RAM VERSION STATUS
88+
node:1 master 198.51.100.2 3d99db1fdf4b 4/100 6 14.74GB/19.54GB 10.73GB/16.02GB 7.22.0-250 OK
89+
*node:3 slave 198.51.100.4 b87cc06c830f 0/100 6 14.74GB/19.54GB 11.22GB/16.02GB 7.22.0-250 OK
90+
node:2 slave 198.51.100.3 fc7a3d332458 0/100 6 14.74GB/19.54GB 11.22GB/16.02GB 7.22.0-250 OK
91+
```
92+
93+
Nodes with the `slave` role are secondary nodes.
94+
95+
1. Run [`rladmin cluster master set`]({{<relref "/operate/rs/7.22/references/cli-utilities/rladmin/cluster/master">}}):
96+
97+
```sh
98+
rladmin cluster master set <secondary-node-ID>
99+
```
100+
101+
Replace `<secondary-node-ID>` with the ID of the secondary node you want to promote.
102+
103+
{{< /multitabs >}}
104+
105+
After this node becomes the primary node, all cluster management traffic is directed to it.

0 commit comments

Comments
 (0)