From 597ffd6192886c050f7f8ad952d1791f6ac7f448 Mon Sep 17 00:00:00 2001 From: Ward Maddux Date: Tue, 8 Dec 2020 21:12:28 -0700 Subject: [PATCH 1/3] Adds additional default ports needed for firewall rules in a cluster managed by YB Platform. --- .../latest/reference/configuration/default-ports.md | 12 ++++++++++++ .../stable/reference/configuration/default-ports.md | 11 +++++++++++ .../v2.0/reference/configuration/default-ports.md | 9 +++++++++ .../v2.1/reference/configuration/default-ports.md | 11 +++++++++++ 4 files changed, 43 insertions(+) diff --git a/docs/content/latest/reference/configuration/default-ports.md b/docs/content/latest/reference/configuration/default-ports.md index fbd9c9165a7d..0db973f37c5d 100644 --- a/docs/content/latest/reference/configuration/default-ports.md +++ b/docs/content/latest/reference/configuration/default-ports.md @@ -45,6 +45,17 @@ Admin web server UI can be viewed at these addresses. | yb-master | 7000 | [`--webserver_interface 0.0.0.0`](../yb-master/#webserver-interface)
[`--webserver_port 7000`](../yb-master/#webserver-port) | | yb-tserver | 9000 | [`--webserver_interface 0.0.0.0`](../yb-master/#webserver-interface)
[`--webserver_port 9000`](../yb-master/#webserver-port) | +## Firewall Rules +Along with the above, include the following common ports in firewall rules. + +| Service | Port +| ------- | ------------------------- | +| SSH | `tcp:22` | +| HTTP | `tcp:80` | +| HTTPS | `tcp:443` | +| HTTP (alternate) | `tcp:8080` | +| HTTP (Replicated) | `tcp:8800` | + ## Prometheus monitoring YugabyteDB servers expose time-series performance metrics in the [Prometheus exposition format](https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format) on multiple HTTP endpoints. These endpoints have the following structure. @@ -74,4 +85,5 @@ Use the following `yb-tserver` targets for the various API metrics. | ycql | `:12000` | | yedis | `:11000` | + For a quick tutorial on using Prometheus with YugabyteDB, see [Observability with Prometheus](../../../explore/observability). diff --git a/docs/content/stable/reference/configuration/default-ports.md b/docs/content/stable/reference/configuration/default-ports.md index cece6e1ba6c6..01af65fbe470 100644 --- a/docs/content/stable/reference/configuration/default-ports.md +++ b/docs/content/stable/reference/configuration/default-ports.md @@ -43,6 +43,17 @@ Admin web server UI can be viewed at these addresses. | yb-master | 7000 | [`--webserver_interface 0.0.0.0`](../yb-master/#webserver-interface)
[`--webserver_port 7000`](../yb-master/#webserver-port) | | yb-tserver | 9000 | [`--webserver_interface 0.0.0.0`](../yb-master/#webserver-interface)
[`--webserver_port 9000`](../yb-master/#webserver-port) | +## Firewall Rules +Along with the above, include the following common ports in firewall rules. + +| Service | Port +| ------- | ------------------------- | +| SSH | `tcp:22` | +| HTTP | `tcp:80` | +| HTTPS | `tcp:443` | +| HTTP (alternate) | `tcp:8080` | +| HTTP (Replicated) | `tcp:8800` | + ## Prometheus monitoring YugabyteDB servers expose time-series performance metrics in the [Prometheus exposition format](https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format) on multiple HTTP endpoints. These endpoints have the following structure. diff --git a/docs/content/v2.0/reference/configuration/default-ports.md b/docs/content/v2.0/reference/configuration/default-ports.md index ff5242ae3fd9..0210fae53890 100644 --- a/docs/content/v2.0/reference/configuration/default-ports.md +++ b/docs/content/v2.0/reference/configuration/default-ports.md @@ -70,4 +70,13 @@ Admin web server UI can be viewed at these addresses. | yb-master | 7000 | [`--webserver_interface 0.0.0.0`](../yb-master/#webserver-interface)
[`--webserver_port 7000`](../yb-master/#webserver-port) | | yb-tserver | 9000 | [`--webserver_interface 0.0.0.0`](../yb-master/#webserver-interface)
[`--webserver_port 9000`](../yb-master/#webserver-port) | +### Firewall Rules +Along with the above, include the following common ports in firewall rules. +| Service | Port +| ------- | ------------------------- | +| SSH | `tcp:22` | +| HTTP | `tcp:80` | +| HTTPS | `tcp:443` | +| HTTP (alternate) | `tcp:8080` | +| HTTP (Replicated) | `tcp:8800` | diff --git a/docs/content/v2.1/reference/configuration/default-ports.md b/docs/content/v2.1/reference/configuration/default-ports.md index b43f53b96ee0..c22fd7bb2d3f 100644 --- a/docs/content/v2.1/reference/configuration/default-ports.md +++ b/docs/content/v2.1/reference/configuration/default-ports.md @@ -44,6 +44,17 @@ Admin web server UI can be viewed at these addresses. | yb-master | 7000 | [`--webserver_interface 0.0.0.0`](../yb-master/#webserver-interface)
[`--webserver_port 7000`](../yb-master/#webserver-port) | | yb-tserver | 9000 | [`--webserver_interface 0.0.0.0`](../yb-master/#webserver-interface)
[`--webserver_port 9000`](../yb-master/#webserver-port) | +## Firewall Rules +Along with the above, include the following common ports in firewall rules. + +| Service | Port +| ------- | ------------------------- | +| SSH | `tcp:22` | +| HTTP | `tcp:80` | +| HTTPS | `tcp:443` | +| HTTP (alternate) | `tcp:8080` | +| HTTP (Replicated) | `tcp:8800` | + ## Prometheus monitoring YugabyteDB servers expose time-series performance metrics in the [Prometheus exposition format](https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format) on multiple HTTP endpoints. These endpoints have the following structure. From 88991be6a9e7bce6e804aa730fe239fe7b5e2a38 Mon Sep 17 00:00:00 2001 From: wmaddux Date: Mon, 1 Feb 2021 14:35:17 -0700 Subject: [PATCH 2/3] fixup! Adds additional default ports needed for firewall rules in a cluster managed by YB Platform. --- .../reference/configuration/default-ports.md | 12 +++++------ .../reference/configuration/default-ports.md | 20 ++++++++++--------- .../reference/configuration/default-ports.md | 14 +++++++------ .../reference/configuration/default-ports.md | 20 ++++++++++--------- 4 files changed, 36 insertions(+), 30 deletions(-) diff --git a/docs/content/latest/reference/configuration/default-ports.md b/docs/content/latest/reference/configuration/default-ports.md index 0db973f37c5d..e751473693ca 100644 --- a/docs/content/latest/reference/configuration/default-ports.md +++ b/docs/content/latest/reference/configuration/default-ports.md @@ -50,11 +50,11 @@ Along with the above, include the following common ports in firewall rules. | Service | Port | ------- | ------------------------- | -| SSH | `tcp:22` | -| HTTP | `tcp:80` | -| HTTPS | `tcp:443` | -| HTTP (alternate) | `tcp:8080` | -| HTTP (Replicated) | `tcp:8800` | +| SSH | 22 | +| HTTP for Platform | 80 | +| HTTP for Platform (alternate) | 8080 | +| HTTPS for Platform | 443 | +| HTTP for Replicated | 8800 | ## Prometheus monitoring @@ -64,7 +64,7 @@ YugabyteDB servers expose time-series performance metrics in the [Prometheus exp /prometheus-metrics ``` -Following is the list of targets available. +You can access the Prometheus server on port `9090`, and you can see the list of targets at the `http://:9090/targets`. In particular, note port `93000` for node level metrics. ### Servers diff --git a/docs/content/stable/reference/configuration/default-ports.md b/docs/content/stable/reference/configuration/default-ports.md index 01af65fbe470..b33268ee8f05 100644 --- a/docs/content/stable/reference/configuration/default-ports.md +++ b/docs/content/stable/reference/configuration/default-ports.md @@ -48,21 +48,24 @@ Along with the above, include the following common ports in firewall rules. | Service | Port | ------- | ------------------------- | -| SSH | `tcp:22` | -| HTTP | `tcp:80` | -| HTTPS | `tcp:443` | -| HTTP (alternate) | `tcp:8080` | -| HTTP (Replicated) | `tcp:8800` | +| SSH | 22 | +| HTTP for Platform | 80 | +| HTTP for Platform (alternate) | 8080 | +| HTTPS for Platform | 443 | +| HTTP for Replicated | 8800 | -## Prometheus monitoring +## Monitoring with Prometheus -YugabyteDB servers expose time-series performance metrics in the [Prometheus exposition format](https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format) on multiple HTTP endpoints. These endpoints have the following structure. +Use the following targets to configure [Prometheus](https://prometheus.io/) to scrape available metrics (in [Prometheus exposition format](https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format)) from the YugabyteDB HTTP endpoint: ``` /prometheus-metrics ``` -Following is the list of targets available. +You can access the Prometheus server on port `9090` of the Platform node, and you can see the list of targets at the `http://:9090/targets`. In particular, note port `93000` for node level metrics. + +For a quick tutorial on using Prometheus with YugabyteDB, see [Observability with Prometheus](../../../explore/observability). + ### Servers @@ -83,4 +86,3 @@ Use the following `yb-tserver` targets for the various API metrics. | ycql | `:12000` | | yedis | `:11000` | -For a quick tutorial on using Prometheus with YugabyteDB, see [Observability with Prometheus](../../../explore/observability). diff --git a/docs/content/v2.0/reference/configuration/default-ports.md b/docs/content/v2.0/reference/configuration/default-ports.md index 0210fae53890..a8cd1dda4efc 100644 --- a/docs/content/v2.0/reference/configuration/default-ports.md +++ b/docs/content/v2.0/reference/configuration/default-ports.md @@ -28,9 +28,11 @@ Application clients connect to these addresses. Use the following targets to configure [Prometheus](https://prometheus.io/) to scrape available metrics (in [Prometheus exposition format](https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format)) from the YugabyteDB HTTP endpoint: ``` -/prometheus-metrics +/prometheus-metrics ``` +You can access the Prometheus server on port `9090` of the Platform node, and you can see the list of targets at the `http://:9090/targets`. In particular, note port `93000` for node level metrics. + For a quick tutorial on using Prometheus with YugabyteDB, see [Observability with Prometheus](../../../explore/observability). ### Servers @@ -75,8 +77,8 @@ Along with the above, include the following common ports in firewall rules. | Service | Port | ------- | ------------------------- | -| SSH | `tcp:22` | -| HTTP | `tcp:80` | -| HTTPS | `tcp:443` | -| HTTP (alternate) | `tcp:8080` | -| HTTP (Replicated) | `tcp:8800` | +| SSH | 22 | +| HTTP for Platform | 80 | +| HTTP for Platform (alternate) | 8080 | +| HTTPS for Platform | 443 | +| HTTP for Replicated | 8800 | diff --git a/docs/content/v2.1/reference/configuration/default-ports.md b/docs/content/v2.1/reference/configuration/default-ports.md index c22fd7bb2d3f..cb574096f9b8 100644 --- a/docs/content/v2.1/reference/configuration/default-ports.md +++ b/docs/content/v2.1/reference/configuration/default-ports.md @@ -49,21 +49,24 @@ Along with the above, include the following common ports in firewall rules. | Service | Port | ------- | ------------------------- | -| SSH | `tcp:22` | -| HTTP | `tcp:80` | -| HTTPS | `tcp:443` | -| HTTP (alternate) | `tcp:8080` | -| HTTP (Replicated) | `tcp:8800` | +| SSH | 22 | +| HTTP for Platform | 80 | +| HTTP for Platform (alternate) | 8080 | +| HTTPS for Platform | 443 | +| HTTP for Replicated | 8800 | -## Prometheus monitoring +## Monitoring with Prometheus -YugabyteDB servers expose time-series performance metrics in the [Prometheus exposition format](https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format) on multiple HTTP endpoints. These endpoints have the following structure. +Use the following targets to configure [Prometheus](https://prometheus.io/) to scrape available metrics (in [Prometheus exposition format](https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format)) from the YugabyteDB HTTP endpoint: ``` /prometheus-metrics ``` -Following is the list of targets available. +You can access the Prometheus server on port `9090` of the Platform node, and you can see the list of targets at the `http://:9090/targets`. In particular, note port `93000` for node level metrics. + +For a quick tutorial on using Prometheus with YugabyteDB, see [Observability with Prometheus](../../../explore/observability). + ### Servers @@ -84,4 +87,3 @@ Use the following `yb-tserver` targets for the various API metrics. | ycql | `:12000` | | yedis | `:11000` | -For a quick tutorial on using Prometheus with YugabyteDB, see [Observability with Prometheus](../../../explore/observability). From 8fb0593beb73308dcf60adf2c5ee4bc272849b79 Mon Sep 17 00:00:00 2001 From: wmaddux Date: Mon, 1 Feb 2021 16:19:06 -0700 Subject: [PATCH 3/3] fixup! Adds additional default ports needed for firewall rules in a cluster managed by YB Platform. --- docs/content/latest/reference/configuration/default-ports.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/latest/reference/configuration/default-ports.md b/docs/content/latest/reference/configuration/default-ports.md index e751473693ca..66334a32c12e 100644 --- a/docs/content/latest/reference/configuration/default-ports.md +++ b/docs/content/latest/reference/configuration/default-ports.md @@ -64,7 +64,7 @@ YugabyteDB servers expose time-series performance metrics in the [Prometheus exp /prometheus-metrics ``` -You can access the Prometheus server on port `9090`, and you can see the list of targets at the `http://:9090/targets`. In particular, note port `93000` for node level metrics. +You can access the Prometheus server on port `9090` of the Platform node, and you can see the list of targets at the `http://:9090/targets`. In particular, note port `93000` for node level metrics. ### Servers