Skip to content

Latest commit

 

History

History
479 lines (240 loc) · 11.6 KB

REFERENCE.md

File metadata and controls

479 lines (240 loc) · 11.6 KB

Reference

Table of Contents

Classes

Defined types

Functions

Tasks

Classes

pe_databases

Tuning, maintenance for PE PostgreSQL.

Parameters

The following parameters are available in the pe_databases class:

disable_maintenance

Data type: Boolean

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

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

manage_postgresql_settings

Data type: Boolean

true or false (Default: true) Manage PostgreSQL settings

Default value: true

manage_table_settings

Data type: Boolean

true or false (Default: false) Manage table settings

Default value: false

install_dir

Data type: String

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

Default value: '/opt/puppetlabs/pe_databases'

scripts_dir

Data type: String

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

Default value: "${install_dir}/scripts"

manage_database_maintenance

Data type: Boolean

Default value: true

pe_databases::pg_repack

Maintenance pg_repack

Parameters

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

disable_maintenance

Data type: Boolean

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

Default value: false

jobs

Data type: Integer

How many jobs to run in parallel

Default value: /

pe_databases::postgresql_settings

Tune PostgreSQL

Parameters

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

maintenance_work_mem

Data type: String

Increase to improve speed of speed of vacuuming and reindexing (Example "1GB")

Default value: $all_in_one_pe_install

work_mem

Data type: String

Allows PostgreSQL to do larger in-memory sorts (Default: "4MB")

Default value: '8MB'

autovacumn_work_mem

Data type: String

Similar to but for maintenance_work_mem autovacuum processes only (Example "256MB")

autovacuum_max_workers

Data type: Integer

Maximum number of autovacuum processes to run concurrently (Default: 3)

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

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

log_autovacuum_min_duration

Data type: Integer

Default value: -

log_temp_files

Data type: Integer

Default value: -

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

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

Tune PostgreSQL table settings

Parameters

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

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

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

pe_databases::set_puppetdb_table_autovacuum_cost_delay_zero

Defined type for PostgreSQL autovacuum_cost_delay

Parameters

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

table_name

Data type: String

Name of the table

Default value: $title

pe_databases::set_table_attribute

Defined type for PostgreSQL table attributes

Parameters

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

db

Data type: String

Name of the database, this is pe-puppetdb for the uses of this module.

table_name

Data type: String

Name of the table in the database.

table_attribute

Data type: String

Set to the table attribute value.

table_attribute_value

Data type: String

Value of setting for the table set in table_settings.pp

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