REFERENCE.md

Reference

Table of Contents

Classes

• tls_checker: Configure tls_checker

Defined types

• tls_checker::watch: summary Add TLS endpoints to monitor

Functions

• tls_checker::watched_endpoints: Extract watched TLS endpoints from PuppetDB

Classes

tls_checker

Configure tls_checker

Parameters

The following parameters are available in the tls_checker class:

• package_provider
• tls_checker_path
• logfile
• ensure
• hour
• minute
• month
• monthday
• weekday
• user
• group

package_provider

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

Which package provider to use

tls_checker_path

Data type: String

Path to tls-checker

logfile

Data type: String

Logfile to store certificates status

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

ensure

Data type: String

Default value: 'installed'

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 TLS status as

Default value: undef

group

Data type: Optional[String]

Group to check TLS status as

Default value: undef

Defined types

tls_checker::watch

summary Add TLS endpoints to monitor

Parameters

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

• endpoints

endpoints

Data type: Variant[Array[String], String]

Endpoints to monitor

Default value: $title

Functions

tls_checker::watched_endpoints

Type: Puppet Language

Extract watched TLS endpoints from PuppetDB

tls_checker::watched_endpoints()

The tls_checker::watched_endpoints function.

Returns: Array[String] An array of TLS endpoints