REFERENCE.md

Reference

Table of Contents

Classes

• pe_databases
• pe_databases::backup
• pe_databases::pg_repack
• pe_databases::postgresql_settings
• pe_databases::postgresql_settings::table_settings

Defined types

• pe_databases::collect: Create systemd units for repacking a given database type
• pe_databases::set_puppetdb_table_autovacuum_cost_delay_zero
• pe_databases::set_table_attribute

Functions

• pe_databases::version_based_databases

Tasks

• reset_pgrepack_schema: This task will remove and recreate the pg_repack extension

Classes

pe_databases

The pe_databases class.

Parameters

The following parameters are available in the pe_databases class:

• manage_database_backups
• manage_database_maintenance
• disable_maintenance
• manage_postgresql_settings
• manage_table_settings
• install_dir
• scripts_dir

manage_database_backups

Data type: Variant[Boolean,Undef]

Default value: undef

manage_database_maintenance

Data type: Boolean

Default value: true

disable_maintenance

Data type: Boolean

Default value: lookup('pe_databases::disable_maintenance', {'default_value' => false})

manage_postgresql_settings

Data type: Boolean

Default value: true

manage_table_settings

Data type: Boolean

Default value: true

install_dir

Data type: String

Default value: '/opt/puppetlabs/pe_databases'

scripts_dir

Data type: String

Default value: "${install_dir}/scripts"

pe_databases::backup

The pe_databases::backup class.

Parameters

The following parameters are available in the pe_databases::backup class:

• databases_and_backup_schedule
• psql_version
• backup_directory
• backup_script_path
• daily_databases_path
• backup_logging_directory
• retention_policy
• disable_maintenance

databases_and_backup_schedule

Data type: Array[Hash]

Default value: [ { 'databases' => pe_databases::version_based_databases(), 'schedule' => { 'minute' => '30', 'hour' => '22', }, }, { 'databases' => ['pe-puppetdb'], 'schedule' => { 'minute' => '0', 'hour' => '2', 'weekday' => '7', }, } ]

psql_version

Data type: String

Default value: $pe_databases::psql_version

backup_directory

Data type: String

Default value: "/opt/puppetlabs/server/data/postgresql/${psql_version}/backups"

backup_script_path

Data type: String

Default value: "${pe_databases::scripts_dir}/puppet_enterprise_database_backup.sh"

daily_databases_path

Data type: String

Default value: "${pe_databases::install_dir}/default_daily_databases.txt"

backup_logging_directory

Data type: String

Default value: '/var/log/puppetlabs/pe_databases_backup'

retention_policy

Data type: Integer

Default value: 2

disable_maintenance

Data type: Boolean

Default value: true

pe_databases::pg_repack

The pe_databases::pg_repack class.

Parameters

The following parameters are available in the pe_databases::pg_repack class:

• disable_maintenance
• jobs

disable_maintenance

Data type: Boolean

Default value: false

jobs

Data type: Integer

Default value: /

pe_databases::postgresql_settings

The pe_databases::postgresql_settings class.

Parameters

The following parameters are available in the pe_databases::postgresql_settings class:

• autovacuum_vacuum_scale_factor
• autovacuum_analyze_scale_factor
• autovacuum_max_workers
• log_autovacuum_min_duration
• log_temp_files
• work_mem
• max_connections
• arbitrary_postgresql_conf_settings
• checkpoint_completion_target
• checkpoint_segments
• manage_postgresql_service
• all_in_one_pe_install
• manage_reports_autovacuum_cost_delay
• factsets_autovacuum_vacuum_scale_factor
• reports_autovacuum_vacuum_scale_factor
• maintenance_work_mem
• autovacuum_work_mem
• psql_version

autovacuum_vacuum_scale_factor

Data type: Float[0,1]

Default value: 0.08

autovacuum_analyze_scale_factor

Data type: Float[0,1]

Default value: 0.04

autovacuum_max_workers

Data type: Integer

