Skip to content

Latest commit

 

History

History
146 lines (83 loc) · 3.86 KB

REFERENCE.md

File metadata and controls

146 lines (83 loc) · 3.86 KB

Reference

Table of Contents

Classes

Data types

Plans

  • puppet_status_check::summary: Summary report if the state of status check on each node Uses the facts task to get the current status from each node and produces a summary report in JSON

Classes

puppet_status_check

When this class is included and enabled, any of the indicators in the puppet_status_check fact that are false will add a notify resource to the catalog. Individual indicators can be disabled by adding the ID to the indicator_exclusions parameter.

Examples

include 'puppet_status_check':

Parameters

The following parameters are available in the puppet_status_check class:

enabled

Data type: Boolean

Enable checks

Default value: true

role

Data type: Puppet_status_check::Role

Role node performs

Default value: 'agent'

indicate

Data type: Boolean

Enable notify resources for failed checks

Default value: true

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: ['AS003', 'S0006']

checks

Data type: Hash

Hash containing a description for each check

postgresql_service

Data type: String

Name of postgresql service unit

Default value: 'postgresql'

pg_config_path

Data type: String

Path to postgresql pg_config binary

Default value: 'pg_config'

Data types

Puppet_status_check::Role

puppet status check role

Alias of Enum['primary', 'compiler', 'postgres', 'agent']

Plans

puppet_status_check::summary

Summary report if the state of status check on each node Uses the facts task to get the current status from each node and produces a summary report in JSON

Parameters

The following parameters are available in the puppet_status_check::summary plan:

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

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 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('puppet_status_check::indicator_exclusions', undef, undef, [])