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

Commit a27277b

Browse files
authored
Merge pull request #199 from puppetlabs/release-prep
Release prep v2.6.0
2 parents ceb56c1 + 4399a45 commit a27277b

File tree

4 files changed

+102
-13
lines changed

4 files changed

+102
-13
lines changed

CHANGELOG.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,25 @@
22

33
All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org).
44

5+
## [v2.6.0](https://github.com/puppetlabs/puppet_metrics_dashboard/tree/v2.6.0) (2021-11-01)
6+
7+
[Full Changelog](https://github.com/puppetlabs/puppet_metrics_dashboard/compare/v2.5.0...v2.6.0)
8+
9+
### Added
10+
11+
- \(SUP-2769\) Bump default Grafana version from 5.1.4 to 8.2.2 [\#197](https://github.com/puppetlabs/puppet_metrics_dashboard/pull/197) ([suckatrash](https://github.com/suckatrash))
12+
- \(Sup-2754\) Adding SLES support [\#194](https://github.com/puppetlabs/puppet_metrics_dashboard/pull/194) ([m0dular](https://github.com/m0dular))
13+
- \(SUP-2194\) To add datasource variable for Archive Dashboards - PR 185 Replacement [\#192](https://github.com/puppetlabs/puppet_metrics_dashboard/pull/192) ([henrywangpuppet](https://github.com/henrywangpuppet))
14+
- Added repo\_gpgcheck and single quotes to influxdb [\#189](https://github.com/puppetlabs/puppet_metrics_dashboard/pull/189) ([di2ejenkins](https://github.com/di2ejenkins))
15+
- \(SUP-2137\) To add parameters to configure telegraf database retention policy [\#188](https://github.com/puppetlabs/puppet_metrics_dashboard/pull/188) ([henrywangpuppet](https://github.com/henrywangpuppet))
16+
- \(GH-158\) Add support for puppet-telegraf 4.1+ [\#166](https://github.com/puppetlabs/puppet_metrics_dashboard/pull/166) ([jarretlavallee](https://github.com/jarretlavallee))
17+
- \(\#151\) Install toml gem by default. [\#154](https://github.com/puppetlabs/puppet_metrics_dashboard/pull/154) ([coreymbe](https://github.com/coreymbe))
18+
19+
### Fixed
20+
21+
- \(SUP-2732\) Fix PDB data tagged onto dashboard server issue and templa… [\#191](https://github.com/puppetlabs/puppet_metrics_dashboard/pull/191) ([henrywangpuppet](https://github.com/henrywangpuppet))
22+
- \(GH-172\) Add cgroup mapping for viewer [\#173](https://github.com/puppetlabs/puppet_metrics_dashboard/pull/173) ([jarretlavallee](https://github.com/jarretlavallee))
23+
524
## [v2.5.0](https://github.com/puppetlabs/puppet_metrics_dashboard/tree/v2.5.0) (2021-05-27)
625

726
[Full Changelog](https://github.com/puppetlabs/puppet_metrics_dashboard/compare/v2.4.0...v2.5.0)

REFERENCE.md

Lines changed: 80 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
### Defined types
3535

3636
* [`puppet_metrics_dashboard::certs`](#puppet_metrics_dashboardcerts): This class creates a certificates for Grafana and for connecting to PE Postgres.
37-
* [`puppet_metrics_dashboard::profile::compiler`](#puppet_metrics_dashboardprofilecompiler): Apply this class to a master or compiler to collect puppetserver metrics
37+
* [`puppet_metrics_dashboard::profile::compiler`](#puppet_metrics_dashboardprofilecompiler): Apply this class to a Primary Server or Compiler to collect puppetserver metrics
3838
* [`puppet_metrics_dashboard::profile::master::postgres`](#puppet_metrics_dashboardprofilemasterpostgres): Apply this class to an agent running pe-postgresql to collect postgres metrics
3939
* [`puppet_metrics_dashboard::profile::puppetdb`](#puppet_metrics_dashboardprofilepuppetdb): Apply this class to a node running puppetdb to collect puppetdb metrics
4040

@@ -73,29 +73,29 @@ class { 'puppet_metrics_dashboard':
7373
}
7474
```
7575

76-
##### Configure Telegraf to collect metrics from a list of Masters, PuppetDB, and PostgreSQL servers
76+
##### Configure Telegraf to collect metrics from a list of Primary Server, Compilers, PuppetDB, and PostgreSQL servers
7777

7878
```puppet
7979
class { 'puppet_metrics_dashboard':
8080
add_dashboard_examples => true,
8181
overwrite_dashboards => false,
8282
configure_telegraf => true,
8383
enable_telegraf => true,
84-
master_list => ['master.example.com', ['compiler01.example.com', 9140], ['compiler02.example.com', 9140]],
84+
master_list => ['primary.example.com', ['compiler01.example.com', 9140], ['compiler02.example.com', 9140]],
8585
puppetdb_list => ['puppetdb01.example.com', 'puppetdb02.example.com'],
8686
postgres_host_list => ['postgres01.example.com', 'postgres02.example.com'],
8787
}
8888
```
8989

90-
##### Configure Graphite to accept metrics from a list of Masters
90+
##### Configure Graphite to accept metrics from a list of Primary Server and Compilers
9191

9292
```puppet
9393
class { 'puppet_metrics_dashboard':
9494
add_dashboard_examples => true,
9595
overwrite_dashboards => false,
9696
consume_graphite => true,
9797
influxdb_database_name => ['graphite'],
98-
master_list => ['master', 'master02'],
98+
master_list => ['primary', 'compiler01'],
9999
}
100100
```
101101

@@ -128,7 +128,9 @@ The following parameters are available in the `puppet_metrics_dashboard` class:
128128
* [`influxdb_urls`](#influxdb_urls)
129129
* [`influx_db_service_name`](#influx_db_service_name)
130130
* [`influx_db_password`](#influx_db_password)
131+
* [`influx_archive_source`](#influx_archive_source)
131132
* [`telegraf_db_name`](#telegraf_db_name)
133+
* [`telegraf_db_retention_duration`](#telegraf_db_retention_duration)
132134
* [`http_response_timeout`](#http_response_timeout)
133135
* [`telegraf_agent_interval`](#telegraf_agent_interval)
134136
* [`pg_query_interval`](#pg_query_interval)
@@ -142,6 +144,9 @@ The following parameters are available in the `puppet_metrics_dashboard` class:
142144
* [`grafana_version`](#grafana_version)
143145
* [`overwrite_dashboards_file`](#overwrite_dashboards_file)
144146
* [`grafana_config`](#grafana_config)
147+
* [`grafana_manage_repo`](#grafana_manage_repo)
148+
* [`grafana_archive_source`](#grafana_archive_source)
149+
* [`grafana_install_method`](#grafana_install_method)
145150
* [`master_list`](#master_list)
146151
* [`puppetdb_list`](#puppetdb_list)
147152
* [`postgres_host_list`](#postgres_host_list)
@@ -238,12 +243,30 @@ Data type: `String`
238243
The password for the InfluxDB `admin` user.
239244
Defaults to `puppet`
240245

246+
##### <a name="influx_archive_source"></a>`influx_archive_source`
247+
248+
Data type: `Optional[Stdlib::Httpsurl]`
249+
250+
URL if you want to install influx from tar.gz file
251+
252+
Default value: ``undef``
253+
241254
##### <a name="telegraf_db_name"></a>`telegraf_db_name`
242255

243256
Data type: `String`
244257

245258
The InfluxDB database where Telegraf metrics are stored.
246259

260+
##### <a name="telegraf_db_retention_duration"></a>`telegraf_db_retention_duration`
261+
262+
Data type: `Optional[String[1]]`
263+
264+
The retention duration for database used for Telegraf metrics. Defaults to undef.
265+
Specify a value to setup retention duration. Example: `4w` is 4 weeks.
266+
To update a new duration, set it as undef first and run puppet agent to reset. Then, specify the new value.
267+
268+
Default value: ``undef``
269+
247270
##### <a name="http_response_timeout"></a>`http_response_timeout`
248271

249272
Data type: `String[2]`
@@ -333,6 +356,35 @@ Data type: `Hash`
333356
Hash of arbitrary configuration settings to pass to Grafana.
334357
These are added to `grafana.ini` with top-level keys becoming sections and their key-value children becoming settings.
335358

359+
##### <a name="grafana_manage_repo"></a>`grafana_manage_repo`
360+
361+
Data type: `Boolean`
362+
363+
Whether to configure apt / yum repositories for grafana packages.
364+
365+
Default value: `$manage_repos`
366+
367+
##### <a name="grafana_archive_source"></a>`grafana_archive_source`
368+
369+
Data type: `Optional[Stdlib::Httpsurl]`
370+
371+
URL if you want to install grafana from tar.gz file
372+
373+
Default value: ``undef``
374+
375+
##### <a name="grafana_install_method"></a>`grafana_install_method`
376+
377+
Data type: `Enum['docker', 'archive', 'package', 'repo']`
378+
379+
grafana module allows to specify the installation method.
380+
Set to 'archive' to install Grafana using the tar archive.
381+
Set to 'docker' to install Grafana using the official Docker container.
382+
Set to 'package' to install Grafana using .deb or .rpm packages.
383+
Set to 'repo' to install Grafana using an apt or yum repository.
384+
Defaults to 'package'.
385+
386+
Default value: `'repo'`
387+
336388
##### <a name="master_list"></a>`master_list`
337389

338390
Data type: `Puppet_metrics_dashboard::HostList`
@@ -557,7 +609,8 @@ Default value: ``true``
557609

558610
Data type: `String`
559611

560-
Search user bind dn. If you can provide a single bind expression that matches all possible users, you can skip specifying ldap_bind_password.
612+
Search user bind dn. If you can provide a single bind expression that matches all possible users,
613+
you can skip specifying ldap_bind_password.
561614

562615
##### <a name="ldap_bind_password"></a>`ldap_bind_password`
563616

@@ -663,12 +716,26 @@ Install requirements for the voxpupuli/puppet-telegraf module.
663716

664717
#### Examples
665718

666-
##### Apply this class to the Master and any/all Compilers
719+
##### Apply this class to the Primary Server and any/all Compilers
667720

668721
```puppet
669722
include puppet_metrics_dashboard::profile::master::install
670723
```
671724

725+
#### Parameters
726+
727+
The following parameters are available in the `puppet_metrics_dashboard::profile::master::install` class:
728+
729+
* [`manage_ldap_auth`](#manage_ldap_auth)
730+
731+
##### <a name="manage_ldap_auth"></a>`manage_ldap_auth`
732+
733+
Data type: `Boolean`
734+
735+
736+
737+
Default value: ``true``
738+
672739
### <a name="puppet_metrics_dashboardprofilemasterpostgres_access"></a>`puppet_metrics_dashboard::profile::master::postgres_access`
673740

674741
Apply this class to a PE PostgreSQL node to allow access by Telegraf.
@@ -712,8 +779,9 @@ The following parameters are available in the `puppet_metrics_dashboard::profile
712779

713780
Data type: `String`
714781

715-
The FQDN of the host where telegraf runs.
716-
Defaults to an empty string. You can explicitly set this parameter or the class attempts to lookup which host has the puppet_metrics_dashboard class applied in PuppetDB. If the parameter is not set and the lookup does not return anything we issue a warning.
782+
The FQDN of the host where telegraf runs. Defaults to an empty string.
783+
You can explicitly set this parameter or the class attempts to lookup which host has the puppet_metrics_dashboard class applied
784+
in PuppetDB. If the parameter is not set and the lookup does not return anything we issue a warning.
717785

718786
Default value: `''`
719787

@@ -741,11 +809,11 @@ Default value: `$name`
741809

742810
### <a name="puppet_metrics_dashboardprofilecompiler"></a>`puppet_metrics_dashboard::profile::compiler`
743811

744-
Apply this class to a master or compiler to collect puppetserver metrics
812+
Apply this class to a Primary Server or Compiler to collect puppetserver metrics
745813

746814
#### Examples
747815

748-
##### Add telegraf to a master / compiler
816+
##### Add telegraf to a Primary Server / Compiler
749817

750818
```puppet
751819
puppet_metrics_dashboard::profile::compiler{ $facts['networking']['fqdn']:
@@ -774,7 +842,7 @@ Default value: `lookup('puppet_metrics_dashboard::http_response_timeout')`
774842

775843
Data type: `Variant[String,Tuple[String, Integer]]`
776844

777-
The FQDN of the compiler / master. Defaults to the FQDN of the server where the profile is applied
845+
The FQDN of the Compiler / Primary Server. Defaults to the FQDN of the server where the profile is applied
778846

779847
Default value: `$facts['networking']['fqdn']`
780848

metadata.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "puppetlabs-puppet_metrics_dashboard",
3-
"version": "2.5.0",
3+
"version": "2.6.0",
44
"author": "puppetlabs",
55
"summary": "A module for managing the installation and configuration of metrics dashboards for Puppet Infrastructure.",
66
"license": "Apache-2.0",

pdk.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
ignore: []

0 commit comments

Comments
 (0)