pe_status_check: This class should be enabled if you wish Puppet to notify when pe_status_check indicators are not at optimal valuespe_status_check::agent_status_enable: Enables the execution of agent_status_check fact
pe_status_check::agent_state_summary: provides an overview of all Puppet agents and their error statespe_status_check::agent_summary: Summary report of 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 JSONpe_status_check::infra_role_summary: provides an overview of all PE systems and their rolepe_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
When this class is enabled, when any of the indicators in the pe_status_check fact are false puppet will notify of this, individual tests can be disabled by adding the ID to the indicator_exclusions parameter
include pe_status_checkThe following parameters are available in the pe_status_check class:
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: []
Data type: Hash
Hash containing a descriptiong for each key indicator
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
include pe_status_check::agent_status_enableThe following parameters are available in the pe_status_check::agent_status_enable class:
Data type: Boolean
Flag to enable or disable agent_status_check fact
Default value: true
provides an overview of all Puppet agents and their error states
The following parameters are available in the pe_status_check::agent_state_summary plan:
Data type: Integer[0]
the runinterval for the Puppet Agent in minutes. We consider latest reports that are older than runinterval as unresponsive
Default value: 30
Data type: Boolean
optionally return all healthy nodes, not only the unhealthy
Default value: false
Data type: Boolean
optionally hide unhealthy nodes
Default value: true
Summary report of 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
The following parameters are available in the pe_status_check::agent_summary plan:
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
Data type: Array[String[1]]
List of disabled indicators, place any indicator ids you do not wish to report on in this list Static Hiera Data can be used to set indicator_exclusions in a plan - for more information see https://www.puppet.com/docs/pe/latest/writing_plans_in_puppet_language_pe.html#using_hiera_with_plans
Default value: lookup('pe_status_check::indicator_exclusions', undef, undef, [])
provides an overview of all PE systems and their role
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
The following parameters are available in the pe_status_check::infra_summary plan:
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
Data type: Array[String[1]]
List of disabled indicators, place any indicator ids you do not wish to report on in this list Static Hiera Data can be used to set indicator_exclusions in a plan - for more information see https://www.puppet.com/docs/pe/latest/writing_plans_in_puppet_language_pe.html#using_hiera_with_plans
Default value: lookup('pe_status_check::indicator_exclusions', undef, undef, [])