Default value: max(3, min(8, $facts['processors']['count'] / 3))

log_autovacuum_min_duration

Data type: Integer

Default value: -

log_temp_files

Data type: Integer

Default value: -

work_mem

Data type: String

Default value: '8MB'

max_connections

Data type: Integer

Default value: 1000

arbitrary_postgresql_conf_settings

Data type: Hash

Default value: {}

checkpoint_completion_target

Data type: Float[0,1]

Default value: 0.9

checkpoint_segments

Data type: Integer

Default value: 128

manage_postgresql_service

Data type: Boolean

Default value: true

all_in_one_pe_install

Data type: Boolean

Default value: true

manage_reports_autovacuum_cost_delay

Data type: Boolean

Default value: true

factsets_autovacuum_vacuum_scale_factor

Data type: Optional[Float[0,1]]

Default value: 0.80

reports_autovacuum_vacuum_scale_factor

Data type: Optional[Float[0,1]]

Default value: 0.01

maintenance_work_mem

Data type: String

Default value: $all_in_one_pe_install

autovacuum_work_mem

Data type: String

Default value: $all_in_one_pe_install

psql_version

Data type: String

Default value: $pe_databases::psql_version

pe_databases::postgresql_settings::table_settings

The pe_databases::postgresql_settings::table_settings class.

Parameters

The following parameters are available in the pe_databases::postgresql_settings::table_settings class:

• manage_reports_autovacuum_cost_delay
• factsets_autovacuum_vacuum_scale_factor
• reports_autovacuum_vacuum_scale_factor
• catalogs_autovacuum_vacuum_scale_factor
• certnames_autovacuum_vacuum_scale_factor

manage_reports_autovacuum_cost_delay

Data type: Boolean

Default value: lookup('pe_databases::postgresql_settings::manage_reports_autovacuum_cost_delay', {'default_value' => true})

factsets_autovacuum_vacuum_scale_factor

Data type: Optional[Float[0,1]]

Default value: lookup('pe_databases::postgresql_settings::factsets_autovacuum_vacuum_scale_factor', {'default_value' => 0.80})

reports_autovacuum_vacuum_scale_factor

Data type: Optional[Float[0,1]]

Default value: lookup('pe_databases::postgresql_settings::reports_autovacuum_vacuum_scale_factor', {'default_value' => 0.01})

catalogs_autovacuum_vacuum_scale_factor

Data type: Optional[Float[0,1]]

Default value: 0.75

certnames_autovacuum_vacuum_scale_factor

Data type: Optional[Float[0,1]]

Default value: 0.75

Defined types

pe_databases::collect

Create systemd units for repacking a given database type

Parameters

The following parameters are available in the pe_databases::collect defined type:

• database_type
• command
• disable_maintenance
• on_cal

database_type

Data type: String

Default value: $title

command

Data type: String

Default value: undef

disable_maintenance

Data type: Boolean

Default value: false

on_cal

Data type: String

Default value: undef

pe_databases::set_puppetdb_table_autovacuum_cost_delay_zero

The pe_databases::set_puppetdb_table_autovacuum_cost_delay_zero class.

Parameters

The following parameters are available in the pe_databases::set_puppetdb_table_autovacuum_cost_delay_zero defined type:

• table_name

table_name

Data type: String

Default value: $title

pe_databases::set_table_attribute

The pe_databases::set_table_attribute class.

Parameters

The following parameters are available in the pe_databases::set_table_attribute defined type:

• db
• table_name
• table_attribute
• table_attribute_value

db

Data type: String

table_name

Data type: String

table_attribute

Data type: String

table_attribute_value

Data type: String

Functions

pe_databases::version_based_databases

Type: Puppet Language

The pe_databases::version_based_databases function.

pe_databases::version_based_databases()

The pe_databases::version_based_databases function.

Returns: Array[String]

Tasks

reset_pgrepack_schema

This task will remove and recreate the pg_repack extension

Supports noop? false