diff --git a/CHANGELOG.md b/CHANGELOG.md index b2c1046..6a073da 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,15 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## [v2.3.0](https://github.com/puppetlabs/puppetlabs-pe_databases/tree/v2.3.0) (2022-07-21) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-pe_databases/compare/v2.2.0...v2.3.0) + +### Added + +- \(SUP-3409\) Update puppet strings comments [\#104](https://github.com/puppetlabs/puppetlabs-pe_databases/pull/104) ([elainemccloskey](https://github.com/elainemccloskey)) +- \(SUP-3408\) Remove deprecated backup functionality [\#103](https://github.com/puppetlabs/puppetlabs-pe_databases/pull/103) ([elainemccloskey](https://github.com/elainemccloskey)) + ## [v2.2.0](https://github.com/puppetlabs/puppetlabs-pe_databases/tree/v2.2.0) (2021-10-06) [Full Changelog](https://github.com/puppetlabs/puppetlabs-pe_databases/compare/v2.1.1...v2.2.0) diff --git a/REFERENCE.md b/REFERENCE.md index 6be4a69..e48c492 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -6,17 +6,16 @@ ### Classes -* [`pe_databases`](#pe_databases) -* [`pe_databases::backup`](#pe_databasesbackup) -* [`pe_databases::pg_repack`](#pe_databasespg_repack) -* [`pe_databases::postgresql_settings`](#pe_databasespostgresql_settings) -* [`pe_databases::postgresql_settings::table_settings`](#pe_databasespostgresql_settingstable_settings) +* [`pe_databases`](#pe_databases): Tuning, maintenance for PE PostgreSQL. +* [`pe_databases::pg_repack`](#pe_databasespg_repack): Provides systemd timers to pg_repack tables in the pe-puppetdb database +* [`pe_databases::postgresql_settings`](#pe_databasespostgresql_settings): Tune PostgreSQL settings +* [`pe_databases::postgresql_settings::table_settings`](#pe_databasespostgresql_settingstable_settings): Tune PostgreSQL table settings ### Defined types * [`pe_databases::collect`](#pe_databasescollect): Create systemd units for repacking a given database type -* [`pe_databases::set_puppetdb_table_autovacuum_cost_delay_zero`](#pe_databasesset_puppetdb_table_autovacuum_cost_delay_zero) -* [`pe_databases::set_table_attribute`](#pe_databasesset_table_attribute) +* [`pe_databases::set_puppetdb_table_autovacuum_cost_delay_zero`](#pe_databasesset_puppetdb_table_autovacuum_cost_delay_zero): Defined type for PostgreSQL autovacuum_cost_delay +* [`pe_databases::set_table_attribute`](#pe_databasesset_table_attribute): Defined type for PostgreSQL table attributes ### Functions @@ -30,41 +29,25 @@ ### `pe_databases` -The pe_databases class. +Tuning, maintenance for PE PostgreSQL. #### Parameters The following parameters are available in the `pe_databases` class: -* [`manage_database_backups`](#manage_database_backups) -* [`manage_database_maintenance`](#manage_database_maintenance) * [`disable_maintenance`](#disable_maintenance) * [`manage_postgresql_settings`](#manage_postgresql_settings) * [`manage_table_settings`](#manage_table_settings) * [`install_dir`](#install_dir) * [`scripts_dir`](#scripts_dir) - -##### `manage_database_backups` - -Data type: `Variant[Boolean,Undef]` - - - -Default value: ``undef`` - -##### `manage_database_maintenance` - -Data type: `Boolean` - - - -Default value: ``true`` +* [`manage_database_maintenance`](#manage_database_maintenance) ##### `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})` @@ -72,7 +55,8 @@ Default value: `lookup('pe_databases::disable_maintenance', {'default_value' => Data type: `Boolean` - +true or false (Default: true) +Manage PostgreSQL settings Default value: ``true`` @@ -80,7 +64,8 @@ Default value: ``true`` Data type: `Boolean` - +true or false (Default: false) +Manage table settings Default value: ``false`` @@ -88,7 +73,7 @@ Default value: ``false`` Data type: `String` - +Directory to install module into (Default: "/opt/puppetlabs/pe_databases") Default value: `'/opt/puppetlabs/pe_databases'` @@ -96,102 +81,11 @@ Default value: `'/opt/puppetlabs/pe_databases'` Data type: `String` - +Directory to install scripts into (Default: "${install_dir}/scripts") 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`](#databases_and_backup_schedule) -* [`psql_version`](#psql_version) -* [`backup_directory`](#backup_directory) -* [`backup_script_path`](#backup_script_path) -* [`daily_databases_path`](#daily_databases_path) -* [`backup_logging_directory`](#backup_logging_directory) -* [`retention_policy`](#retention_policy) -* [`disable_maintenance`](#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` +##### `manage_database_maintenance` Data type: `Boolean` @@ -201,7 +95,7 @@ Default value: ``true`` ### `pe_databases::pg_repack` -The pe_databases::pg_repack class. +Maintenance pg_repack #### Parameters @@ -214,7 +108,8 @@ The following parameters are available in the `pe_databases::pg_repack` class: Data type: `Boolean` - +true or false (Default: false) +Disable or enable maintenance mode Default value: ``false`` @@ -222,24 +117,26 @@ Default value: ``false`` Data type: `Integer` - +How many jobs to run in parallel Default value: `/` ### `pe_databases::postgresql_settings` -The pe_databases::postgresql_settings class. +Tune PostgreSQL #### Parameters The following parameters are available in the `pe_databases::postgresql_settings` class: +* [`maintenance_work_mem`](#maintenance_work_mem) +* [`work_mem`](#work_mem) +* [`autovacumn_work_mem`](#autovacumn_work_mem) +* [`autovacuum_max_workers`](#autovacuum_max_workers) * [`autovacuum_vacuum_scale_factor`](#autovacuum_vacuum_scale_factor) * [`autovacuum_analyze_scale_factor`](#autovacuum_analyze_scale_factor) -* [`autovacuum_max_workers`](#autovacuum_max_workers) * [`log_autovacuum_min_duration`](#log_autovacuum_min_duration) * [`log_temp_files`](#log_temp_files) -* [`work_mem`](#work_mem) * [`max_connections`](#max_connections) * [`arbitrary_postgresql_conf_settings`](#arbitrary_postgresql_conf_settings) * [`checkpoint_completion_target`](#checkpoint_completion_target) @@ -249,43 +146,56 @@ The following parameters are available in the `pe_databases::postgresql_settings * [`manage_reports_autovacuum_cost_delay`](#manage_reports_autovacuum_cost_delay) * [`factsets_autovacuum_vacuum_scale_factor`](#factsets_autovacuum_vacuum_scale_factor) * [`reports_autovacuum_vacuum_scale_factor`](#reports_autovacuum_vacuum_scale_factor) -* [`maintenance_work_mem`](#maintenance_work_mem) * [`autovacuum_work_mem`](#autovacuum_work_mem) * [`psql_version`](#psql_version) -##### `autovacuum_vacuum_scale_factor` +##### `maintenance_work_mem` -Data type: `Float[0,1]` +Data type: `String` +Increase to improve speed of speed of vacuuming and reindexing (Example "1GB") +Default value: `$all_in_one_pe_install` -Default value: `0.08` +##### `work_mem` -##### `autovacuum_analyze_scale_factor` +Data type: `String` -Data type: `Float[0,1]` +Allows PostgreSQL to do larger in-memory sorts (Default: "4MB") +Default value: `'8MB'` +##### `autovacumn_work_mem` -Default value: `0.04` +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))` -##### `log_autovacuum_min_duration` +##### `autovacuum_vacuum_scale_factor` -Data type: `Integer` +Data type: `Float[0,1]` -Default value: `-` +Default value: `0.08` -##### `log_temp_files` +##### `autovacuum_analyze_scale_factor` + +Data type: `Float[0,1]` + + + +Default value: `0.04` + +##### `log_autovacuum_min_duration` Data type: `Integer` @@ -293,13 +203,13 @@ Data type: `Integer` Default value: `-` -##### `work_mem` +##### `log_temp_files` -Data type: `String` +Data type: `Integer` -Default value: `'8MB'` +Default value: `-` ##### `max_connections` @@ -373,14 +283,6 @@ 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` @@ -399,7 +301,7 @@ Default value: `$pe_databases::psql_version` ### `pe_databases::postgresql_settings::table_settings` -The pe_databases::postgresql_settings::table_settings class. +Tune PostgreSQL table settings #### Parameters @@ -470,7 +372,7 @@ The following parameters are available in the `pe_databases::collect` defined ty Data type: `String` - +The database to repack, uses titles from pg_repack.pp Default value: `$title` @@ -478,7 +380,7 @@ Default value: `$title` Data type: `String` - +defined in pg_repack.pp Default value: ``undef`` @@ -486,7 +388,7 @@ Default value: ``undef`` Data type: `Boolean` - +to disable maintenance mode (Default: false) Default value: ``false`` @@ -494,13 +396,13 @@ Default value: ``false`` Data type: `String` - +values can be found in pg_repack.pp Default value: ``undef`` ### `pe_databases::set_puppetdb_table_autovacuum_cost_delay_zero` -The pe_databases::set_puppetdb_table_autovacuum_cost_delay_zero class. +Defined type for PostgreSQL autovacuum_cost_delay #### Parameters @@ -512,13 +414,13 @@ The following parameters are available in the `pe_databases::set_puppetdb_table_ Data type: `String` - +Name of the table Default value: `$title` ### `pe_databases::set_table_attribute` -The pe_databases::set_table_attribute class. +Defined type for PostgreSQL table attributes #### Parameters @@ -533,25 +435,25 @@ The following parameters are available in the `pe_databases::set_table_attribute 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 diff --git a/metadata.json b/metadata.json index 89712a5..96721fe 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-pe_databases", - "version": "2.2.0", + "version": "2.3.0", "author": "puppetlabs", "summary": "A Puppet Module for Backing Up / Maintaining / Tuning Your Puppet Enterprise Databases", "license": "Apache-2.0",