Skip to content

Commit 2b0cea1

Browse files
authored
Merge pull request #212 from puppetlabs/release-prep
Release prep v2.3.0
2 parents 0570de7 + 4efdea7 commit 2b0cea1

File tree

3 files changed

+98
-2
lines changed

3 files changed

+98
-2
lines changed

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
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.3.0](https://github.com/puppetlabs/puppet_operational_dashboards/tree/v2.3.0) (2024-02-03)
6+
7+
[Full Changelog](https://github.com/puppetlabs/puppet_operational_dashboards/compare/v2.2.0...v2.3.0)
8+
9+
### Added
10+
11+
- Fix collection of postgres metrics on FOSS Puppet [\#206](https://github.com/puppetlabs/puppet_operational_dashboards/pull/206) ([m0dular](https://github.com/m0dular))
12+
- Fix logic to include pe metrics [\#204](https://github.com/puppetlabs/puppet_operational_dashboards/pull/204) ([m0dular](https://github.com/m0dular))
13+
514
## [v2.2.0](https://github.com/puppetlabs/puppet_operational_dashboards/tree/v2.2.0) (2023-11-16)
615

716
[Full Changelog](https://github.com/puppetlabs/puppet_operational_dashboards/compare/v2.1.0...v2.2.0)

REFERENCE.md

Lines changed: 88 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
* [`puppet_operational_dashboards`](#puppet_operational_dashboards): Installs Telegraf, InfluxDB, and Grafana to collect and display Puppet metrics
1010
* [`puppet_operational_dashboards::enterprise_infrastructure`](#puppet_operational_dashboards--enterprise_infrastructure): Installs dependancies for Operational dashboards on PE infrastructure components
1111
* [`puppet_operational_dashboards::profile::dashboards`](#puppet_operational_dashboards--profile--dashboards): Installs Grafana and several dashboards to display Puppet metrics. Included via the base class.
12+
* [`puppet_operational_dashboards::profile::foss_postgres_access`](#puppet_operational_dashboards--profile--foss_postgres_access): Allows Telegraf to connect and collect metrics from postgres nodes
1213
* [`puppet_operational_dashboards::profile::postgres_access`](#puppet_operational_dashboards--profile--postgres_access): Allows Telegraf to connect and collect metrics from postgres nodes
1314
* [`puppet_operational_dashboards::telegraf::agent`](#puppet_operational_dashboards--telegraf--agent): Installs and configures Telegraf to query hosts in a Puppet infrastructure. Included by the base class
1415

@@ -194,7 +195,13 @@ Data type: `Boolean`
194195

195196
Whether to include Filesync and Orchestrator dashboards
196197

197-
Default value: `$settings::module_groups =~ 'pe_only'`
198+
Default value:
199+
200+
```puppet
201+
$settings::module_groups ? {
202+
/pe_only/ => true,
203+
default => false
204+
```
198205

199206
##### <a name="-puppet_operational_dashboards--manage_system_board"></a>`manage_system_board`
200207

@@ -505,6 +512,41 @@ Version of the system dashboard to manage. v2 is compatible with puppet_metrics_
505512

506513
Default value: `'v2'`
507514

515+
### <a name="puppet_operational_dashboards--profile--foss_postgres_access"></a>`puppet_operational_dashboards::profile::foss_postgres_access`
516+
517+
Allows Telegraf to connect and collect metrics from postgres nodes
518+
519+
#### Examples
520+
521+
##### Basic usage
522+
523+
```puppet
524+
include puppet_operational_dashboards::profile::foss_postgres_access
525+
```
526+
527+
#### Parameters
528+
529+
The following parameters are available in the `puppet_operational_dashboards::profile::foss_postgres_access` class:
530+
531+
* [`telegraf_hosts`](#-puppet_operational_dashboards--profile--foss_postgres_access--telegraf_hosts)
532+
* [`telegraf_user`](#-puppet_operational_dashboards--profile--foss_postgres_access--telegraf_user)
533+
534+
##### <a name="-puppet_operational_dashboards--profile--foss_postgres_access--telegraf_hosts"></a>`telegraf_hosts`
535+
536+
Data type: `Array`
537+
538+
A list of FQDNs running Telegraf to allow access to
539+
540+
Default value: `puppet_operational_dashboards::hosts_with_profile('Puppet_operational_dashboards::Telegraf::Agent')`
541+
542+
##### <a name="-puppet_operational_dashboards--profile--foss_postgres_access--telegraf_user"></a>`telegraf_user`
543+
544+
Data type: `String`
545+
546+
Username for the Telegraf client to use in the postgres connection string
547+
548+
Default value: `'telegraf'`
549+
508550
### <a name="puppet_operational_dashboards--profile--postgres_access"></a>`puppet_operational_dashboards::profile::postgres_access`
509551

510552
Allows Telegraf to connect and collect metrics from postgres nodes
@@ -584,6 +626,10 @@ The following parameters are available in the `puppet_operational_dashboards::te
584626
* [`influxdb_token_file`](#-puppet_operational_dashboards--telegraf--agent--influxdb_token_file)
585627
* [`http_timeout_seconds`](#-puppet_operational_dashboards--telegraf--agent--http_timeout_seconds)
586628
* [`include_pe_metrics`](#-puppet_operational_dashboards--telegraf--agent--include_pe_metrics)
629+
* [`telegraf_user`](#-puppet_operational_dashboards--telegraf--agent--telegraf_user)
630+
* [`telegraf_postgres_password`](#-puppet_operational_dashboards--telegraf--agent--telegraf_postgres_password)
631+
* [`postgres_port`](#-puppet_operational_dashboards--telegraf--agent--postgres_port)
632+
* [`postgres_options`](#-puppet_operational_dashboards--telegraf--agent--postgres_options)
587633

588634
##### <a name="-puppet_operational_dashboards--telegraf--agent--token"></a>`token`
589635

@@ -850,6 +896,47 @@ Whether to include Filesync and Orchestrator dashboards
850896

851897
Default value: `$puppet_operational_dashboards::include_pe_metrics`
852898

899+
##### <a name="-puppet_operational_dashboards--telegraf--agent--telegraf_user"></a>`telegraf_user`
900+
901+
Data type: `String`
902+
903+
Username for the Telegraf client to use in the postgres connection string
904+
905+
Default value: `'telegraf'`
906+
907+
##### <a name="-puppet_operational_dashboards--telegraf--agent--telegraf_postgres_password"></a>`telegraf_postgres_password`
908+
909+
Data type: `Optional[Sensitive[String]]`
910+
911+
Optional Sensitive password for the Telegraf client to use in the postgres connection string
912+
913+
Default value: `undef`
914+
915+
##### <a name="-puppet_operational_dashboards--telegraf--agent--postgres_port"></a>`postgres_port`
916+
917+
Data type: `Integer`
918+
919+
Port for the Telegraf client to use in the postgres connection string
920+
921+
Default value: `5432`
922+
923+
##### <a name="-puppet_operational_dashboards--telegraf--agent--postgres_options"></a>`postgres_options`
924+
925+
Data type: `Hash`
926+
927+
Hash of options for the Telegraf client to use as connection parameters in the postgres connection string
928+
929+
Default value:
930+
931+
```puppet
932+
{
933+
'sslmode' => 'verify-full',
934+
'sslkey' => '/etc/telegraf/puppet_key.pem',
935+
'sslcert' => '/etc/telegraf/puppet_cert.pem',
936+
'sslrootcert' => '/etc/telegraf/puppet_ca.pem',
937+
}
938+
```
939+
853940
## Defined types
854941

855942
### <a name="puppet_operational_dashboards--telegraf--config"></a>`puppet_operational_dashboards::telegraf::config`

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_operational_dashboards",
3-
"version": "2.2.0",
3+
"version": "2.3.0",
44
"author": "Adrian Parreiras Horta",
55
"summary": "A module for managing the installation and configuration of metrics dashboards for Puppet Infrastructure.",
66
"license": "Apache-2.0",

0 commit comments

Comments
 (0)