Skip to content

Commit d9a5a21

Browse files
rrelledgerrelledge
authored
RS: Added missing networking docs back to 7.4 version (#1333)
* DOC-5045 RS: Added missing networking docs back to 7.4 version * DOC-5045 RS: Fixing 7.4 relrefs
1 parent 7857d00 commit d9a5a21

File tree

5 files changed

+277
-4
lines changed

5 files changed

+277
-4
lines changed

‎content/operate/rs/7.4/databases/configure/proxy-policy.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -138,8 +138,7 @@ When the network on a single active proxy becomes the bottleneck,
138138
you might also look into enabling the multiple NIC support in RS. With
139139
nodes that have multiple physical NICs (Network Interface Cards), you
140140
can configure RS to separate internal and external traffic onto
141-
independent physical NICs. For more details, refer to [Multi-IP &
142-
IPv6]({{< relref "/operate/rs/networking/multi-ip-ipv6.md" >}}).
141+
independent physical NICs. For more details, refer to [Manage IP addresses]({{< relref "/operate/rs/networking/multi-ip-ipv6" >}}).
143142
{{< /note >}}
144143

145144
Having multiple proxies for a database can improve RS's ability for fast

‎content/operate/rs/7.4/networking/configuring-aws-route53-dns-redis-enterprise.md

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
Title: AWS Route53 DNS management
3+
alwaysopen: false
4+
categories:
5+
- docs
6+
- operate
7+
- rs
8+
description: How to configure AWS Route 53 DNS
9+
linkTitle: AWS Route 53 DNS
10+
weight: $weight
11+
url: '/operate/rs/7.4/networking/configuring-aws-route53-dns-redis-enterprise/'
12+
---
13+
14+
Redis Enterprise Software uses DNS to achieve high availability and fail-over regardless of where it is installed.
15+
16+
17+
## What is AWS Route 53?
18+
19+
Route 53 is a scalable DNS service by Amazon Web Service (AWS). It routes user traffic to AWS resources and external sites, offering DNS health checks, traffic management, and failover capabilities. It's integral for high-availability architectures and also provides domain registration services.
20+
21+
## Create a hosted zone
22+
23+
Creating a hosted zone in Amazon Route 53 is a foundational step in managing your domain's DNS settings.
24+
25+
A hosted zone functions as a container for the DNS records of a specific domain. To create one, you first need to:
26+
27+
1. Log into the AWS Management Console
28+
2. Navigate to the Route 53 dashboard
29+
3. Select "Create Hosted Zone"
30+
4. Enter your domain name, and choose public hosted zone
31+
32+
The hosted zone provides you with a set of Name Server (NS) records, which you will need to update at your domain registrar. This process effectively delegates the DNS management of your domain to Route 53, allowing you to create, update, and manage DNS records for your domain within the AWS ecosystem.
33+
34+
{{< image filename="/images/rs/00-CreateHostedZone-en.png" >}}
35+
36+
Once created, it will appear in the list of **Hosted zones**
37+
38+
{{< image filename="/images/rs/03-HostedZoneSelection-en.png" >}}
39+
40+
## Create glue records
41+
42+
A **glue record** is a type of DNS record that helps prevent circular dependencies by providing the IP addresses of your nameservers. To create glue records in Route 53, you first need to set up a hosted zone for your domain. You will create a separate A record for each node in your Redis Enterprise cluster. The **Record name** will be a subdomain definition of the NS record you will define and the **value** should be set to the IP address of the node in your cluster.
43+
44+
{{< image filename="/images/rs/05-NS1Configuration-en.png" >}}
45+
46+
Once complete, it should look something like this
47+
48+
{{< image filename="/images/rs/06-NSList-en.png" >}}
49+
50+
51+
## Create nameserver record
52+
53+
When you create a new hosted zone in Route 53 for your domain, a set of NS records is automatically generated. These records list the nameservers assigned by Route 53 to your domain.
54+
55+
You will need to create a new NS record which will point to the glue records created in the previous step.
56+
57+
{{<note>}}
58+
It is important to make sure that the **Record Name** of the NS record equals the FQDN (Fully Qualified Domain Name) of your Redis Enterprise cluster. If not, DNS resolution will not function correctly.
59+
{{</note>}}
60+
61+
{{< image filename="/images/rs/07-NSRecord-en.png" >}}
62+
63+
64+
## Validate
65+
66+
Once all steps are completed, the configuration should look similar to this
67+
68+
{{< image filename="/images/rs/08-FinalConfig-en.png" >}}
69+
70+
You can test and validate your settings by using the ```dig``` command.
71+
72+
```sh
73+
dig ns test.demo-rlec.redislabs.com
74+
75+
; <<>> DiG 9.9.5-9+deb8u9-Debian <<>> ns test.demo-rlec.redislabs.com
76+
;; global options: +cmd
77+
;; Got answer:
78+
;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 25061
79+
;; flags: qr rd ra; QUERY: 1, ANSWER: 3, AUTHORITY: 0, ADDITIONAL: 1
80+
81+
;; OPT PSEUDOSECTION:
82+
; EDNS: version: 0, flags:; udp: 4096
83+
;; QUESTION SECTION:
84+
;test.demo-rlec.redislabs.com. IN NS
85+
86+
;; ANSWER SECTION:
87+
test.demo-rlec.redislabs.com. 3409 IN NS node2.test.demo-rlec.redislabs.com.
88+
test.demo-rlec.redislabs.com. 3409 IN NS node1.test.demo-rlec.redislabs.com.
89+
test.demo-rlec.redislabs.com. 3409 IN NS node3.test.demo-rlec.redislabs.com.
90+
91+
;; Query time: 31 msec
92+
;; SERVER: 192.168.1.254#53(192.168.1.254)
93+
;; WHEN: Tue Feb 14 16:49:13 CET 2017
94+
;; MSG SIZE rcvd: 120
95+
```
96+
97+
You can see that the name are given a prefix of `ns-`. This answer does not come
98+
from *Route53* but from the cluster nameservers themselves.
99+

‎content/operate/rs/7.4/networking/mdns.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ To prepare a client or node for mDNS:
4747
$ service avahi-daemon start
4848
```
4949

50-
1. If you are using [mDNS with IPv6 addresses]({{< relref "/operate/rs/networking/multi-ip-ipv6.md" >}}),
50+
1. If you are using [mDNS with IPv6 addresses]({{< relref "/operate/rs/networking/multi-ip-ipv6" >}}),
5151
update the hosts line in `/etc/nsswitch.conf` to:
5252

5353
```yaml

‎content/operate/rs/7.4/networking/multi-ip-ipv6.md

+175
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
---
2+
Title: Manage IP addresses
3+
alwaysopen: false
4+
categories:
5+
- docs
6+
- operate
7+
- rs
8+
description: Information and requirements for using multiple IP addresses or IPv6 addresses with Redis Enterprise Software.
9+
linkTitle: Manage IP addresses
10+
weight: $weight
11+
url: '/operate/rs/7.4/networking/multi-ip-ipv6/'
12+
---
13+
14+
Redis Enterprise Software supports servers, instances, and VMs with
15+
multiple IPv4 or IPv6 addresses.
16+
17+
## Traffic overview
18+
19+
Redis Enterprise Software traffic is divided into internal traffic and external traffic:
20+
21+
- "Internal traffic" refers to internal cluster communications, such as communications between the nodes for cluster management.
22+
23+
- "External traffic" refers to communications between clients and databases and connections to the Cluster Manager UI.
24+
25+
When only one IP address exists on a machine that serves as a Redis Enterprise node, it is used for both internal and external traffic.
26+
27+
## Multiple IP addresses
28+
29+
During node configuration on a machine with multiple IP addresses, you must assign one address for internal traffic and one or more other addresses for external traffic.
30+
31+
If the cluster uses IPv4 for internal traffic, all communication between cluster nodes uses IPv4 addresses. If the cluster uses IPv6 for internal traffic, all communication between cluster nodes uses IPv6 addresses.
32+
33+
To update IP address configuration after cluster setup, see [Change internal IP address](#change-internal-ip-address) or [Configure external IP addresses](#configure-external-ip-addresses).
34+
35+
## Enable IPv6 for internal traffic
36+
37+
IPv6 for internal communication is supported only for new clusters with Redis Enterprise Software version 7.4.2 or later.
38+
39+
If the server has only IPv6 interfaces, IPv6 is automatically used for internal and external traffic. Otherwise, internal traffic uses IPv4 by default.
40+
41+
To use IPv6 for internal traffic on a machine with both IPv4 and IPv6 interfaces, set `use_internal_ipv6` to `true` when you create a cluster using the [bootstrap REST API request]({{< relref "/operate/rs/references/rest-api/requests/bootstrap#post-bootstrap" >}}):
42+
43+
```sh
44+
POST /v1/bootstrap/create_cluster
45+
{
46+
"action": "create_cluster",
47+
"cluster": {
48+
"name": "cluster.fqdn"
49+
},
50+
"credentials": {
51+
"username": "admin_username",
52+
"password": "admin_password"
53+
},
54+
"node": {
55+
"identity": {
56+
"addr": "2001:DB8::/32",
57+
"external_addr": ["2001:0db8:85a3:0000:0000:8a2e:0370:7334"],
58+
"use_internal_ipv6": true
59+
},
60+
},
61+
...
62+
}
63+
```
64+
65+
When other IPv6 nodes join a cluster that has `use_internal_ipv6` enabled, they automatically use IPv6 for internal traffic. Do not manually set `use_internal_ipv6` when joining a node to an existing IPv6 cluster, or a `NodeBootstrapError` can occur if the values do not match.
66+
67+
If you try to add a node without an IPv6 interface to a cluster that has `use_internal_ipv6` enabled, a `NodeBootstrapError` occurs.
68+
69+
The host file `/etc/hosts` on each node in the cluster must include the following entry:
70+
71+
```sh
72+
::1 localhost
73+
```
74+
75+
## Change internal IP address
76+
77+
Before you change an internal IP address, consider the following:
78+
79+
- Verify the address is valid and bound to an active interface on the node. Failure to do so prevents the node from coming back online and rejoining the cluster.
80+
81+
- Joining a node that only has IPv4 network interfaces to a master node with IPv6 enabled causes a `NodeBootstrapError`.
82+
83+
- Joining a node that only has IPv6 network interfaces to a master node that does not have IPv6 enabled causes a `NodeBootstrapError`.
84+
85+
- You cannot change the internal address from IPv4 to IPv6 or IPv6 to IPv4 in a running cluster. You can only change the internal address within the same protocol as the cluster.
86+
87+
If you need to update the internal IP address in the OS, one option is to remove that node from the cluster, change the IP address, and then add the node back into the cluster.
88+
89+
Alternatively, you can use the following steps to update a node's internal IP address without removing it from the cluster:
90+
91+
1. Turn the node into a replica using [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin/node/enslave" >}}):
92+
93+
```sh
94+
rladmin node <ID> enslave demote_node
95+
```
96+
97+
1. Deactivate the `rlec_supervisor` service on the node:
98+
99+
```sh
100+
systemctl disable rlec_supervisor
101+
```
102+
103+
1. Restart the node.
104+
105+
1. Follow the operating system vendor's instructions to change the node's IP address.
106+
107+
1. From a different cluster node, use [`rladmin node addr set`]({{< relref "/operate/rs/references/cli-utilities/rladmin/node/addr" >}}) to update the first node's IP address:
108+
109+
```sh
110+
rladmin node <ID> addr set <IP address>
111+
```
112+
113+
1. Enable the `rlec_supervisor` service on the node:
114+
115+
```sh
116+
systemctl enable rlec_supervisor
117+
```
118+
119+
1. Restart `rlec_supervisor` or restart the node.
120+
121+
122+
```sh
123+
systemctl start rlec_supervisor
124+
```
125+
126+
1. Verify the node rejoined the cluster:
127+
128+
```sh
129+
rladmin status nodes
130+
```
131+
132+
Repeat this procedure for other cluster nodes to change their internal IP addresses.
133+
134+
## Configure external IP addresses
135+
136+
You can configure external addresses that are not bound to an active interface, but are otherwise mapped or configured to route traffic to the node (such as AWS Elastic IPs or a load balancer VIP).
137+
138+
You can use [rladmin node external_addr]({{< relref "/operate/rs/references/cli-utilities/rladmin/node/external-addr" >}}) to change a node's external IP addresses.
139+
140+
Add an external IP address:
141+
142+
```sh
143+
rladmin node <ID> external_addr add <IP address>
144+
```
145+
146+
Set one or more external IP addresses:
147+
148+
```sh
149+
rladmin node <ID> external_addr set <IP address 1> <IP address N>
150+
```
151+
152+
153+
Remove an external IP address:
154+
155+
```sh
156+
rladmin node <ID> external_addr remove <IP address>
157+
```
158+
159+
{{< note >}}
160+
While [joining a new node to a
161+
cluster]({{< relref "/operate/rs/clusters/add-node.md" >}})
162+
during the node bootstrap process,
163+
when prompted to provide an IP of an existing node in the cluster,
164+
if you use the node's IP, provide the node's internal IP address.
165+
{{< /note >}}
166+
167+
## Known limitations
168+
169+
- Using IPv6 for internal traffic is supported only for new clusters running Redis Enterprise Software version 7.4.2 or later.
170+
171+
- Changing an existing cluster's internal traffic from IPv4 to IPv6 is not supported.
172+
173+
- All nodes must use the same protocol for internal traffic.
174+
175+
- If a Redis Enterprise node's host machine has both IPv4 and IPv6 addresses, internal communication within the node initially uses IPv4 until the bootstrap process finishes.

‎content/operate/rs/7.4/networking/private-public-endpoints.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: "Enable private and\_public database endpoints"
1111
weight: $weight
1212
url: '/operate/rs/7.4/networking/private-public-endpoints/'
1313
---
14-
Each node in Redis Enterprise can be configured with [private and external IP addresses]({{< relref "/operate/rs/networking/multi-ip-ipv6.md" >}}). By default, Redis Enterprise Software databases expose a single endpoint, e.g. cluster.com (FQDN), using the external IP addresses, making it available to the public network (e.g. the internet). Additionally, the cluster can be configured to expose a private FQDN, which utilizes the private IP addresses for access from the private network only (e.g. VPC or an internal network).
14+
Each node in Redis Enterprise can be configured with [private and external IP addresses]({{< relref "/operate/rs/networking/multi-ip-ipv6" >}}). By default, Redis Enterprise Software databases expose a single endpoint, e.g. cluster.com (FQDN), using the external IP addresses, making it available to the public network (e.g. the internet). Additionally, the cluster can be configured to expose a private FQDN, which utilizes the private IP addresses for access from the private network only (e.g. VPC or an internal network).
1515

1616
When you create a cluster via the UI, you can configure it to expose private and public endpoints.
1717
This is common for environments such as cloud platforms and enterprises.

0 commit comments

Comments
 (0)