Skip to content

Commit e95dccc

Browse files
committed
Update Readme For firewall requirements
1 parent 83a5752 commit e95dccc

File tree

1 file changed

+14
-17
lines changed

1 file changed

+14
-17
lines changed

README.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -41,34 +41,31 @@ This module is a replacement for the [puppet_metrics_dashboard module](https://f
4141

4242
### Firewall Requirements for Puppet Operational Dashboards
4343

44-
To ensure smooth communication between services in the Puppet Operational Dashboards module, the following firewall rules must be configured:
44+
To ensure smooth communication between services in the Puppet Operational Dashboards module, the following firewall rules must be configured in addition to those required by Puppet Enterprise:
45+
46+
| Application | Port | Protocol | Communication Flow | Deployment Notes |
47+
|------------------|-------|----------|---------------------------------|--------------------------------------------------------------------|
48+
| **Telegraf** | 8086 | TCP | Outbound to InfluxDB | Connects to InfluxDB for metric collection. |
49+
| **InfluxDB** | 8086 | TCP | Inbound from Telegraf,Grafana | Receives metrics from Telegraf and Grafana. |
50+
| **Grafana** | 3000 | TCP | Inbound from users/browsers | Used for accessing the dashboard interface. |
51+
| **PostgreSQL** | 5432 | TCP | Inbound from applications | Required for metrics collection in both Puppet Enterprise and Open Source setups. |
52+
| **Puppetserver** | 8140 | TCP | Inbound from inbound from telegraf | Standard Puppetserver communication. |
53+
| **PuppetDB** | 8081 | TCP | Inbound from Telegraf | Stores and serves reports, catalogs, and exported resources. |
54+
| **Orchestrator** | 8143 | TCP | Inbound from Telegraf | Manages task execution and orchestrates Puppet runs. |
4555

46-
| Application | Port | Protocol | Deployment Notes |
47-
|----------------------|-------|----------|----------------------------------------------------------------------------------|
48-
| **Telegraf** | 8086 | TCP | Connects to InfluxDB for metric collection. |
49-
| **InfluxDB** | 8086 | TCP | Receives metrics from Telegraf. |
50-
| **Grafana** | 3000 | TCP | Used for accessing the dashboard interface. |
51-
| **PostgreSQL** | 5432 | TCP | Required for metrics collection in both Puppet Enterprise and Open Source setups.|
52-
| **Puppetserver** | 8140 | TCP | Standard Puppetserver communication. |
5356

5457
---
5558

5659
#### Deployment Scenario: Puppet Enterprise with Firewalls Between Components
5760

5861
In a Puppet Enterprise deployment with Puppet compilers and firewalls between the primary server, compilers, and infrastructure hosting the services deployed by this module, additional considerations must be addressed:
5962

60-
##### Communication Pathways
61-
1. **Primary Server to Puppet Compilers**:
62-
- Port: `8140`
63-
- Protocol: TCP
64-
- Purpose: Ensure that the primary server can communicate with Puppet compilers for catalog compilation and node management.
65-
66-
2. **Primary Server to Infrastructure Services (Telegraf, InfluxDB, Grafana, PostgreSQL)**:
67-
- Ports: `8086` (InfluxDB), `3000` (Grafana), `5432` (PostgreSQL)
63+
1. **Primary Server to Infrastructure Services (Telegraf, InfluxDB, Grafana)**:
64+
- Ports: `8086` (InfluxDB), `3000` (Grafana))
6865
- Protocol: TCP
6966
- Purpose: Allow the primary server to send metrics and manage dashboards via Grafana and InfluxDB.
7067

71-
3. **Puppet Compilers to Infrastructure Services**:
68+
2. **Puppet Compilers to Infrastructure Services**:
7269
- Ports: `8086` (InfluxDB), `5432` (PostgreSQL)
7370
- Protocol: TCP
7471
- Purpose: Enable Puppet compilers to report metrics collected by Telegraf.

0 commit comments

Comments
 (0)