Skip to content

Commit

Permalink
Merge pull request #226 from puppetlabs/release-prep
Browse files Browse the repository at this point in the history
Release prep v2.4.0
  • Loading branch information
MartyEwings authored Nov 28, 2024
2 parents 08c69d6 + f7a3021 commit b436422
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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.3.0](https://github.com/puppetlabs/puppet_operational_dashboards/tree/v2.3.0) (2024-02-03)
## [v2.3.0](https://github.com/puppetlabs/puppet_operational_dashboards/tree/v2.3.0) (2024-02-05)

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

Expand Down
37 changes: 37 additions & 0 deletions REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ The following parameters are available in the `puppet_operational_dashboards` cl
* [`telegraf_token`](#-puppet_operational_dashboards--telegraf_token)
* [`include_pe_metrics`](#-puppet_operational_dashboards--include_pe_metrics)
* [`manage_system_board`](#-puppet_operational_dashboards--manage_system_board)
* [`template_format`](#-puppet_operational_dashboards--template_format)

##### <a name="-puppet_operational_dashboards--manage_influxdb"></a>`manage_influxdb`

Expand Down Expand Up @@ -211,6 +212,14 @@ Whether the System Performance dashboard should be added to grafana

Default value: `true`

##### <a name="-puppet_operational_dashboards--template_format"></a>`template_format`

Data type: `Enum['yaml','toml']`

Template format to use for puppet template toml or yaml config

Default value: `'toml'`

### <a name="puppet_operational_dashboards--enterprise_infrastructure"></a>`puppet_operational_dashboards::enterprise_infrastructure`

When applied to an appropriate node group this class applies the toml gem and database access
Expand All @@ -229,6 +238,7 @@ include puppet_operational_dashboards::enterprise_infrastructure
The following parameters are available in the `puppet_operational_dashboards::enterprise_infrastructure` class:

* [`profiles`](#-puppet_operational_dashboards--enterprise_infrastructure--profiles)
* [`template_format`](#-puppet_operational_dashboards--enterprise_infrastructure--template_format)

##### <a name="-puppet_operational_dashboards--enterprise_infrastructure--profiles"></a>`profiles`

Expand All @@ -238,6 +248,14 @@ Array of PE profiles on the node with this class applied.

Default value: `puppet_operational_dashboards::pe_profiles_on_host()`

##### <a name="-puppet_operational_dashboards--enterprise_infrastructure--template_format"></a>`template_format`

Data type: `Enum['yaml','toml']`

Template format to use for puppet template toml or yaml config

Default value: `'toml'`

### <a name="puppet_operational_dashboards--profile--dashboards"></a>`puppet_operational_dashboards::profile::dashboards`

Installs Grafana and several dashboards to display Puppet metrics. Included via the base class.
Expand Down Expand Up @@ -630,6 +648,7 @@ The following parameters are available in the `puppet_operational_dashboards::te
* [`telegraf_postgres_password`](#-puppet_operational_dashboards--telegraf--agent--telegraf_postgres_password)
* [`postgres_port`](#-puppet_operational_dashboards--telegraf--agent--postgres_port)
* [`postgres_options`](#-puppet_operational_dashboards--telegraf--agent--postgres_options)
* [`template_format`](#-puppet_operational_dashboards--telegraf--agent--template_format)

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

Expand Down Expand Up @@ -937,6 +956,14 @@ Default value:
}
```

##### <a name="-puppet_operational_dashboards--telegraf--agent--template_format"></a>`template_format`

Data type: `Enum['yaml','toml']`

Template format to use for puppet template toml or yaml config

Default value: `$puppet_operational_dashboards::template_format`

## Defined types

### <a name="puppet_operational_dashboards--telegraf--config"></a>`puppet_operational_dashboards::telegraf::config`
Expand All @@ -952,6 +979,7 @@ The following parameters are available in the `puppet_operational_dashboards::te
* [`hosts`](#-puppet_operational_dashboards--telegraf--config--hosts)
* [`ensure`](#-puppet_operational_dashboards--telegraf--config--ensure)
* [`http_timeout_seconds`](#-puppet_operational_dashboards--telegraf--config--http_timeout_seconds)
* [`template_format`](#-puppet_operational_dashboards--telegraf--config--template_format)

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

Expand Down Expand Up @@ -987,6 +1015,14 @@ Data type: `Integer[1]`

Timeout for HTTP Telegraf inputs. Might be usefull in huge environments with slower API responses

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

Data type: `Enum['yaml','toml']`

Template format to use for puppet template toml or yaml config

Default value: `'toml'`

## Functions

### <a name="puppet_operational_dashboards--hosts_with_profile"></a>`puppet_operational_dashboards::hosts_with_profile`
Expand Down Expand Up @@ -1194,3 +1230,4 @@ The following parameters are available in the `puppet_operational_dashboards::pr
Data type: `TargetSpec`

The targets to run on.

2 changes: 1 addition & 1 deletion metadata.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "puppetlabs-puppet_operational_dashboards",
"version": "2.3.0",
"version": "2.4.0",
"author": "Adrian Parreiras Horta",
"summary": "A module for managing the installation and configuration of metrics dashboards for Puppet Infrastructure.",
"license": "Apache-2.0",
Expand Down

0 comments on commit b436422

Please sign in to comment.