Skip to content

Commit

Permalink
DOC-2869 Refactored the port information as a pre-step to adding info…
Browse files Browse the repository at this point in the history
…rmation about AWS and GCP firewall rules.
  • Loading branch information
amberdoctor-redis committed Nov 15, 2023
1 parent 5b51da2 commit 4d6e12c
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 13 deletions.
5 changes: 5 additions & 0 deletions content/embeds/port-availability.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
If ports that Redis assigns to the database are being used by the operating system or other processes, the installation fails.

Follow the relevant sections to configure the minimum required ports.

[Network port configurations]({{< relref "/rs/networking/port-configurations.md" >}}) provides additional details on recommended and optional configurations.
5 changes: 5 additions & 0 deletions content/embeds/port-collision-avoidance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
To avoid port collision, update `/etc/sysctl.conf` to include:

``` sh
net.ipv4.ip_local_port_range = 30000 65535
```
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,12 @@ aliases:

Before [installing Redis Enterprise Software]({{<relref "/rs/installing-upgrading/install">}}), make sure all required ports are available.

## Database ports
{{<embed-md "port-availability.md">}}

Make sure that the ports [Redis assigns to databases]({{< relref "/rs/networking/port-configurations.md" >}}) are available and are not being used by the operating system or other processes.
## Update `sysctl.conf` to avoid port collisions

To avoid port collision, update `/etc/sysctl.conf` to include:
{{<embed-md "port-collision-avoidance.md">}}

``` sh
net.ipv4.ip_local_port_range = 30000 65535
```

## Port 53
## Ubuntu conflicts with port 53

{{<embed-md "port-53.md">}}
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,14 @@ For production environments, see the [install and setup]({{< relref "/rs/install

## Ensure port availability

{{<embed-md "port-availability.md">}}

### Update `sysctl.conf` to avoid port collisions

{{<embed-md "port-collision-avoidance.md">}}

### Ubuntu conflicts with port 53

{{<embed-md "port-53.md">}}

## Install Redis Enterprise Software
Expand Down
24 changes: 19 additions & 5 deletions content/rs/networking/port-configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,9 @@ Redis Enterprise Software's port usage falls into three general categories:
| TCP | 8002, 8004, 8006 | <span title="Configurable">&#x2705; Yes</span> | Internal | Default system health monitoring (envoy admin, envoy management server, gossip envoy admin)|
| TCP | 8444, 9080 | <span title="Not configurable">&#x274c; No</span> | Internal | Traffic between web proxy and cnm_http/cm |

## Change the admin console port
## Changing port configuration

### Change the admin console port

The Redis Enterprise Software admin console uses port 8443, by default. You can change this to a custom port as long as the new port is not in use by another process.

Expand All @@ -57,7 +59,7 @@ rladmin cluster config cm_port <new-port>
After changing the Redis Enterprise Software web UI port, you must connect any new node added to the cluster to the UI with the custom port number:
`https://newnode.mycluster.example.com:`**`<nonstandard-port-number>`**

## Change the envoy ports
### Change the envoy ports

For system health monitoring, Redis uses the following ports by default:

Expand Down Expand Up @@ -90,7 +92,7 @@ $ rladmin cluster config gossip_envoy_admin_port <new-port>
Cluster configured successfully
```

## Change the REST API port
### Change the REST API port

For the REST API, Redis Enterprise Software uses port 9443 (secure) and port 8080 (not secure), by default. You can change this to a custom port as long as the new port is not in use by another process.

Expand All @@ -104,7 +106,19 @@ rladmin cluster config cnm_http_port <new-port>
rladmin cluster config cnm_https_port <new-port>
```

## Require HTTPS for API endpoints
### Ubuntu conflicts with port 53

{{<embed-md "port-53.md">}}


### Update `sysctl.conf` to avoid port collisions

{{<embed-md "port-collision-avoidance.md">}}


## Configuring for HTTPS

### Require HTTPS for API endpoints

By default, the Redis Enterprise Software API supports communication over HTTP and HTTPS. However, you can turn off HTTP support to ensure that API requests are encrypted.

Expand All @@ -119,7 +133,7 @@ rladmin cluster config http_support disabled
After you turn off HTTP support, traffic sent to the unencrypted API endpoint is blocked.


## HTTP to HTTPS redirection
### HTTP to HTTPS redirection
Starting with version 6.0.12, you cannot use automatic HTTP to HTTPS redirection.
To poll metrics from the `metrics_exporter` or to access the admin console, use HTTPS in your request. HTTP requests won't be automatically redirected to HTTPS for those services.

Expand Down

0 comments on commit 4d6e12c

Please sign in to comment.