REFERENCE.md

Reference

Table of Contents

Classes

• certificate_checker: Configure certificate_checker

Defined types

• certificate_checker::watch: Add certificates to monitor

Functions

• certificate_checker::watched_paths: Extract watched paths from PuppetDB

Classes

certificate_checker

Configure certificate_checker

Parameters

The following parameters are available in the certificate_checker class:

• package_provider
• certificate_checker_path
• logfile
• ensure
• ignore_nonexistent
• hour
• minute
• month
• monthday
• weekday
• user
• group

package_provider

Data type: Enum['gem', 'puppet_gem']

certificate_checker_path

Data type: String

logfile

Data type: String

Logfile to store certificates status

Default value: '/var/log/certificate-checker.jsonl'

ensure

Data type: String

Default value: 'installed'

ignore_nonexistent

Data type: Boolean

Ignore non-existent files. Requires certificate-checker 1.2+

Default value: false

hour

Data type: Any

Default value: '*/4'

minute

Data type: Any

Default value: fqdn_rand(60)

month

Data type: Any

Default value: undef

monthday

Data type: Any

Default value: undef

weekday

Data type: Any

Default value: undef

user

Data type: Optional[String]

User to check certificates status as

Default value: undef

group

Data type: Optional[String]

Group to check certificates status as

Default value: undef

Defined types

certificate_checker::watch

Add certificates to monitor

Parameters

The following parameters are available in the certificate_checker::watch defined type:

• paths

paths

Data type: Variant[Array[Stdlib::Absolutepath], Stdlib::Absolutepath]

Paths to certificates to monitor

Default value: $title

Functions

certificate_checker::watched_paths

Type: Puppet Language

Extract watched paths from PuppetDB

certificate_checker::watched_paths()

The certificate_checker::watched_paths function.

Returns: Array[Stdlib::Absolutepath] An array of paths