Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Additional default firewall ports #6593

Merged
merged 3 commits into from
Feb 1, 2021
Merged

Additional default firewall ports #6593

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
597ffd6
Adds additional default ports needed for firewall rules in a cluster …
Dec 9, 2020
88991be
fixup! Adds additional default ports needed for firewall rules in a c…
wmaddux Feb 1, 2021
8fb0593
fixup! Adds additional default ports needed for firewall rules in a c…
wmaddux Feb 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion docs/content/latest/reference/configuration/default-ports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)<br>[`--webserver_port 7000`](../yb-master/#webserver-port) |
| yb-tserver | 9000 | [`--webserver_interface 0.0.0.0`](../yb-master/#webserver-interface)<br>[`--webserver_port 9000`](../yb-master/#webserver-port) |

## Firewall Rules
Along with the above, include the following common ports in firewall rules.

| Service | Port
| ------- | ------------------------- |
| SSH | 22 |
| HTTP for Platform | 80 |
| HTTP for Platform (alternate) | 8080 |
| HTTPS for Platform | 443 |
| HTTP for Replicated | 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.
Expand All @@ -53,7 +64,7 @@ YugabyteDB servers expose time-series performance metrics in the [Prometheus exp
<target>/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://<yugaware-ip>:9090/targets`. In particular, note port `93000` for node level metrics.

### Servers

Expand All @@ -74,4 +85,5 @@ Use the following `yb-tserver` targets for the various API metrics.
| ycql | `<yb-tserver-address>:12000` |
| yedis | `<yb-tserver-address>:11000` |


For a quick tutorial on using Prometheus with YugabyteDB, see [Observability with Prometheus](../../../explore/observability).
21 changes: 17 additions & 4 deletions docs/content/stable/reference/configuration/default-ports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,29 @@ Admin web server UI can be viewed at these addresses.
| yb-master | 7000 | [`--webserver_interface 0.0.0.0`](../yb-master/#webserver-interface)<br>[`--webserver_port 7000`](../yb-master/#webserver-port) |
| yb-tserver | 9000 | [`--webserver_interface 0.0.0.0`](../yb-master/#webserver-interface)<br>[`--webserver_port 9000`](../yb-master/#webserver-port) |

## Prometheus monitoring
## Firewall Rules
Along with the above, include the following common ports in firewall rules.

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.
| Service | Port
| ------- | ------------------------- |
| SSH | 22 |
| HTTP for Platform | 80 |
| HTTP for Platform (alternate) | 8080 |
| HTTPS for Platform | 443 |
| HTTP for Replicated | 8800 |

## Monitoring with Prometheus

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:

```
<target>/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://<yugaware-ip>: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

Expand All @@ -72,4 +86,3 @@ Use the following `yb-tserver` targets for the various API metrics.
| ycql | `<yb-tserver-address>:12000` |
| yedis | `<yb-tserver-address>:11000` |

For a quick tutorial on using Prometheus with YugabyteDB, see [Observability with Prometheus](../../../explore/observability).
13 changes: 12 additions & 1 deletion docs/content/v2.0/reference/configuration/default-ports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<target>/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://<yugaware-ip>: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
Expand Down Expand Up @@ -70,4 +72,13 @@ Admin web server UI can be viewed at these addresses.
| yb-master | 7000 | [`--webserver_interface 0.0.0.0`](../yb-master/#webserver-interface)<br >[`--webserver_port 7000`](../yb-master/#webserver-port) |
| yb-tserver | 9000 | [`--webserver_interface 0.0.0.0`](../yb-master/#webserver-interface)<br >[`--webserver_port 9000`](../yb-master/#webserver-port) |

### Firewall Rules
Along with the above, include the following common ports in firewall rules.

| Service | Port
| ------- | ------------------------- |
| SSH | 22 |
| HTTP for Platform | 80 |
| HTTP for Platform (alternate) | 8080 |
| HTTPS for Platform | 443 |
| HTTP for Replicated | 8800 |
21 changes: 17 additions & 4 deletions docs/content/v2.1/reference/configuration/default-ports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,29 @@ Admin web server UI can be viewed at these addresses.
| yb-master | 7000 | [`--webserver_interface 0.0.0.0`](../yb-master/#webserver-interface)<br>[`--webserver_port 7000`](../yb-master/#webserver-port) |
| yb-tserver | 9000 | [`--webserver_interface 0.0.0.0`](../yb-master/#webserver-interface)<br>[`--webserver_port 9000`](../yb-master/#webserver-port) |

## Prometheus monitoring
## Firewall Rules
Along with the above, include the following common ports in firewall rules.

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.
| Service | Port
| ------- | ------------------------- |
| SSH | 22 |
| HTTP for Platform | 80 |
| HTTP for Platform (alternate) | 8080 |
| HTTPS for Platform | 443 |
| HTTP for Replicated | 8800 |

## Monitoring with Prometheus

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:

```
<target>/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://<yugaware-ip>: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

Expand All @@ -73,4 +87,3 @@ Use the following `yb-tserver` targets for the various API metrics.
| ycql | `<yb-tserver-address>:12000` |
| yedis | `<yb-tserver-address>:11000` |

For a quick tutorial on using Prometheus with YugabyteDB, see [Observability with Prometheus](../../../explore/observability).