Skip to content

Commit edc23c1

Browse files
DOC-4133 added details of RDI ports
1 parent 7b1a803 commit edc23c1

File tree

3 files changed

+58
-3
lines changed

3 files changed

+58
-3
lines changed

content/integrate/redis-data-integration/ingest/installation/_index.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ give full pre-installation instructions for [RHEL](#k3s-rhel) and
4343
### RHEL {#k3s-rhel}
4444

4545
K3s recommends that you turn off
46-
[`firewalld`](https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/8/html/configuring_and_managing_networking/using-and-configuring-firewalld_configuring-and-managing-networking)
46+
[`firewalld`](https://firewalld.org/documentation/)
4747
before installation using the command:
4848

4949
```bash
@@ -59,6 +59,17 @@ firewall-cmd --permanent --zone=trusted --add-source=10.43.0.0/16 #services
5959
firewall-cmd --reload
6060
```
6161

62+
You should also add [port rules](https://firewalld.org/documentation/howto/open-a-port-or-service.html)
63+
for all the [RDI services]({{< relref "/integrate/redis-data-integration/ingest/reference/ports" >}})
64+
you intend to use:
65+
66+
```bash
67+
firewall-cmd --permanent --add-port=8080/tcp # (Required) rdi-operator/rdi-api
68+
firewall-cmd --permanent --add-port=9090/tcp # vm-dis-reloader
69+
firewall-cmd --permanent --add-port=9092/tcp # prometheus-service
70+
firewall-cmd --permanent --add-port=9121/tcp # rdi-metric-exporter
71+
```
72+
6273
You may also need to open other ports if your setup requires them. See the K3s
6374
[Inbound rules](https://docs.k3s.io/installation/requirements?_highlight=red&_highlight=hat&os=rhel#inbound-rules-for-k3s-nodes)
6475
docs for more information. If you change the default CIDR for pods or services,
@@ -95,6 +106,17 @@ ufw allow from 10.42.0.0/16 to any #pods
95106
ufw allow from 10.43.0.0/16 to any #services
96107
```
97108

109+
You should also add [port rules](https://ubuntu.com/server/docs/firewalls)
110+
for all the [RDI services]({{< relref "/integrate/redis-data-integration/ingest/reference/ports" >}})
111+
you intend to use:
112+
113+
```bash
114+
ufw allow 8080/tcp # (Required) rdi-operator/rdi-api
115+
ufw allow 9090/tcp # vm-dis-reloader
116+
ufw allow 9092/tcp # prometheus-service
117+
ufw allow 9121/tcp # rdi-metric-exporter
118+
```
119+
98120
You may also need to open other ports if your setup requires them. See the K3s
99121
[Inbound rules](https://docs.k3s.io/installation/requirements?_highlight=red&_highlight=hat&os=debian#inbound-rules-for-k3s-nodes)
100122
docs for more information. If you change the default CIDR for pods or services,

content/integrate/redis-data-integration/ingest/observability.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ command from the CLI.{{< /note >}}
3939

4040
## Collector metrics
4141

42-
The endpoint for the collector metrics is `https://<RDI_HOST>/metrics/collector-source`
42+
The endpoint for the collector metrics is `https://<RDI_HOST>:9121/metrics/collector-source`
4343

4444
These metrics are divided into three groups:
4545

@@ -49,7 +49,7 @@ These metrics are divided into three groups:
4949

5050
## Stream processor metrics
5151

52-
The endpoint for the stream processor metrics is `https://<RDI_HOST>/metrics/rdi`
52+
The endpoint for the stream processor metrics is `https://<RDI_HOST>:9121/metrics/rdi`
5353

5454
RDI reports metrics during the two main phases of the ingest pipeline, the *snapshot*
5555
phase and the *change data capture (CDC)* phase. (See the
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
Title: RDI ports and protocols
3+
aliases: null
4+
alwaysopen: false
5+
categories:
6+
- docs
7+
- integrate
8+
- rs
9+
- rdi
10+
description: Network ports and protocols used by RDI
11+
group: di
12+
linkTitle: Ports and protocols
13+
summary:
14+
Redis Data Integration keeps Redis in sync with the primary database in near
15+
real time.
16+
type: integration
17+
weight: 40
18+
---
19+
20+
The table below shows the ports and protocols that RDI uses for its
21+
services:
22+
23+
| Name | Type | Port | Protocol |
24+
| :-- | :-- | :-- | :-- |
25+
| prometheus-service | Service | 9092 | TCP |
26+
| prometheus-service | Ingress | 9092 | TCP/HTTP |
27+
| rdi-api | Service | 8080 | TCP |
28+
| rdi-api | Deployment | 8080 | TCP |
29+
| rdi-api | Ingress | 8080 | TCP/HTTP |
30+
| rdi-metric-exporter | Service | 9121 | TCP |
31+
| rdi-metric-exporter | Ingress | 9121 | TCP/HTTP |
32+
| rdi-operator | Deployment | 8080 | TCP |
33+
| vm-dis-reloader | Deployment | 9090 | TCP |

0 commit comments

Comments
 (0)