REFERENCE.md

Reference

Table of Contents

Classes

• pe_databases: Tuning, maintenance for PE PostgreSQL.
• pe_databases::pg_repack: Provides systemd timers to pg_repack tables in a given database

Defined types

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

Tasks

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

Classes

pe_databases

Tuning, maintenance for PE PostgreSQL.

Parameters

The following parameters are available in the pe_databases class:

• manage_database_maintenance
• disable_maintenance
• install_dir
• scripts_dir
• facts_tables_repack_timer
• catalogs_tables_repack_timer
• other_tables_repack_timer
• activity_tables_repack_timer
• manage_postgresql_settings
• manage_table_settings
• reports_tables_repack_timer
• resource_events_tables_repack_timer

manage_database_maintenance

Data type: Boolean

true or false (Default: true) Manage the inclusion of the pg_repack class

Default value: true

disable_maintenance

Data type: Boolean

true or false (Default: false) Disable or enable maintenance mode

Default value: false

install_dir

Data type: String[1]

Directory to install module into (Default: "/opt/puppetlabs/pe_databases")

Default value: '/opt/puppetlabs/pe_databases'

scripts_dir

Data type: String[1]

Directory to install scripts into (Default: "${install_dir}/scripts")

Default value: "${install_dir}/scripts"

facts_tables_repack_timer

Data type: String[1]

The Systemd timer for the pg_repack job affecting the 'facts' tables

catalogs_tables_repack_timer

Data type: String[1]

The Systemd timer for the pg_repack job affecting the 'catalog' tables

other_tables_repack_timer

Data type: String[1]

The Systemd timer for the pg_repack job affecting the 'other' tables

activity_tables_repack_timer

Data type: String[1]

The Systemd timer for the pg_repack job affecting the 'activity' tables

manage_postgresql_settings

Data type: Optional[Boolean]

Deprecated Parameter will be removed in future releases

Default value: undef

manage_table_settings

Data type: Optional[Boolean]

Deprecated Parameter will be removed in future releases

Default value: undef

reports_tables_repack_timer

Data type: Optional[String]

Deprecated Parameter will be removed in future releases

Default value: undef

resource_events_tables_repack_timer

Data type: Optional[String]

Deprecated Parameter will be removed in future releases

Default value: undef

pe_databases::pg_repack

Maintenance pg_repack

Parameters

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

• fact_tables
• catalog_tables
• other_tables
• activity_tables
• disable_maintenance
• repack_log_level
• enable_echo
• jobs
• facts_tables_repack_timer
• catalogs_tables_repack_timer
• other_tables_repack_timer
• activity_tables_repack_timer
• reports_tables_repack_timer
• resource_events_tables_repack_timer

fact_tables

Data type: Array

Array of 'fact' tables to repack

catalog_tables

Data type: Array

Array of 'catalog' tables to repack

other_tables

Data type: Array

Array of 'other' tables to repack

activity_tables

Data type: Array

Array of 'activity' tables to repack

disable_maintenance

Data type: Boolean

true or false (Default: false) Disable or enable maintenance mode

Default value: false

repack_log_level

Data type: Enum['INFO','NOTICE','WARNING','ERROR','LOG','FATAL','PANIC','DEBUG']

Desired output level of logs

Default value: 'DEBUG'

enable_echo

Data type: Boolean

true or false (Default: true) Enabling echo output in logs

Default value: true

jobs

Data type: Integer

How many jobs to run in parallel

Default value: $facts['processors']['count'] / 4

facts_tables_repack_timer

Data type: String[1]

The Systemd timer for the pg_repack job affecting the 'facts' tables

Default value: $pe_databases::facts_tables_repack_timer

catalogs_tables_repack_timer

Data type: String[1]

The Systemd timer for the pg_repack job affecting the 'catalog' tables

Default value: $pe_databases::catalogs_tables_repack_timer

other_tables_repack_timer

Data type: String[1]

The Systemd timer for the pg_repack job affecting the 'other' tables

Default value: $pe_databases::other_tables_repack_timer

activity_tables_repack_timer

Data type: String[1]

The Systemd timer for the pg_repack job affecting the 'activity' tables

Default value: $pe_databases::activity_tables_repack_timer

reports_tables_repack_timer

Data type: Optional[String]

Deprecated Parameter will be removed in future releases

Default value: undef

resource_events_tables_repack_timer

Data type: Optional[String]

Deprecated Parameter will be removed in future releases

Default value: undef

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
• tables

database_type

Data type: String

The database to repack, uses titles from pg_repack.pp

Default value: $title

command

Data type: String

defined in pg_repack.pp

Default value: undef

disable_maintenance

Data type: Boolean

to disable maintenance mode (Default: false)

Default value: false

on_cal

Data type: String

values can be found in pg_repack.pp

Default value: undef

tables

Data type: Array

Array of tables to repack

Default value: undef

Tasks

reset_pgrepack_schema

This task will remove and recreate the pg_repack extension

Supports noop? false