Merge pull request #199 from puppetlabs/release-prep

Release prep v2.6.0
puppetlabs · Nov 1, 2021 · a27277b · a27277b
2 parents ceb56c1 + 4399a45
commit a27277b
Show file tree

Hide file tree

Showing 4 changed files with 102 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,25 @@
 
 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).
 
+## [v2.6.0](https://github.com/puppetlabs/puppet_metrics_dashboard/tree/v2.6.0) (2021-11-01)
+
+[Full Changelog](https://github.com/puppetlabs/puppet_metrics_dashboard/compare/v2.5.0...v2.6.0)
+
+### Added
+
+- \(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))
+- \(Sup-2754\) Adding SLES support [\#194](https://github.com/puppetlabs/puppet_metrics_dashboard/pull/194) ([m0dular](https://github.com/m0dular))
+- \(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))
+- Added repo\_gpgcheck and single quotes to influxdb [\#189](https://github.com/puppetlabs/puppet_metrics_dashboard/pull/189) ([di2ejenkins](https://github.com/di2ejenkins))
+- \(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))
+- \(GH-158\) Add support for puppet-telegraf 4.1+ [\#166](https://github.com/puppetlabs/puppet_metrics_dashboard/pull/166) ([jarretlavallee](https://github.com/jarretlavallee))
+- \(\#151\) Install toml gem by default. [\#154](https://github.com/puppetlabs/puppet_metrics_dashboard/pull/154) ([coreymbe](https://github.com/coreymbe))
+
+### Fixed
+
+- \(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))
+- \(GH-172\) Add cgroup mapping for viewer [\#173](https://github.com/puppetlabs/puppet_metrics_dashboard/pull/173) ([jarretlavallee](https://github.com/jarretlavallee))
+
 ## [v2.5.0](https://github.com/puppetlabs/puppet_metrics_dashboard/tree/v2.5.0) (2021-05-27)
 
 [Full Changelog](https://github.com/puppetlabs/puppet_metrics_dashboard/compare/v2.4.0...v2.5.0)

diff --git a/REFERENCE.md b/REFERENCE.md
@@ -34,7 +34,7 @@
 ### Defined types
 
 * [`puppet_metrics_dashboard::certs`](#puppet_metrics_dashboardcerts): This class creates a certificates for Grafana and for connecting to PE Postgres.
-* [`puppet_metrics_dashboard::profile::compiler`](#puppet_metrics_dashboardprofilecompiler): Apply this class to a master or compiler to collect puppetserver metrics
+* [`puppet_metrics_dashboard::profile::compiler`](#puppet_metrics_dashboardprofilecompiler): Apply this class to a Primary Server or Compiler to collect puppetserver metrics
 * [`puppet_metrics_dashboard::profile::master::postgres`](#puppet_metrics_dashboardprofilemasterpostgres): Apply this class to an agent running pe-postgresql to collect postgres metrics
 * [`puppet_metrics_dashboard::profile::puppetdb`](#puppet_metrics_dashboardprofilepuppetdb): Apply this class to a node running puppetdb to collect puppetdb metrics
 
@@ -73,29 +73,29 @@ class { 'puppet_metrics_dashboard':
 }
 ```
 
-##### Configure Telegraf to collect metrics from a list of Masters, PuppetDB, and PostgreSQL servers
+##### Configure Telegraf to collect metrics from a list of Primary Server, Compilers, PuppetDB, and PostgreSQL servers
 
 ```puppet
 class { 'puppet_metrics_dashboard':
   add_dashboard_examples => true,
   overwrite_dashboards   => false,
   configure_telegraf     => true,
   enable_telegraf        => true,
-  master_list            => ['master.example.com', ['compiler01.example.com', 9140], ['compiler02.example.com', 9140]],
+  master_list            => ['primary.example.com', ['compiler01.example.com', 9140], ['compiler02.example.com', 9140]],
   puppetdb_list          => ['puppetdb01.example.com', 'puppetdb02.example.com'],
   postgres_host_list     => ['postgres01.example.com', 'postgres02.example.com'],
 }
 ```
 
-##### Configure Graphite to accept metrics from a list of Masters
+##### Configure Graphite to accept metrics from a list of Primary Server and Compilers
 
 ```puppet
 class { 'puppet_metrics_dashboard':
   add_dashboard_examples => true,
   overwrite_dashboards   => false,
   consume_graphite       => true,
   influxdb_database_name => ['graphite'],
-  master_list            => ['master', 'master02'],
+  master_list            => ['primary', 'compiler01'],
 }
 ```
 
@@ -128,7 +128,9 @@ The following parameters are available in the `puppet_metrics_dashboard` class:
 * [`influxdb_urls`](#influxdb_urls)
 * [`influx_db_service_name`](#influx_db_service_name)
 * [`influx_db_password`](#influx_db_password)
+* [`influx_archive_source`](#influx_archive_source)
 * [`telegraf_db_name`](#telegraf_db_name)
+* [`telegraf_db_retention_duration`](#telegraf_db_retention_duration)
 * [`http_response_timeout`](#http_response_timeout)
 * [`telegraf_agent_interval`](#telegraf_agent_interval)
 * [`pg_query_interval`](#pg_query_interval)
@@ -142,6 +144,9 @@ The following parameters are available in the `puppet_metrics_dashboard` class:
 * [`grafana_version`](#grafana_version)
 * [`overwrite_dashboards_file`](#overwrite_dashboards_file)
 * [`grafana_config`](#grafana_config)
+* [`grafana_manage_repo`](#grafana_manage_repo)
+* [`grafana_archive_source`](#grafana_archive_source)
+* [`grafana_install_method`](#grafana_install_method)
 * [`master_list`](#master_list)
 * [`puppetdb_list`](#puppetdb_list)
 * [`postgres_host_list`](#postgres_host_list)
@@ -238,12 +243,30 @@ Data type: `String`
 The password for the InfluxDB `admin` user.
 Defaults to `puppet`
 
+##### <a name="influx_archive_source"></a>`influx_archive_source`
+
+Data type: `Optional[Stdlib::Httpsurl]`
+
+URL if you want to install influx from tar.gz file
+
+Default value: ``undef``
+
 ##### <a name="telegraf_db_name"></a>`telegraf_db_name`
 
 Data type: `String`
 
 The InfluxDB database where Telegraf metrics are stored.
 
+##### <a name="telegraf_db_retention_duration"></a>`telegraf_db_retention_duration`
+
+Data type: `Optional[String[1]]`
+
+The retention duration for database used for Telegraf metrics. Defaults to undef.
+Specify a value to setup retention duration. Example: `4w` is 4 weeks.
+To update a new duration, set it as undef first and run puppet agent to reset. Then, specify the new value.
+
+Default value: ``undef``
+
 ##### <a name="http_response_timeout"></a>`http_response_timeout`
 
 Data type: `String[2]`
@@ -333,6 +356,35 @@ Data type: `Hash`
 Hash of arbitrary configuration settings to pass to Grafana.
 These are added to `grafana.ini` with top-level keys becoming sections and their key-value children becoming settings.
 
+##### <a name="grafana_manage_repo"></a>`grafana_manage_repo`
+
+Data type: `Boolean`
+
+Whether to configure apt / yum repositories for grafana packages.
+
+Default value: `$manage_repos`
+
+##### <a name="grafana_archive_source"></a>`grafana_archive_source`
+
+Data type: `Optional[Stdlib::Httpsurl]`
+
+URL if you want to install grafana from tar.gz file
+
+Default value: ``undef``
+
+##### <a name="grafana_install_method"></a>`grafana_install_method`
+
+Data type: `Enum['docker', 'archive', 'package', 'repo']`
+
+grafana module allows to specify the installation method.
+Set to 'archive' to install Grafana using the tar archive.
+Set to 'docker' to install Grafana using the official Docker container.
+Set to 'package' to install Grafana using .deb or .rpm packages.
+Set to 'repo' to install Grafana using an apt or yum repository.
+Defaults to 'package'.
+
+Default value: `'repo'`
+
 ##### <a name="master_list"></a>`master_list`
 
 Data type: `Puppet_metrics_dashboard::HostList`
@@ -557,7 +609,8 @@ Default value: ``true``
 
 Data type: `String`
 
-Search user bind dn. If you can provide a single bind expression that matches all possible users, you can skip specifying ldap_bind_password.
+Search user bind dn. If you can provide a single bind expression that matches all possible users,
+you can skip specifying ldap_bind_password.
 
 ##### <a name="ldap_bind_password"></a>`ldap_bind_password`
 
@@ -663,12 +716,26 @@ Install requirements for the voxpupuli/puppet-telegraf module.
 
 #### Examples
 
-##### Apply this class to the Master and any/all Compilers
+##### Apply this class to the Primary Server and any/all Compilers
 
 ```puppet
 include puppet_metrics_dashboard::profile::master::install
 ```
 
+#### Parameters
+
+The following parameters are available in the `puppet_metrics_dashboard::profile::master::install` class:
+
+* [`manage_ldap_auth`](#manage_ldap_auth)
+
+##### <a name="manage_ldap_auth"></a>`manage_ldap_auth`
+
+Data type: `Boolean`
+
+
+
+Default value: ``true``
+
 ### <a name="puppet_metrics_dashboardprofilemasterpostgres_access"></a>`puppet_metrics_dashboard::profile::master::postgres_access`
 
 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
 
 Data type: `String`
 
-The FQDN of the host where telegraf runs.
-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.
+The FQDN of the host where telegraf runs.  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.
 
 Default value: `''`
 
@@ -741,11 +809,11 @@ Default value: `$name`
 
 ### <a name="puppet_metrics_dashboardprofilecompiler"></a>`puppet_metrics_dashboard::profile::compiler`
 
-Apply this class to a master or compiler to collect puppetserver metrics
+Apply this class to a Primary Server or Compiler to collect puppetserver metrics
 
 #### Examples
 
-##### Add telegraf to a master / compiler
+##### Add telegraf to a Primary Server / Compiler
 
 ```puppet
 puppet_metrics_dashboard::profile::compiler{ $facts['networking']['fqdn']:
@@ -774,7 +842,7 @@ Default value: `lookup('puppet_metrics_dashboard::http_response_timeout')`
 
 Data type: `Variant[String,Tuple[String, Integer]]`
 
-The FQDN of the compiler / master.  Defaults to the FQDN of the server where the profile is applied
+The FQDN of the Compiler / Primary Server.  Defaults to the FQDN of the server where the profile is applied
 
 Default value: `$facts['networking']['fqdn']`
 

diff --git a/metadata.json b/metadata.json
@@ -1,6 +1,6 @@
 {
   "name": "puppetlabs-puppet_metrics_dashboard",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "author": "puppetlabs",
   "summary": "A module for managing the installation and configuration of metrics dashboards for Puppet Infrastructure.",
   "license": "Apache-2.0",

diff --git a/pdk.yaml b/pdk.yaml
@@ -0,0 +1,2 @@
+---
+ignore: []