Merge pull request #556 from redis/DOC-4133-ports-details

DOC-4133 added details of RDI ports

Author: andy-stark-redis

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

@@ -34,16 +34,16 @@ You must run the RDI installer as a privileged user because it installs
 [containerd](https://containerd.io/) and registers services. However, you don't
 need any special privileges to run RDI processes for normal operation.
 
-The [K3s](https://k3s.io/) Kubernetes distribution used internally by RDI has a few
+RDI has a few
 requirements for cloud VMs that you must implement before running the
 RDI installer, or else installation will fail. The following sections
-give full pre-installation instructions for [RHEL](#k3s-rhel) and
-[Ubuntu](#k3s-ubuntu).
+give full pre-installation instructions for [RHEL](#firewall-rhel) and
+[Ubuntu](#firewall-ubuntu).
 
-### RHEL {#k3s-rhel}
+### RHEL {#firewall-rhel}
 
-K3s recommends that you turn off 
-[`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)
+We recommend you turn off
+[`firewalld`](https://firewalld.org/documentation/)
 before installation using the command:
 
 ```bash
@@ -59,10 +59,19 @@ firewall-cmd --permanent --zone=trusted --add-source=10.43.0.0/16 #services
 firewall-cmd --reload
 ```
 
-You may also need to open other ports if your setup requires them. See the K3s
-[Inbound rules](https://docs.k3s.io/installation/requirements?_highlight=red&_highlight=hat&os=rhel#inbound-rules-for-k3s-nodes)
-docs for more information. If you change the default CIDR for pods or services,
-you must update the firewall rules accordingly.
+You should also add [port rules](https://firewalld.org/documentation/howto/open-a-port-or-service.html)
+for all the [RDI services]({{< relref "/integrate/redis-data-integration/ingest/reference/ports" >}})
+you intend to use:
+
+```bash
+firewall-cmd --permanent --add-port=8080/tcp  # (Required) rdi-operator/rdi-api
+firewall-cmd --permanent --add-port=9090/tcp  # vm-dis-reloader
+firewall-cmd --permanent --add-port=9092/tcp  # prometheus-service
+firewall-cmd --permanent --add-port=9121/tcp  # rdi-metric-exporter
+```
+
+{{<note>}}You may also need to add similar rules to open other ports if your setup requires them.
+{{</note>}}
 
 If you have `nm-cloud-setup.service` enabled, you must disable it and reboot the
 node with the following commands:
@@ -72,14 +81,9 @@ systemctl disable nm-cloud-setup.service nm-cloud-setup.timer
 reboot
 ```
 
-See
-[Rancher support and maintenance terms](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions/rancher-v2-8-6/)
-for more information about the OS versions that have been tested with
-Rancher-managed K3s clusters.
+### Ubuntu {#firewall-ubuntu}
 
-### Ubuntu {#k3s-ubuntu}
-
-K3s recommends that you turn off
+We recommend you turn off
 [Uncomplicated Firewall](https://wiki.ubuntu.com/UncomplicatedFirewall) (`ufw`)
 before installation with the command:
 
@@ -95,15 +99,19 @@ ufw allow from 10.42.0.0/16 to any #pods
 ufw allow from 10.43.0.0/16 to any #services
 ```
 
-You may also need to open other ports if your setup requires them. See the K3s
-[Inbound rules](https://docs.k3s.io/installation/requirements?_highlight=red&_highlight=hat&os=debian#inbound-rules-for-k3s-nodes)
-docs for more information. If you change the default CIDR for pods or services,
-you must update the firewall rules accordingly.
+You should also add [port rules](https://ubuntu.com/server/docs/firewalls)
+for all the [RDI services]({{< relref "/integrate/redis-data-integration/ingest/reference/ports" >}})
+you intend to use:
+
+```bash
+ufw allow 8080/tcp  # (Required) rdi-operator/rdi-api
+ufw allow 9090/tcp  # vm-dis-reloader
+ufw allow 9092/tcp  # prometheus-service
+ufw allow 9121/tcp  # rdi-metric-exporter
+```
 
-See
-[Rancher support and maintenance terms](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions/rancher-v2-8-6/)
-for more information about the OS versions that have been tested with
-Rancher-managed K3s clusters.
+{{<note>}}You may also need to add similar rules to open other ports if your setup requires them.
+{{</note>}}
 
 ## Hardware sizing
 

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

@@ -39,7 +39,7 @@ command from the CLI.{{< /note >}}
 
 ## Collector metrics
 
-The endpoint for the collector metrics is `https://<RDI_HOST>/metrics/collector-source`
+The endpoint for the collector metrics is `https://<RDI_HOST>:9121/metrics/collector-source`
 
 These metrics are divided into three groups:
 
@@ -49,7 +49,7 @@ These metrics are divided into three groups:
 
 ## Stream processor metrics
 
-The endpoint for the stream processor metrics is `https://<RDI_HOST>/metrics/rdi`
+The endpoint for the stream processor metrics is `https://<RDI_HOST>:9121/metrics/rdi`
 
 RDI reports metrics during the two main phases of the ingest pipeline, the *snapshot*
 phase and the *change data capture (CDC)* phase. (See the

content/integrate/redis-data-integration/ingest/reference/ports.md

@@ -0,0 +1,33 @@
+---
+Title: RDI ports and protocols
+aliases: null
+alwaysopen: false
+categories:
+  - docs
+  - integrate
+  - rs
+  - rdi
+description: Network ports and protocols used by RDI
+group: di
+linkTitle: Ports and protocols
+summary:
+  Redis Data Integration keeps Redis in sync with the primary database in near
+  real time.
+type: integration
+weight: 40
+---
+
+The table below shows the ports and protocols that RDI uses for its
+services:
+
+| Name | Type | Port | Protocol |
+| :-- | :-- | :-- | :-- |
+| prometheus-service | Service | 9092 | TCP |
+| prometheus-service | Ingress | 9092 | TCP/HTTP |
+| rdi-api | Service | 8080 | TCP |
+| rdi-api | Deployment | 8080 | TCP |
+| rdi-api | Ingress | 8080 | TCP/HTTP |
+| rdi-metric-exporter | Service | 9121 | TCP |
+| rdi-metric-exporter | Ingress | 9121 | TCP/HTTP |
+| rdi-operator | Deployment | 8080 | TCP |
+| vm-dis-reloader | Deployment | 9090 | TCP |