Skip to content
This repository was archived by the owner on Jun 1, 2023. It is now read-only.

Commit 702a323

Browse files
authored
Merge pull request #162 from henrywangpuppet/main
(SUP-2500) Remove Harmful terminology in Readme and Manifests
2 parents ba92f1c + 07368c0 commit 702a323

File tree

4 files changed

+28
-28
lines changed

4 files changed

+28
-28
lines changed

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
- [Determining where Telegraf runs](#determining-where-telegraf-runs)
77
- [Requirements](#requirements)
88
- [Usage](#usage)
9-
- [Configure a Monolithic Master and a Dashboard node](#configure-a-monolithic-master-and-a-dashboard-node)
9+
- [Configure a Standard Primary Server and a Dashboard node](#configure-a-standard-primary-server-and-a-dashboard-node)
1010
- [Manual configuration of a complex Puppet Infrastructure](#manual-configuration-of-a-complex-puppet-infrastructure)
1111
- [Configure Graphite](#configure-graphite)
1212
- [Configure Telegraf, Graphite, and Archive](#configure-telegraf-graphite-and-archive)
@@ -25,7 +25,7 @@
2525

2626
This module is used to configure Telegraf, InfluxDB, and Grafana, and collect, store, and display metrics collected from Puppet services.
2727
By default, those components are installed on a separate Dashboard node by applying the base class of this module to that node.
28-
That class will automatically query PuppetDB for Puppet Infrastructure nodes (Masters, PuppetDB hosts, PostgreSQL hosts) or you can specify them via associated class parameters.
28+
That class will automatically query PuppetDB for Puppet Infrastructure nodes (Primary server, Compilers, PuppetDB hosts, PostgreSQL hosts) or you can specify them via associated class parameters.
2929
It is not recommended to apply the base class of this module to one of your Puppet Infrastructure nodes.
3030

3131
You have the option to use the [included defined types](#profile-defined-types) to configure Telegraf to run on each Puppet Infrastructure node,
@@ -42,11 +42,11 @@ You have the option of collecting metrics using any or all of the following meth
4242
## Setup
4343

4444
> In PuppetDB 6.9.1 & 5.2.13 and newer, the `/metrics/v1` endpoints are disabled by default and access to the `/metrics/v2` endpoints are restricted to localhost only in response to [CVE-2020-7943](https://nvd.nist.gov/vuln/detail/CVE-2020-7943).
45-
Starting with version 2.3.0 of this module, PuppetDB metrics will not be setup by the main class if you are on the versions above or higher unless the main class is applied to the master. To collect PuppetDB metrics in other scenarios, you should use the `puppet_metrics_dashboard::profile::puppetdb` class applied to any PuppetDB nodes with the option `enable_client_cert => false` (the request will be to localhost and doen't require SSL)
45+
Starting with version 2.3.0 of this module, PuppetDB metrics will not be setup by the main class if you are on the versions above or higher unless the main class is applied to the Primary Server. To collect PuppetDB metrics in other scenarios, you should use the `puppet_metrics_dashboard::profile::puppetdb` class applied to any PuppetDB nodes with the option `enable_client_cert => false` (the request will be to localhost and doen't require SSL)
4646
4747
### Upgrade notes
4848

49-
* Version 2 and up now requires the `toml-rb` gem installed on the Master and any/all Compilers.
49+
* Version 2 and up now requires the `toml-rb` gem installed on the Primary Server and any/all Compilers.
5050
* The `puppet_metrics_dashboard::profile::postgres` class is deprecated in favor of the `puppet_metrics_dashboard::profile::master::postgres_access` class.
5151
* Parameters `telegraf_agent_interval` and `http_response_timeout` were previously Integers but are now Strings. The value should match a time interval, such as `5s`, `10m`, or `1h`.
5252
* `influxdb_urls` was previously a String, but is now an Array.
@@ -67,12 +67,12 @@ Apply the `puppet_metrics_dashboard` class to the Dashboard node to configure In
6767

6868
### Requirements
6969

70-
The [toml-rb](https://github.com/emancu/toml-rb) gem is a requirement of the `puppet-telegraf` module, and needs to be installed in Puppet Server on the Master and any/all Compilers.
70+
The [toml-rb](https://github.com/emancu/toml-rb) gem is a requirement of the `puppet-telegraf` module, and needs to be installed in Puppet Server on the Primary Server and any/all Compilers.
7171

72-
Apply the following class to the Master and any/all Compilers to install the gem.
72+
Apply the following class to the Primary Server and any/all Compilers to install the gem.
7373

7474
```puppet
75-
node 'master.example.com' {
75+
node 'primary.example.com' {
7676
include puppet_metrics_dashboard::profile::master::install
7777
}
7878
node 'compiler.example.com' {
@@ -94,10 +94,10 @@ If you are configuring the Dashboard node via a `puppet apply` workflow, you wil
9494

9595
## Usage
9696

97-
### Configure a Monolithic Master and a Dashboard node
97+
### Configure a Standard Primary Server and a Dashboard node
9898

9999
```puppet
100-
node 'master.example.com' {
100+
node 'primary.example.com' {
101101
include puppet_metrics_dashboard::profile::master::install
102102
include puppet_metrics_dashboard::profile::master::postgres_access
103103
}
@@ -110,15 +110,15 @@ node 'dashboard.example.com' {
110110
}
111111
```
112112

113-
This will configure Telegraf, InfluxDB, and Grafana on the Dashboard node, and allow Telegraf on that host to access PostgreSQL on the Monolithic Master.
113+
This will configure Telegraf, InfluxDB, and Grafana on the Dashboard node, and allow Telegraf on that host to access PostgreSQL on the Standard Primary Server.
114114

115115
Note that the `add_dashboard_examples` parameter enforces state on the example dashboards.
116116
Setting the `overwrite_dashboards` parameter to `true` disables overwriting your modifications (if any) to the example dashboards.
117117

118118
### Manual configuration of a complex Puppet Infrastructure
119119

120120
```puppet
121-
node 'master.example.com' {
121+
node 'primary.example.com' {
122122
include puppet_metrics_dashboard::profile::master::install
123123
}
124124
node 'compiler01.example.com' {
@@ -140,7 +140,7 @@ node 'dashboard.example.com' {
140140
overwrite_dashboards => false,
141141
configure_telegraf => true,
142142
enable_telegraf => true,
143-
master_list => ['master.example.com', ['compiler01.example.com', 9140], ['compiler02.example.com', 9140]],
143+
master_list => ['primary.example.com', ['compiler01.example.com', 9140], ['compiler02.example.com', 9140]],
144144
puppetdb_list => ['puppetdb01.example.com', 'puppetdb02.example.com'],
145145
postgres_host_list => ['postgres01.example.com', 'postgres02.example.com'],
146146
}
@@ -154,7 +154,7 @@ The `*_list` parameters can be defined in the class declaration, or elsewhere in
154154

155155
```
156156
puppet_metrics_dashboard::master_list:
157-
- "master.example.com"
157+
- "primary.example.com"
158158
- ["compiler01.example.com", 9140]
159159
- ["compiler02.example.com", 9140]
160160
puppet_metrics_dashboard::puppetdb_list:
@@ -165,10 +165,10 @@ puppet_metrics_dashboard::postgres_host_list:
165165
- "postgres02.example.com"
166166
```
167167

168-
### Configure Master, Compiler running PuppetDB and a Dashboard node
168+
### Configure Primary Server, Compiler running PuppetDB and a Dashboard node
169169

170170
```puppet
171-
node 'master.example.com' {
171+
node 'primary.example.com' {
172172
include puppet_metrics_dashboard::profile::master::install
173173
}
174174
node 'dbcompiler.example.com' {
@@ -195,12 +195,12 @@ node 'dashboard.example.com' {
195195
overwrite_dashboards => false,
196196
consume_graphite => true,
197197
influxdb_database_name => ['graphite'],
198-
master_list => ['master', 'master02'],
198+
master_list => ['primary', 'compiler01'],
199199
}
200200
}
201201
```
202202

203-
* This method requires enabling Graphite on the Masters, as described [here](https://puppet.com/docs/pe/latest/puppet_server_metrics/getting_started_with_graphite.html#enabling-puppet-server-graphite-support).
203+
* This method requires enabling Graphite on the Primary Server and Compilers, as described [here](https://puppet.com/docs/pe/latest/puppet_server_metrics/getting_started_with_graphite.html#enabling-puppet-server-graphite-support).
204204
The hostnames that you use in `master_list` must match the value(s) that you used for `metrics_server_id` in the `puppet_enterprise::profile::master` class.
205205
You must use hostnames rather than fully-qualified domain names (no dots) both in this class and in the `puppet_enterprise::profile::master` class.
206206

@@ -241,10 +241,10 @@ The `--pattern` flag accepts a Ruby glob argument, which the script will interna
241241

242242
### Allow Telegraf to access PE-PostgreSQL
243243

244-
The following class is required to be applied to the Master (or the PE Database node if using external PostgreSQL) for collection of PostgreSQL metrics via Telegraf.
244+
The following class is required to be applied to the Primary Server (or the PE Database node if using external PostgreSQL) for collection of PostgreSQL metrics via Telegraf.
245245

246246
```puppet
247-
node 'master.example.com' {
247+
node 'primary.example.com' {
248248
class { 'puppet_metrics_dashboard::profile::master::postgres_access':
249249
telegraf_host => 'grafana-server.example.com',
250250
}
@@ -258,7 +258,7 @@ If the PuppetDB lookup fails to find a Dashboard node, and you do not specify `t
258258
Refer to [Issue 72](https://github.com/puppetlabs/puppet_metrics_dashboard/issues/72) if the above generates the following error:
259259

260260
```
261-
Error: Could not retrieve catalog from remote server: Error 500 on SERVER: Server Error: Evaluation Error: Error while evaluating a Resource Statement, Evaluation Error: Error while evaluating a Function Call, 'versioncmp' parameter 'a' expects a String value, got Undef (file: /opt/puppetlabs/puppet/modules/pe_postgresql/manifests/server/role.pp, line: 66, column: 6) (file: /etc/puppetlabs/code/environments/production/modules/puppet_metrics_dashboard/manifests/profile/master/postgres_access.pp, line: 42) on node master.example.com
261+
Error: Could not retrieve catalog from remote server: Error 500 on SERVER: Server Error: Evaluation Error: Error while evaluating a Resource Statement, Evaluation Error: Error while evaluating a Function Call, 'versioncmp' parameter 'a' expects a String value, got Undef (file: /opt/puppetlabs/puppet/modules/pe_postgresql/manifests/server/role.pp, line: 66, column: 6) (file: /etc/puppetlabs/code/environments/production/modules/puppet_metrics_dashboard/manifests/profile/master/postgres_access.pp, line: 42) on node primary.example.com
262262
```
263263

264264
A workaround for that error is to apply the `puppet_metrics_dashboard::profile::master::postgres_access` class to the `PE Database` Node Group in the Console, if using Puppet Enterprise.

manifests/init.pp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -154,24 +154,24 @@
154154
# An Array of Hashes containing name/url pairs for each PuppetDB metric.
155155
# Refer to `functions/puppetdb_metrics.pp` for defaults.
156156
#
157-
# @example Configure Telegraf to collect metrics from a list of Masters, PuppetDB, and PostgreSQL servers
157+
# @example Configure Telegraf to collect metrics from a list of Primary Server, Compilers, PuppetDB, and PostgreSQL servers
158158
# class { 'puppet_metrics_dashboard':
159159
# add_dashboard_examples => true,
160160
# overwrite_dashboards => false,
161161
# configure_telegraf => true,
162162
# enable_telegraf => true,
163-
# master_list => ['master.example.com', ['compiler01.example.com', 9140], ['compiler02.example.com', 9140]],
163+
# master_list => ['primary.example.com', ['compiler01.example.com', 9140], ['compiler02.example.com', 9140]],
164164
# puppetdb_list => ['puppetdb01.example.com', 'puppetdb02.example.com'],
165165
# postgres_host_list => ['postgres01.example.com', 'postgres02.example.com'],
166166
# }
167167
#
168-
# @example Configure Graphite to accept metrics from a list of Masters
168+
# @example Configure Graphite to accept metrics from a list of Primary Server and Compilers
169169
# class { 'puppet_metrics_dashboard':
170170
# add_dashboard_examples => true,
171171
# overwrite_dashboards => false,
172172
# consume_graphite => true,
173173
# influxdb_database_name => ['graphite'],
174-
# master_list => ['master', 'master02'],
174+
# master_list => ['primary', 'compiler01'],
175175
# }
176176
#
177177
# @example Configure Telegraf, Graphite, and Archive

manifests/profile/compiler.pp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# @summary Apply this class to a master or compiler to collect puppetserver metrics
1+
# @summary Apply this class to a Primary Server or Compiler to collect puppetserver metrics
22
#
33
# @param timeout
44
# Default timeout of http calls. Defaults to 5 seconds
55
#
66
# @param compiler
7-
# The FQDN of the compiler / master. Defaults to the FQDN of the server where the profile is applied
7+
# The FQDN of the Compiler / Primary Server. Defaults to the FQDN of the server where the profile is applied
88
#
99
# @param port
1010
# The port that the puppetserver service listens on on your compiler. Defaults to 8140
1111
#
1212
# @param interval
1313
# The frequency that telegraf will poll for metrics. Defaults to '5s'
1414
#
15-
# @example Add telegraf to a master / compiler
15+
# @example Add telegraf to a Primary Server / Compiler
1616
# puppet_metrics_dashboard::profile::compiler{ $facts['networking']['fqdn']:
1717
# timeout => '5s',
1818
# }

manifests/profile/master/install.pp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#
33
# Install requirements for the voxpupuli/puppet-telegraf module.
44
#
5-
# @example Apply this class to the Master and any/all Compilers
5+
# @example Apply this class to the Primary Server and any/all Compilers
66
# include puppet_metrics_dashboard::profile::master::install
77
#
88
class puppet_metrics_dashboard::profile::master::install (

0 commit comments

Comments
 (0)