Skip to content

Commit

Permalink
Merge pull request #182 from puppetlabs/release-prep
Browse files Browse the repository at this point in the history
Release prep v2.6.0
  • Loading branch information
MartyEwings authored Jan 23, 2023
2 parents acd3f5a + 96bc8ec commit 70899f3
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 22 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@

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/puppetlabs-pe_status_check/tree/v2.6.0) (2023-01-23)

[Full Changelog](https://github.com/puppetlabs/puppetlabs-pe_status_check/compare/v2.5.1...v2.6.0)

### Added

- \(SUP-3703\) Add indicator S0044 node\_terminus is the PE classifier [\#181](https://github.com/puppetlabs/puppetlabs-pe_status_check/pull/181) ([taikaa](https://github.com/taikaa))
- \(SUP-3696\) Added S0043 to determine whether there are nodes with Puppet agent versions ahead of the primary server [\#180](https://github.com/puppetlabs/puppetlabs-pe_status_check/pull/180) ([taikaa](https://github.com/taikaa))

## [v2.5.1](https://github.com/puppetlabs/puppetlabs-pe_status_check/tree/v2.5.1) (2022-11-10)

[Full Changelog](https://github.com/puppetlabs/puppetlabs-pe_status_check/compare/v2.5.0...v2.5.1)
Expand Down
42 changes: 21 additions & 21 deletions REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@
### Classes

* [`pe_status_check`](#pe_status_check): This class should be enabled if you wish Puppet to notify when pe_status_check indicators are not at optimal values
* [`pe_status_check::agent_status_enable`](#pe_status_checkagent_status_enable): Enables the execution of agent_status_check fact
* [`pe_status_check::agent_status_enable`](#pe_status_check--agent_status_enable): Enables the execution of agent_status_check fact

### Plans

* [`pe_status_check::agent_summary`](#pe_status_checkagent_summary): Summary report if the state of agent_status_check on each node
* [`pe_status_check::agent_summary`](#pe_status_check--agent_summary): Summary report if the state of agent_status_check on each node
Uses the facts task to get the current status from each node
and produces a summary report in JSON
* [`pe_status_check::infra_summary`](#pe_status_checkinfra_summary): Summary report if the state of pe_status check on each node
* [`pe_status_check::infra_summary`](#pe_status_check--infra_summary): Summary report if the state of pe_status check on each node
Uses the facts task to get the current status from each node
and produces a summary report in JSON

Expand All @@ -37,17 +37,17 @@ include pe_status_check

The following parameters are available in the `pe_status_check` class:

* [`indicator_exclusions`](#indicator_exclusions)
* [`indicator_exclusions`](#-pe_status_check--indicator_exclusions)

##### <a name="indicator_exclusions"></a>`indicator_exclusions`
##### <a name="-pe_status_check--indicator_exclusions"></a>`indicator_exclusions`

Data type: `Array[String[1]]`

List of disabled indicators, place any indicator ids you do not wish to report on in this list

Default value: `[]`

### <a name="pe_status_checkagent_status_enable"></a>`pe_status_check::agent_status_enable`
### <a name="pe_status_check--agent_status_enable"></a>`pe_status_check::agent_status_enable`

Adding this class will enable the execution of the agent_status_check fact,
This allows the fact to be targeted to a specific agent or group of agents
Expand All @@ -64,19 +64,19 @@ include pe_status_check::agent_status_enable

The following parameters are available in the `pe_status_check::agent_status_enable` class:

* [`agent_status_enabled`](#agent_status_enabled)
* [`agent_status_enabled`](#-pe_status_check--agent_status_enable--agent_status_enabled)

##### <a name="agent_status_enabled"></a>`agent_status_enabled`
##### <a name="-pe_status_check--agent_status_enable--agent_status_enabled"></a>`agent_status_enabled`

Data type: `Boolean`

Flag to enable or disable agent_status_check fact

Default value: ``true``
Default value: `true`

## Plans

### <a name="pe_status_checkagent_summary"></a>`pe_status_check::agent_summary`
### <a name="pe_status_check--agent_summary"></a>`pe_status_check::agent_summary`

Summary report if the state of agent_status_check on each node
Uses the facts task to get the current status from each node
Expand All @@ -86,27 +86,27 @@ and produces a summary report in JSON

The following parameters are available in the `pe_status_check::agent_summary` plan:

* [`targets`](#targets)
* [`indicator_exclusions`](#indicator_exclusions)
* [`targets`](#-pe_status_check--agent_summary--targets)
* [`indicator_exclusions`](#-pe_status_check--agent_summary--indicator_exclusions)

##### <a name="targets"></a>`targets`
##### <a name="-pe_status_check--agent_summary--targets"></a>`targets`

Data type: `Optional[TargetSpec]`

A comma seprated list of FQDN's of Puppet agent nodes
Defaults to using a PuppetDB query to identify nodes

Default value: ``undef``
Default value: `undef`

##### <a name="indicator_exclusions"></a>`indicator_exclusions`
##### <a name="-pe_status_check--agent_summary--indicator_exclusions"></a>`indicator_exclusions`

Data type: `Array[String[1]]`

List of disabled indicators, place any indicator ids you do not wish to report on in this list

Default value: `[]`

### <a name="pe_status_checkinfra_summary"></a>`pe_status_check::infra_summary`
### <a name="pe_status_check--infra_summary"></a>`pe_status_check::infra_summary`

Summary report if the state of pe_status check on each node
Uses the facts task to get the current status from each node
Expand All @@ -116,19 +116,19 @@ and produces a summary report in JSON

The following parameters are available in the `pe_status_check::infra_summary` plan:

* [`targets`](#targets)
* [`indicator_exclusions`](#indicator_exclusions)
* [`targets`](#-pe_status_check--infra_summary--targets)
* [`indicator_exclusions`](#-pe_status_check--infra_summary--indicator_exclusions)

##### <a name="targets"></a>`targets`
##### <a name="-pe_status_check--infra_summary--targets"></a>`targets`

Data type: `Optional[TargetSpec]`

A comma seprated list of FQDN's of Puppet infrastructure agent nodes
Defaults to using a PuppetDB query to identify nodes

Default value: ``undef``
Default value: `undef`

##### <a name="indicator_exclusions"></a>`indicator_exclusions`
##### <a name="-pe_status_check--infra_summary--indicator_exclusions"></a>`indicator_exclusions`

Data type: `Array[String[1]]`

Expand Down
2 changes: 1 addition & 1 deletion metadata.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "puppetlabs-pe_status_check",
"version": "2.5.1",
"version": "2.6.0",
"author": "Marty Ewings",
"summary": "A Puppet Enterprise Module to Promote Preventative Maintenance and Self Service",
"license": "Apache-2.0",
Expand Down

0 comments on commit 70899f3

Please sign in to comment.