From 22ffe7ecf59930ad2a9e0d79b7b2f0ea4832ccc3 Mon Sep 17 00:00:00 2001 From: Auto-release Date: Fri, 28 Aug 2020 13:06:58 +0000 Subject: [PATCH] Release version 6.7.0 update changelog.md --- CHANGELOG.md | 12 + REFERENCE.md | 779 ++++++++++++++++++++++++++------------------------ metadata.json | 2 +- 3 files changed, 413 insertions(+), 380 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 38d7d618ac..25c5da971e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,18 @@ 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). +## [v6.7.0](https://github.com/puppetlabs/puppetlabs-postgresql/tree/v6.7.0) (2020-08-28) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-postgresql/compare/v6.6.0...v6.7.0) + +### Added + +- pdksync - \(IAC-973\) - Update travis/appveyor to run on new default branch `main` [\#1182](https://github.com/puppetlabs/puppetlabs-postgresql/pull/1182) ([david22swan](https://github.com/david22swan)) + +### Fixed + +- Invert psql/package dependency logic [\#1179](https://github.com/puppetlabs/puppetlabs-postgresql/pull/1179) ([raphink](https://github.com/raphink)) + ## [v6.6.0](https://github.com/puppetlabs/puppetlabs-postgresql/tree/v6.6.0) (2020-06-02) [Full Changelog](https://github.com/puppetlabs/puppetlabs-postgresql/compare/v6.5.0...v6.6.0) diff --git a/REFERENCE.md b/REFERENCE.md index c68d934443..6227ef29c8 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -1,11 +1,12 @@ # Reference + ## Table of Contents -**Classes** +### Classes -_Public Classes_ +#### Public Classes * [`postgresql::client`](#postgresqlclient): Installs PostgreSQL client software. Set the following parameters if you have a custom version you would like to install. * [`postgresql::globals`](#postgresqlglobals): Class for setting cross-class global overrides. @@ -20,20 +21,20 @@ _Public Classes_ * [`postgresql::server::plpython`](#postgresqlserverplpython): This class installs the PL/Python procedural language for postgresql. * [`postgresql::server::postgis`](#postgresqlserverpostgis): Install the postgis postgresql packaging. -_Private Classes_ +#### Private Classes -* `postgresql::params`: -* `postgresql::repo`: -* `postgresql::repo::apt_postgresql_org`: -* `postgresql::repo::yum_postgresql_org`: -* `postgresql::server::config`: -* `postgresql::server::initdb`: -* `postgresql::server::install`: -* `postgresql::server::passwd`: -* `postgresql::server::reload`: -* `postgresql::server::service`: +* `postgresql::params` +* `postgresql::repo` +* `postgresql::repo::apt_postgresql_org` +* `postgresql::repo::yum_postgresql_org` +* `postgresql::server::config` +* `postgresql::server::initdb` +* `postgresql::server::install` +* `postgresql::server::passwd` +* `postgresql::server::reload` +* `postgresql::server::service` -**Defined types** +### Defined types * [`postgresql::server::config_entry`](#postgresqlserverconfig_entry): Manage a postgresql.conf entry. * [`postgresql::server::database`](#postgresqlserverdatabase): Define for creating a database. @@ -52,16 +53,16 @@ _Private Classes_ * [`postgresql::server::tablespace`](#postgresqlservertablespace): This module creates tablespace. * [`postgresql::validate_db_connection`](#postgresqlvalidate_db_connection): This type validates that a successful postgres connection. -**Resource types** +### Resource types * [`postgresql_conf`](#postgresql_conf): This type allows puppet to manage postgresql.conf parameters. * [`postgresql_conn_validator`](#postgresql_conn_validator): Verify if a connection can be successfully established * [`postgresql_psql`](#postgresql_psql): An arbitrary tag for your own reference; the name of the message. * [`postgresql_replication_slot`](#postgresql_replication_slot): Manages Postgresql replication slots. -**Functions** +### Functions -_Public Functions_ +#### Public Functions * [`postgresql::default`](#postgresqldefault): This function pull default values from the `params` class or `globals` class if the value is not present in `params`. * [`postgresql::postgresql_escape`](#postgresqlpostgresql_escape): This function escapes a string using [Dollar Quoting](https://www.postgresql.org/docs/12/sql-syntax-lexical.html#SQL-SYNTAX-DOLLAR-QUOTING) using a randomly generated tag if required. @@ -69,17 +70,17 @@ _Public Functions_ * [`postgresql_escape`](#postgresql_escape): DEPRECATED. Use the namespaced function [`postgresql::postgresql_escape`](#postgresqlpostgresql_escape) instead. * [`postgresql_password`](#postgresql_password): DEPRECATED. Use the namespaced function [`postgresql::postgresql_password`](#postgresqlpostgresql_password) instead. -_Private Functions_ +#### Private Functions * `postgresql::postgresql_acls_to_resources_hash`: This internal function translates the ipv(4|6)acls format into a resource suitable for create_resources. -**Tasks** +### Tasks * [`sql`](#sql): Allows you to execute arbitary SQL ## Classes -### postgresql::client +### `postgresql::client` Installs PostgreSQL client software. Set the following parameters if you have a custom version you would like to install. @@ -95,7 +96,7 @@ Data type: `Enum['file', 'absent']` Ensure the connection validation script is present -Default value: 'file' +Default value: `'file'` ##### `validcon_script_path` @@ -103,7 +104,7 @@ Data type: `Stdlib::Absolutepath` Optional. Absolute path for the postgresql connection validation script. -Default value: $postgresql::params::validcon_script_path +Default value: `$postgresql::params::validcon_script_path` ##### `package_name` @@ -111,7 +112,7 @@ Data type: `String[1]` Sets the name of the PostgreSQL client package. -Default value: $postgresql::params::client_package_name +Default value: `$postgresql::params::client_package_name` ##### `package_ensure` @@ -119,9 +120,9 @@ Data type: `String[1]` Ensure the client package is installed -Default value: 'present' +Default value: `'present'` -### postgresql::globals +### `postgresql::globals` Class for setting cross-class global overrides. @@ -138,7 +139,7 @@ Data type: `Any` Overrides the default PostgreSQL client package name. -Default value: `undef` +Default value: ``undef`` ##### `server_package_name` @@ -146,7 +147,7 @@ Data type: `Any` Overrides the default PostgreSQL server package name. -Default value: `undef` +Default value: ``undef`` ##### `contrib_package_name` @@ -154,7 +155,7 @@ Data type: `Any` Overrides the default PostgreSQL contrib package name. -Default value: `undef` +Default value: ``undef`` ##### `devel_package_name` @@ -162,7 +163,7 @@ Data type: `Any` Overrides the default PostgreSQL devel package name. -Default value: `undef` +Default value: ``undef`` ##### `java_package_name` @@ -170,7 +171,7 @@ Data type: `Any` Overrides the default PostgreSQL java package name. -Default value: `undef` +Default value: ``undef`` ##### `docs_package_name` @@ -178,7 +179,7 @@ Data type: `Any` Overrides the default PostgreSQL docs package name. -Default value: `undef` +Default value: ``undef`` ##### `perl_package_name` @@ -186,7 +187,7 @@ Data type: `Any` Overrides the default PostgreSQL Perl package name. -Default value: `undef` +Default value: ``undef`` ##### `plperl_package_name` @@ -194,7 +195,7 @@ Data type: `Any` Overrides the default PostgreSQL PL/Perl package name. -Default value: `undef` +Default value: ``undef`` ##### `plpython_package_name` @@ -202,7 +203,7 @@ Data type: `Any` Overrides the default PostgreSQL PL/Python package name. -Default value: `undef` +Default value: ``undef`` ##### `python_package_name` @@ -210,7 +211,7 @@ Data type: `Any` Overrides the default PostgreSQL Python package name. -Default value: `undef` +Default value: ``undef`` ##### `postgis_package_name` @@ -218,7 +219,7 @@ Data type: `Any` Overrides the default PostgreSQL PostGIS package name. -Default value: `undef` +Default value: ``undef`` ##### `service_name` @@ -226,7 +227,7 @@ Data type: `Any` Overrides the default PostgreSQL service name. -Default value: `undef` +Default value: ``undef`` ##### `service_provider` @@ -234,7 +235,7 @@ Data type: `Any` Overrides the default PostgreSQL service provider. -Default value: `undef` +Default value: ``undef`` ##### `service_status` @@ -242,7 +243,7 @@ Data type: `Any` Overrides the default status check command for your PostgreSQL service. -Default value: `undef` +Default value: ``undef`` ##### `default_database` @@ -250,7 +251,7 @@ Data type: `Any` Specifies the name of the default database to connect with. -Default value: `undef` +Default value: ``undef`` ##### `validcon_script_path` @@ -258,7 +259,7 @@ Data type: `Any` Scipt path for the connection validation check. -Default value: `undef` +Default value: ``undef`` ##### `initdb_path` @@ -266,7 +267,7 @@ Data type: `Any` Path to the initdb command. -Default value: `undef` +Default value: ``undef`` ##### `createdb_path` @@ -274,7 +275,7 @@ Data type: `Any` Deprecated. Path to the createdb command. -Default value: `undef` +Default value: ``undef`` ##### `psql_path` @@ -282,7 +283,7 @@ Data type: `Any` Sets the path to the psql command. -Default value: `undef` +Default value: ``undef`` ##### `pg_hba_conf_path` @@ -290,7 +291,7 @@ Data type: `Any` Specifies the path to your pg_hba.conf file. -Default value: `undef` +Default value: ``undef`` ##### `pg_ident_conf_path` @@ -298,7 +299,7 @@ Data type: `Any` Specifies the path to your pg_ident.conf file. -Default value: `undef` +Default value: ``undef`` ##### `postgresql_conf_path` @@ -306,7 +307,7 @@ Data type: `Any` Sets the path to your postgresql.conf file. -Default value: `undef` +Default value: ``undef`` ##### `recovery_conf_path` @@ -314,7 +315,7 @@ Data type: `Any` Path to your recovery.conf file. -Default value: `undef` +Default value: ``undef`` ##### `default_connect_settings` @@ -322,7 +323,7 @@ Data type: `Any` Default connection settings. -Default value: {} +Default value: `{}` ##### `pg_hba_conf_defaults` @@ -330,7 +331,7 @@ Data type: `Any` Disables the defaults supplied with the module for pg_hba.conf if set to false. -Default value: `undef` +Default value: ``undef`` ##### `datadir` @@ -342,7 +343,7 @@ For Red Hat systems, the data directory must be labeled appropriately for SELinu On Ubuntu, you must explicitly set needs_initdb = true to allow Puppet to initialize the database in the new datadir (needs_initdb defaults to true on other systems). Warning! If datadir is changed from the default, Puppet does not manage purging of the original data directory, which causes it to fail if the data directory is changed back to the original -Default value: `undef` +Default value: ``undef`` ##### `confdir` @@ -350,7 +351,7 @@ Data type: `Any` Overrides the default PostgreSQL configuration directory for the target platform. -Default value: `undef` +Default value: ``undef`` ##### `bindir` @@ -358,7 +359,7 @@ Data type: `Any` Overrides the default PostgreSQL binaries directory for the target platform. -Default value: `undef` +Default value: ``undef`` ##### `xlogdir` @@ -366,7 +367,7 @@ Data type: `Any` Overrides the default PostgreSQL xlog directory. -Default value: `undef` +Default value: ``undef`` ##### `logdir` @@ -374,7 +375,7 @@ Data type: `Any` Overrides the default PostgreSQL log directory. -Default value: `undef` +Default value: ``undef`` ##### `log_line_prefix` @@ -382,7 +383,7 @@ Data type: `Any` Overrides the default PostgreSQL log prefix. -Default value: `undef` +Default value: ``undef`` ##### `user` @@ -390,7 +391,7 @@ Data type: `Any` Overrides the default PostgreSQL super user and owner of PostgreSQL related files in the file system. -Default value: `undef` +Default value: ``undef`` ##### `group` @@ -398,7 +399,7 @@ Data type: `Any` Overrides the default postgres user group to be used for related files in the file system. -Default value: `undef` +Default value: ``undef`` ##### `version` @@ -406,7 +407,7 @@ Data type: `Any` The version of PostgreSQL to install and manage. -Default value: `undef` +Default value: ``undef`` ##### `postgis_version` @@ -414,7 +415,7 @@ Data type: `Any` Defines the version of PostGIS to install, if you install PostGIS. -Default value: `undef` +Default value: ``undef`` ##### `repo_proxy` @@ -422,7 +423,7 @@ Data type: `Any` Sets the proxy option for the official PostgreSQL yum-repositories only. -Default value: `undef` +Default value: ``undef`` ##### `repo_baseurl` @@ -430,7 +431,7 @@ Data type: `Any` Sets the baseurl for the PostgreSQL repository. Useful if you host your own mirror of the repository. -Default value: `undef` +Default value: ``undef`` ##### `needs_initdb` @@ -438,7 +439,7 @@ Data type: `Any` Explicitly calls the initdb operation after the server package is installed and before the PostgreSQL service is started. -Default value: `undef` +Default value: ``undef`` ##### `encoding` @@ -447,7 +448,7 @@ Data type: `Any` Sets the default encoding for all databases created with this module. On certain operating systems, this is also used during the template1 initialization, so it becomes a default outside of the module as well. -Default value: `undef` +Default value: ``undef`` ##### `locale` @@ -457,7 +458,7 @@ Sets the default database locale for all databases created with this module. On certain operating systems, this is also used during the template1 initialization, so it becomes a default outside of the module as well. On Debian, you'll need to ensure that the 'locales-all' package is installed for full functionality of PostgreSQL. -Default value: `undef` +Default value: ``undef`` ##### `data_checksums` @@ -466,7 +467,7 @@ Data type: `Any` Use checksums on data pages to help detect corruption by the I/O system that would otherwise be silent. Warning: This option is used during initialization by initdb, and cannot be changed later. -Default value: `undef` +Default value: ``undef`` ##### `timezone` @@ -474,7 +475,7 @@ Data type: `Any` Sets the default timezone of the postgresql server. The postgresql built-in default is taking the systems timezone information. -Default value: `undef` +Default value: ``undef`` ##### `manage_pg_hba_conf` @@ -482,7 +483,7 @@ Data type: `Any` Allow Puppet to manage the pg_hba.conf file. -Default value: `undef` +Default value: ``undef`` ##### `manage_pg_ident_conf` @@ -490,7 +491,7 @@ Data type: `Any` Allow Puppet to manage the pg_ident.conf file. -Default value: `undef` +Default value: ``undef`` ##### `manage_recovery_conf` @@ -498,7 +499,7 @@ Data type: `Any` Allow Puppet to manage the recovery.conf file. -Default value: `undef` +Default value: ``undef`` ##### `manage_datadir` @@ -506,7 +507,7 @@ Data type: `Any` Set to false if you have file{ $datadir: } already defined -Default value: `undef` +Default value: ``undef`` ##### `manage_logdir` @@ -514,7 +515,7 @@ Data type: `Any` Set to false if you have file{ $logdir: } already defined -Default value: `undef` +Default value: ``undef`` ##### `manage_xlogdir` @@ -522,7 +523,7 @@ Data type: `Any` Set to false if you have file{ $xlogdir: } already defined -Default value: `undef` +Default value: ``undef`` ##### `manage_package_repo` @@ -530,7 +531,7 @@ Data type: `Any` Sets up official PostgreSQL repositories on your host if set to true. -Default value: `undef` +Default value: ``undef`` ##### `module_workdir` @@ -538,7 +539,7 @@ Data type: `Any` Specifies working directory under which the psql command should be executed. May need to specify if '/tmp' is on volume mounted with noexec option. -Default value: `undef` +Default value: ``undef`` ##### `manage_selinux` @@ -546,9 +547,9 @@ Data type: `Any` -Default value: `undef` +Default value: ``undef`` -### postgresql::lib::devel +### `postgresql::lib::devel` This class installs postgresql development libraries. @@ -562,7 +563,7 @@ Data type: `String` Override devel package name -Default value: $postgresql::params::devel_package_name +Default value: `$postgresql::params::devel_package_name` ##### `package_ensure` @@ -570,7 +571,7 @@ Data type: `String[1]` Ensure the development libraries are installed -Default value: 'present' +Default value: `'present'` ##### `link_pg_config` @@ -578,9 +579,9 @@ Data type: `Boolean` If the bin directory used by the PostgreSQL page is not /usr/bin or /usr/local/bin, symlinks pg_config from the package's bin dir into usr/bin (not applicable to Debian systems). Set to false to disable this behavior. -Default value: $postgresql::params::link_pg_config +Default value: `$postgresql::params::link_pg_config` -### postgresql::lib::docs +### `postgresql::lib::docs` Installs PostgreSQL bindings for Postgres-Docs. Set the following parameters if you have a custom version you would like to install. @@ -596,7 +597,7 @@ Data type: `String` Specifies the name of the PostgreSQL docs package. -Default value: $postgresql::params::docs_package_name +Default value: `$postgresql::params::docs_package_name` ##### `package_ensure` @@ -604,9 +605,9 @@ Data type: `String[1]` Whether the PostgreSQL docs package resource should be present. -Default value: 'present' +Default value: `'present'` -### postgresql::lib::java +### `postgresql::lib::java` This class installs the postgresql jdbc connector. @@ -622,7 +623,7 @@ Data type: `String` Specifies the name of the PostgreSQL java package. -Default value: $postgresql::params::java_package_name +Default value: `$postgresql::params::java_package_name` ##### `package_ensure` @@ -630,9 +631,9 @@ Data type: `String[1]` Specifies whether the package is present. -Default value: 'present' +Default value: `'present'` -### postgresql::lib::perl +### `postgresql::lib::perl` This class installs the perl libs for postgresql. @@ -646,7 +647,7 @@ Data type: `String` Specifies the name of the PostgreSQL perl package to install. -Default value: $postgresql::params::perl_package_name +Default value: `$postgresql::params::perl_package_name` ##### `package_ensure` @@ -654,9 +655,9 @@ Data type: `String[1]` Ensure the perl libs for postgresql are installed. -Default value: 'present' +Default value: `'present'` -### postgresql::lib::python +### `postgresql::lib::python` This class installs the python libs for postgresql. @@ -670,7 +671,7 @@ Data type: `String[1]` The name of the PostgreSQL Python package. -Default value: $postgresql::params::python_package_name +Default value: `$postgresql::params::python_package_name` ##### `package_ensure` @@ -678,9 +679,9 @@ Data type: `String[1]` Ensure the python libs for postgresql are installed. -Default value: 'present' +Default value: `'present'` -### postgresql::server +### `postgresql::server` This installs a PostgreSQL server @@ -694,7 +695,7 @@ Data type: `Any` Sets the password for the postgres user to your specified value. By default, this setting uses the superuser account in the Postgres database, with a user called postgres and no password. -Default value: `undef` +Default value: ``undef`` ##### `package_name` @@ -702,7 +703,7 @@ Data type: `Any` Specifies the name of the package to use for installing the server software. -Default value: $postgresql::params::server_package_name +Default value: `$postgresql::params::server_package_name` ##### `package_ensure` @@ -710,7 +711,7 @@ Data type: `Any` Passes a value through to the package resource when creating the server instance. -Default value: $postgresql::params::package_ensure +Default value: `$postgresql::params::package_ensure` ##### `plperl_package_name` @@ -718,7 +719,7 @@ Data type: `Any` Sets the default package name for the PL/Perl extension. -Default value: $postgresql::params::plperl_package_name +Default value: `$postgresql::params::plperl_package_name` ##### `plpython_package_name` @@ -726,7 +727,7 @@ Data type: `Any` Sets the default package name for the PL/Python extension. -Default value: $postgresql::params::plpython_package_name +Default value: `$postgresql::params::plpython_package_name` ##### `service_ensure` @@ -734,7 +735,7 @@ Data type: `Any` Ensure service is installed -Default value: $postgresql::params::service_ensure +Default value: `$postgresql::params::service_ensure` ##### `service_enable` @@ -742,7 +743,7 @@ Data type: `Any` Enable the PostgreSQL service -Default value: $postgresql::params::service_enable +Default value: `$postgresql::params::service_enable` ##### `service_manage` @@ -750,7 +751,7 @@ Data type: `Any` Defines whether or not Puppet should manage the service. -Default value: $postgresql::params::service_manage +Default value: `$postgresql::params::service_manage` ##### `service_name` @@ -758,7 +759,7 @@ Data type: `Any` Overrides the default PostgreSQL service name. -Default value: $postgresql::params::service_name +Default value: `$postgresql::params::service_name` ##### `service_restart_on_change` @@ -766,7 +767,7 @@ Data type: `Any` Overrides the default behavior to restart your PostgreSQL service when a config entry has been changed that requires a service restart to become active. -Default value: $postgresql::params::service_restart_on_change +Default value: `$postgresql::params::service_restart_on_change` ##### `service_provider` @@ -774,7 +775,7 @@ Data type: `Any` Overrides the default PostgreSQL service provider. -Default value: $postgresql::params::service_provider +Default value: `$postgresql::params::service_provider` ##### `service_reload` @@ -782,7 +783,7 @@ Data type: `Any` Overrides the default reload command for your PostgreSQL service. -Default value: $postgresql::params::service_reload +Default value: `$postgresql::params::service_reload` ##### `service_status` @@ -790,7 +791,7 @@ Data type: `Any` Overrides the default status check command for your PostgreSQL service. -Default value: $postgresql::params::service_status +Default value: `$postgresql::params::service_status` ##### `default_database` @@ -798,7 +799,7 @@ Data type: `Any` Specifies the name of the default database to connect with. On most systems this is 'postgres'. -Default value: $postgresql::params::default_database +Default value: `$postgresql::params::default_database` ##### `default_connect_settings` @@ -806,7 +807,7 @@ Data type: `Any` Specifies a hash of environment variables used when connecting to a remote server. Becomes the default for other defined types, such as postgresql::server::role. -Default value: $postgresql::globals::default_connect_settings +Default value: `$postgresql::globals::default_connect_settings` ##### `listen_addresses` @@ -814,7 +815,7 @@ Data type: `Any` Address list on which the PostgreSQL service will listen -Default value: $postgresql::params::listen_addresses +Default value: `$postgresql::params::listen_addresses` ##### `port` @@ -823,7 +824,7 @@ Data type: `Any` Specifies the port for the PostgreSQL server to listen on. Note: The same port number is used for all IP addresses the server listens on. Also, for Red Hat systems and early Debian systems, changing the port causes the server to come to a full stop before being able to make the change. Default value: 5432. Meaning the Postgres server listens on TCP port 5432. -Default value: $postgresql::params::port +Default value: `$postgresql::params::port` ##### `ip_mask_deny_postgres_user` @@ -832,7 +833,7 @@ Data type: `Any` Specifies the IP mask from which remote connections should be denied for the postgres superuser. Default value: '0.0.0.0/0', which denies any remote connection. -Default value: $postgresql::params::ip_mask_deny_postgres_user +Default value: `$postgresql::params::ip_mask_deny_postgres_user` ##### `ip_mask_allow_all_users` @@ -842,7 +843,7 @@ Overrides PostgreSQL defaults for remote connections. By default, PostgreSQL doe Set to '0.0.0.0/0' to allow database users to connect from any remote machine, or '192.168.0.0/1' to allow connections from any machine on your local '192.168' subnet. Default value: '127.0.0.1/32'. -Default value: $postgresql::params::ip_mask_allow_all_users +Default value: `$postgresql::params::ip_mask_allow_all_users` ##### `ipv4acls` @@ -850,7 +851,7 @@ Data type: `Array[String[1]]` Lists strings for access control for connection method, users, databases, IPv4 addresses; -Default value: $postgresql::params::ipv4acls +Default value: `$postgresql::params::ipv4acls` ##### `ipv6acls` @@ -858,7 +859,7 @@ Data type: `Array[String[1]]` Lists strings for access control for connection method, users, databases, IPv6 addresses. -Default value: $postgresql::params::ipv6acls +Default value: `$postgresql::params::ipv6acls` ##### `initdb_path` @@ -866,7 +867,7 @@ Data type: `Any` Specifies the path to the initdb command. -Default value: $postgresql::params::initdb_path +Default value: `$postgresql::params::initdb_path` ##### `createdb_path` @@ -874,7 +875,7 @@ Data type: `Any` Deprecated. Specifies the path to the createdb command. -Default value: $postgresql::params::createdb_path +Default value: `$postgresql::params::createdb_path` ##### `psql_path` @@ -882,7 +883,7 @@ Data type: `Any` Specifies the path to the psql command. -Default value: $postgresql::params::psql_path +Default value: `$postgresql::params::psql_path` ##### `pg_hba_conf_path` @@ -890,7 +891,7 @@ Data type: `Any` Specifies the path to your pg_hba.conf file. -Default value: $postgresql::params::pg_hba_conf_path +Default value: `$postgresql::params::pg_hba_conf_path` ##### `pg_ident_conf_path` @@ -898,7 +899,7 @@ Data type: `Any` Specifies the path to your pg_ident.conf file. -Default value: $postgresql::params::pg_ident_conf_path +Default value: `$postgresql::params::pg_ident_conf_path` ##### `postgresql_conf_path` @@ -906,7 +907,7 @@ Data type: `Any` Specifies the path to your postgresql.conf file. -Default value: $postgresql::params::postgresql_conf_path +Default value: `$postgresql::params::postgresql_conf_path` ##### `recovery_conf_path` @@ -914,7 +915,7 @@ Data type: `Any` Specifies the path to your recovery.conf file. -Default value: $postgresql::params::recovery_conf_path +Default value: `$postgresql::params::recovery_conf_path` ##### `datadir` @@ -922,7 +923,7 @@ Data type: `Any` PostgreSQL data directory -Default value: $postgresql::params::datadir +Default value: `$postgresql::params::datadir` ##### `xlogdir` @@ -930,7 +931,7 @@ Data type: `Any` PostgreSQL xlog directory -Default value: $postgresql::params::xlogdir +Default value: `$postgresql::params::xlogdir` ##### `logdir` @@ -938,7 +939,7 @@ Data type: `Any` PostgreSQL log directory -Default value: $postgresql::params::logdir +Default value: `$postgresql::params::logdir` ##### `log_line_prefix` @@ -946,7 +947,7 @@ Data type: `Any` PostgreSQL log line prefix -Default value: $postgresql::params::log_line_prefix +Default value: `$postgresql::params::log_line_prefix` ##### `pg_hba_conf_defaults` @@ -954,7 +955,7 @@ Data type: `Any` If false, disables the defaults supplied with the module for pg_hba.conf. This is useful if you disagree with the defaults and wish to override them yourself. Be sure that your changes of course align with the rest of the module, as some access is required to perform basic psql operations for example. -Default value: $postgresql::params::pg_hba_conf_defaults +Default value: `$postgresql::params::pg_hba_conf_defaults` ##### `user` @@ -962,7 +963,7 @@ Data type: `Any` Overrides the default PostgreSQL super user and owner of PostgreSQL related files in the file system. -Default value: $postgresql::params::user +Default value: `$postgresql::params::user` ##### `group` @@ -970,7 +971,7 @@ Data type: `Any` Overrides the default postgres user group to be used for related files in the file system. -Default value: $postgresql::params::group +Default value: `$postgresql::params::group` ##### `needs_initdb` @@ -978,7 +979,7 @@ Data type: `Any` Explicitly calls the initdb operation after server package is installed, and before the PostgreSQL service is started. -Default value: $postgresql::params::needs_initdb +Default value: `$postgresql::params::needs_initdb` ##### `encoding` @@ -986,7 +987,7 @@ Data type: `Any` Sets the default encoding for all databases created with this module. On certain operating systems this is also used during the template1 initialization, so it becomes a default outside of the module as well. -Default value: $postgresql::params::encoding +Default value: `$postgresql::params::encoding` ##### `locale` @@ -994,7 +995,7 @@ Data type: `Any` Sets the default database locale for all databases created with this module. On certain operating systems this is used during the template1 initialization as well, so it becomes a default outside of the module. -Default value: $postgresql::params::locale +Default value: `$postgresql::params::locale` ##### `data_checksums` @@ -1003,7 +1004,7 @@ Data type: `Any` Boolean. Use checksums on data pages to help detect corruption by the I/O system that would otherwise be silent. Warning: This option is used during initialization by initdb, and cannot be changed later. If set, checksums are calculated for all objects, in all databases. -Default value: $postgresql::params::data_checksums +Default value: `$postgresql::params::data_checksums` ##### `timezone` @@ -1011,7 +1012,7 @@ Data type: `Any` Set timezone for the PostgreSQL instance -Default value: $postgresql::params::timezone +Default value: `$postgresql::params::timezone` ##### `manage_pg_hba_conf` @@ -1019,7 +1020,7 @@ Data type: `Any` Boolean. Whether to manage the pg_hba.conf. -Default value: $postgresql::params::manage_pg_hba_conf +Default value: `$postgresql::params::manage_pg_hba_conf` ##### `manage_pg_ident_conf` @@ -1027,7 +1028,7 @@ Data type: `Any` Boolean. Overwrites the pg_ident.conf file. -Default value: $postgresql::params::manage_pg_ident_conf +Default value: `$postgresql::params::manage_pg_ident_conf` ##### `manage_recovery_conf` @@ -1035,7 +1036,7 @@ Data type: `Any` Boolean. Specifies whether or not manage the recovery.conf. -Default value: $postgresql::params::manage_recovery_conf +Default value: `$postgresql::params::manage_recovery_conf` ##### `module_workdir` @@ -1043,7 +1044,7 @@ Data type: `Any` Working directory for the PostgreSQL module -Default value: $postgresql::params::module_workdir +Default value: `$postgresql::params::module_workdir` ##### `manage_datadir` @@ -1051,7 +1052,7 @@ Data type: `Any` Set to false if you have file{ $datadir: } already defined -Default value: $postgresql::params::manage_datadir +Default value: `$postgresql::params::manage_datadir` ##### `manage_logdir` @@ -1059,7 +1060,7 @@ Data type: `Any` Set to false if you have file{ $logdir: } already defined -Default value: $postgresql::params::manage_logdir +Default value: `$postgresql::params::manage_logdir` ##### `manage_xlogdir` @@ -1067,7 +1068,7 @@ Data type: `Any` Set to false if you have file{ $xlogdir: } already defined -Default value: $postgresql::params::manage_xlogdir +Default value: `$postgresql::params::manage_xlogdir` ##### `roles` @@ -1075,7 +1076,7 @@ Data type: `Hash[String, Hash]` Specifies a hash from which to generate postgresql::server::role resources. -Default value: {} +Default value: `{}` ##### `config_entries` @@ -1083,7 +1084,7 @@ Data type: `Hash[String, Any]` Specifies a hash from which to generate postgresql::server::config_entry resources. -Default value: {} +Default value: `{}` ##### `pg_hba_rules` @@ -1091,7 +1092,7 @@ Data type: `Hash[String, Hash]` Specifies a hash from which to generate postgresql::server::pg_hba_rule resources. -Default value: {} +Default value: `{}` ##### `version` @@ -1099,7 +1100,7 @@ Data type: `Any` Deprecated. Use postgresql::globals instead. Sets PostgreSQL version -Default value: `undef` +Default value: ``undef`` ##### `extra_systemd_config` @@ -1107,7 +1108,7 @@ Data type: `Any` Adds extra config to systemd config file, can for instance be used to add extra openfiles. This can be a multi line string -Default value: $postgresql::params::extra_systemd_config +Default value: `$postgresql::params::extra_systemd_config` ##### `manage_selinux` @@ -1115,7 +1116,7 @@ Data type: `Boolean` -Default value: $postgresql::params::manage_selinux +Default value: `$postgresql::params::manage_selinux` ##### `password_encryption` @@ -1123,9 +1124,9 @@ Data type: `Any` -Default value: $postgresql::params::password_encryption +Default value: `$postgresql::params::password_encryption` -### postgresql::server::contrib +### `postgresql::server::contrib` Install the contrib postgresql packaging. @@ -1139,7 +1140,7 @@ Data type: `String` The name of the PostgreSQL contrib package. -Default value: $postgresql::params::contrib_package_name +Default value: `$postgresql::params::contrib_package_name` ##### `package_ensure` @@ -1147,9 +1148,9 @@ Data type: `String[1]` Ensure the contrib package is installed. -Default value: 'present' +Default value: `'present'` -### postgresql::server::plperl +### `postgresql::server::plperl` This class installs the PL/Perl procedural language for postgresql. @@ -1163,7 +1164,7 @@ Data type: `Any` The ensure parameter passed on to PostgreSQL PL/Perl package resource. -Default value: 'present' +Default value: `'present'` ##### `package_name` @@ -1171,9 +1172,9 @@ Data type: `Any` The name of the PostgreSQL PL/Perl package. -Default value: $postgresql::server::plperl_package_name +Default value: `$postgresql::server::plperl_package_name` -### postgresql::server::plpython +### `postgresql::server::plpython` This class installs the PL/Python procedural language for postgresql. @@ -1187,7 +1188,7 @@ Data type: `Any` Specifies whether the package is present. -Default value: 'present' +Default value: `'present'` ##### `package_name` @@ -1195,9 +1196,9 @@ Data type: `Any` Specifies the name of the postgresql PL/Python package. -Default value: $postgresql::server::plpython_package_name +Default value: `$postgresql::server::plpython_package_name` -### postgresql::server::postgis +### `postgresql::server::postgis` Install the postgis postgresql packaging. @@ -1211,7 +1212,7 @@ Data type: `String` Sets the package name. -Default value: $postgresql::params::postgis_package_name +Default value: `$postgresql::params::postgis_package_name` ##### `package_ensure` @@ -1219,11 +1220,11 @@ Data type: `String[1]` Specifies if the package is present or not. -Default value: 'present' +Default value: `'present'` ## Defined types -### postgresql::server::config_entry +### `postgresql::server::config_entry` Manage a postgresql.conf entry. @@ -1233,11 +1234,11 @@ The following parameters are available in the `postgresql::server::config_entry` ##### `ensure` -Data type: `Any` +Data type: `Enum['present', 'absent']` Removes an entry if set to 'absent'. -Default value: 'present' +Default value: `'present'` ##### `value` @@ -1245,7 +1246,7 @@ Data type: `Any` Defines the value for the setting. -Default value: `undef` +Default value: ``undef`` ##### `path` @@ -1253,9 +1254,9 @@ Data type: `Any` Path for postgresql.conf -Default value: `false` +Default value: ``false`` -### postgresql::server::database +### `postgresql::server::database` Define for creating a database. @@ -1269,7 +1270,7 @@ Data type: `Any` Sets a comment on the database. -Default value: `undef` +Default value: ``undef`` ##### `dbname` @@ -1277,7 +1278,7 @@ Data type: `Any` Sets the name of the database. -Default value: $title +Default value: `$title` ##### `owner` @@ -1285,7 +1286,7 @@ Data type: `Any` Sets name of the database owner. -Default value: `undef` +Default value: ``undef`` ##### `tablespace` @@ -1293,7 +1294,7 @@ Data type: `Any` Sets tablespace for where to create this database. -Default value: `undef` +Default value: ``undef`` ##### `template` @@ -1301,7 +1302,7 @@ Data type: `Any` Specifies the name of the template database from which to build this database. Default value: 'template0'. -Default value: 'template0' +Default value: `'template0'` ##### `encoding` @@ -1309,7 +1310,7 @@ Data type: `Any` Overrides the character set during creation of the database. -Default value: $postgresql::server::encoding +Default value: `$postgresql::server::encoding` ##### `locale` @@ -1317,7 +1318,7 @@ Data type: `Any` Overrides the locale during creation of the database. -Default value: $postgresql::server::locale +Default value: `$postgresql::server::locale` ##### `istemplate` @@ -1325,7 +1326,7 @@ Data type: `Any` Defines the database as a template if set to true. -Default value: `false` +Default value: ``false`` ##### `connect_settings` @@ -1333,9 +1334,9 @@ Data type: `Any` Specifies a hash of environment variables used when connecting to a remote server. -Default value: $postgresql::server::default_connect_settings +Default value: `$postgresql::server::default_connect_settings` -### postgresql::server::database_grant +### `postgresql::server::database_grant` Manage a database grant. @@ -1367,7 +1368,7 @@ Data type: `Any` Specifies whether to grant or revoke the privilege. Revoke or 'absent' works only in PostgreSQL version 9.1.24 or later. -Default value: `undef` +Default value: ``undef`` ##### `psql_db` @@ -1375,7 +1376,7 @@ Data type: `Any` Defines the database to execute the grant against. This should not ordinarily be changed from the default -Default value: `undef` +Default value: ``undef`` ##### `psql_user` @@ -1383,7 +1384,7 @@ Data type: `Any` Specifies the OS user for running psql. Default value: The default user for the module, usually 'postgres'. -Default value: `undef` +Default value: ``undef`` ##### `connect_settings` @@ -1391,9 +1392,9 @@ Data type: `Any` Specifies a hash of environment variables used when connecting to a remote server. -Default value: `undef` +Default value: ``undef`` -### postgresql::server::db +### `postgresql::server::db` Define for conveniently creating a role, database and assigning the correctpermissions. @@ -1419,7 +1420,7 @@ Data type: `Any` Defines a comment to be stored about the database using the PostgreSQL COMMENT command. -Default value: `undef` +Default value: ``undef`` ##### `dbname` @@ -1427,7 +1428,7 @@ Data type: `Any` Sets the name of the database to be created. -Default value: $title +Default value: `$title` ##### `encoding` @@ -1435,7 +1436,7 @@ Data type: `Any` Overrides the character set during creation of the database. -Default value: $postgresql::server::encoding +Default value: `$postgresql::server::encoding` ##### `locale` @@ -1443,7 +1444,7 @@ Data type: `Any` Overrides the locale during creation of the database. -Default value: $postgresql::server::locale +Default value: `$postgresql::server::locale` ##### `grant` @@ -1451,7 +1452,7 @@ Data type: `Any` Specifies the permissions to grant during creation. Default value: 'ALL'. -Default value: 'ALL' +Default value: `'ALL'` ##### `tablespace` @@ -1459,7 +1460,7 @@ Data type: `Any` Defines the name of the tablespace to allocate the created database to. -Default value: `undef` +Default value: ``undef`` ##### `template` @@ -1467,7 +1468,7 @@ Data type: `Any` Specifies the name of the template database from which to build this database. Defaults value: template0. -Default value: 'template0' +Default value: `'template0'` ##### `istemplate` @@ -1475,7 +1476,7 @@ Data type: `Any` Specifies that the database is a template, if set to true. -Default value: `false` +Default value: ``false`` ##### `owner` @@ -1483,9 +1484,9 @@ Data type: `Any` Sets a user as the owner of the database. -Default value: `undef` +Default value: ``undef`` -### postgresql::server::extension +### `postgresql::server::extension` Activate an extension on a postgresql database. @@ -1505,7 +1506,7 @@ Data type: `Any` Specifies the extension to activate. If left blank, uses the name of the resource. -Default value: $name +Default value: `$name` ##### `schema` @@ -1513,7 +1514,7 @@ Data type: `Optional[String[1]]` Specifies the schema on which to activate the extension. -Default value: `undef` +Default value: ``undef`` ##### `version` @@ -1526,7 +1527,7 @@ version may be set to a specific version, in which case the extension is updated eg. If extension is set to postgis and version is set to 2.3.3, this will apply the SQL ALTER EXTENSION "postgis" UPDATE TO '2.3.3' to this database only. version may be omitted, in which case no ALTER EXTENSION... SQL is applied, and the version will be left unchanged. -Default value: `undef` +Default value: ``undef`` ##### `ensure` @@ -1534,7 +1535,7 @@ Data type: `String[1]` Specifies whether to activate or deactivate the extension. Valid options: 'present' or 'absent'. -Default value: 'present' +Default value: `'present'` ##### `package_name` @@ -1542,7 +1543,7 @@ Data type: `Any` Specifies a package to install prior to activating the extension. -Default value: `undef` +Default value: ``undef`` ##### `package_ensure` @@ -1550,7 +1551,7 @@ Data type: `Any` Overrides default package deletion behavior. By default, the package specified with package_name is installed when the extension is activated and removed when the extension is deactivated. To override this behavior, set the ensure value for the package. -Default value: `undef` +Default value: ``undef`` ##### `port` @@ -1558,7 +1559,7 @@ Data type: `Optional[Integer]` Port to use when connecting. -Default value: `undef` +Default value: ``undef`` ##### `connect_settings` @@ -1566,7 +1567,7 @@ Data type: `Any` Specifies a hash of environment variables used when connecting to a remote server. -Default value: postgresql::default('default_connect_settings') +Default value: `postgresql::default('default_connect_settings')` ##### `database_resource_name` @@ -1574,9 +1575,9 @@ Data type: `Any` Specifies the resource name of the DB being managed. Defaults to the parameter $database, if left blank. -Default value: $database +Default value: `$database` -### postgresql::server::grant +### `postgresql::server::grant` Define for granting permissions to roles. @@ -1602,7 +1603,7 @@ Data type: `String` Specifies the privilege to grant. Valid options: 'ALL', 'ALL PRIVILEGES' or 'object_type' dependent string. -Default value: '' +Default value: `''` ##### `object_type` @@ -1624,7 +1625,7 @@ Data type: `Pattern[#/(?i:^COLUMN$)/, Specifies the type of object to which you are granting privileges. Valid options: 'DATABASE', 'SCHEMA', 'SEQUENCE', 'ALL SEQUENCES IN SCHEMA', 'TABLE' or 'ALL TABLES IN SCHEMA'. -Default value: 'database' +Default value: `'database'` ##### `object_name` @@ -1635,7 +1636,7 @@ Data type: `Optional[Variant[ Specifies name of object_type to which to grant access, can be either a string or a two element array. String: 'object_name' Array: ['schema_name', 'object_name'] -Default value: `undef` +Default value: ``undef`` ##### `psql_db` @@ -1643,7 +1644,7 @@ Data type: `String` Specifies the database to execute the grant against. This should not ordinarily be changed from the default -Default value: $postgresql::server::default_database +Default value: `$postgresql::server::default_database` ##### `psql_user` @@ -1651,7 +1652,7 @@ Data type: `String` Sets the OS user to run psql. -Default value: $postgresql::server::user +Default value: `$postgresql::server::user` ##### `port` @@ -1659,7 +1660,7 @@ Data type: `Integer` Port to use when connecting. -Default value: $postgresql::server::port +Default value: `$postgresql::server::port` ##### `onlyif_exists` @@ -1667,7 +1668,7 @@ Data type: `Boolean` Create grant only if doesn't exist -Default value: `false` +Default value: ``false`` ##### `connect_settings` @@ -1675,7 +1676,7 @@ Data type: `Hash` Specifies a hash of environment variables used when connecting to a remote server. -Default value: $postgresql::server::default_connect_settings +Default value: `$postgresql::server::default_connect_settings` ##### `ensure` @@ -1685,7 +1686,7 @@ Data type: `Enum['present', Specifies whether to grant or revoke the privilege. Default is to grant the privilege. Valid values: 'present', 'absent'. -Default value: 'present' +Default value: `'present'` ##### `group` @@ -1693,7 +1694,7 @@ Data type: `String` Sets the OS group to run psql -Default value: $postgresql::server::group +Default value: `$postgresql::server::group` ##### `psql_path` @@ -1701,7 +1702,7 @@ Data type: `String` Sets the path to psql command -Default value: $postgresql::server::psql_path +Default value: `$postgresql::server::psql_path` ##### `object_arguments` @@ -1709,9 +1710,9 @@ Data type: `Array[String[1],0]` -Default value: [] +Default value: `[]` -### postgresql::server::grant_role +### `postgresql::server::grant_role` Define for granting membership to a role. @@ -1731,7 +1732,7 @@ Data type: `String[1]` Specifies the role you want to assign to a group. If left blank, uses the name of the resource. -Default value: $name +Default value: `$name` ##### `ensure` @@ -1739,7 +1740,7 @@ Data type: `Enum['present', 'absent']` Specifies whether to grant or revoke the membership. Valid options: 'present' or 'absent'. -Default value: 'present' +Default value: `'present'` ##### `psql_db` @@ -1747,7 +1748,7 @@ Data type: `Any` Specifies the database to execute the grant against. This should not ordinarily be changed from the default -Default value: $postgresql::server::default_database +Default value: `$postgresql::server::default_database` ##### `psql_user` @@ -1755,7 +1756,7 @@ Data type: `Any` Sets the OS user to run psql. -Default value: $postgresql::server::user +Default value: `$postgresql::server::user` ##### `port` @@ -1763,7 +1764,7 @@ Data type: `Any` Port to use when connecting. -Default value: $postgresql::server::port +Default value: `$postgresql::server::port` ##### `connect_settings` @@ -1771,9 +1772,9 @@ Data type: `Any` Specifies a hash of environment variables used when connecting to a remote server. -Default value: $postgresql::server::default_connect_settings +Default value: `$postgresql::server::default_connect_settings` -### postgresql::server::pg_hba_rule +### `postgresql::server::pg_hba_rule` This resource manages an individual rule that applies to the file defined in target. @@ -1812,7 +1813,7 @@ Data type: `Optional[String]` Sets a CIDR based address for this rule matching when the type is not 'local'. -Default value: `undef` +Default value: ``undef`` ##### `description` @@ -1820,7 +1821,7 @@ Data type: `String` Defines a longer description for this rule, if required. This description is placed in the comments above the rule in pg_hba.conf. Default value: 'none'. -Default value: 'none' +Default value: `'none'` ##### `auth_option` @@ -1828,7 +1829,7 @@ Data type: `Optional[String]` For certain auth_method settings there are extra options that can be passed. Consult the PostgreSQL pg_hba.conf documentation for further details. -Default value: `undef` +Default value: ``undef`` ##### `order` @@ -1836,7 +1837,7 @@ Data type: `Variant[String, Integer]` Sets an order for placing the rule in pg_hba.conf. This can be either a string or an integer. If it is an integer, it will be converted to a string by zero-padding it to three digits. E.g. 42 will be zero-padded to the string '042'. The pg_hba_rule fragments are sorted using the alpha sorting order. Default value: 150. -Default value: 150 +Default value: `150` ##### `target` @@ -1844,7 +1845,7 @@ Data type: `Stdlib::Absolutepath` Provides the target for the rule, and is generally an internal only property. Use with caution. -Default value: $postgresql::server::pg_hba_conf_path +Default value: `$postgresql::server::pg_hba_conf_path` ##### `postgresql_version` @@ -1852,9 +1853,9 @@ Data type: `String` Manages pg_hba.conf without managing the entire PostgreSQL instance. -Default value: $postgresql::server::_version +Default value: `$postgresql::server::_version` -### postgresql::server::pg_ident_rule +### `postgresql::server::pg_ident_rule` This resource manages an individual rule that applies to the file defined in target. @@ -1886,7 +1887,7 @@ Data type: `Any` Sets a longer description for this rule if required. This description is placed in the comments above the rule in pg_ident.conf. Default value: 'none'. -Default value: 'none' +Default value: `'none'` ##### `order` @@ -1894,7 +1895,7 @@ Data type: `Any` Defines an order for placing the mapping in pg_ident.conf. Default value: 150. -Default value: '150' +Default value: `'150'` ##### `target` @@ -1902,9 +1903,9 @@ Data type: `Any` Provides the target for the rule and is generally an internal only property. Use with caution. -Default value: $postgresql::server::pg_ident_conf_path +Default value: `$postgresql::server::pg_ident_conf_path` -### postgresql::server::reassign_owned_by +### `postgresql::server::reassign_owned_by` Define for reassigning the ownership of objects within a database. @@ -1938,7 +1939,7 @@ Data type: `String` Specifies the OS user for running psql. -Default value: $postgresql::server::user +Default value: `$postgresql::server::user` ##### `port` @@ -1946,7 +1947,7 @@ Data type: `Integer` Port to use when connecting. -Default value: $postgresql::server::port +Default value: `$postgresql::server::port` ##### `connect_settings` @@ -1954,9 +1955,9 @@ Data type: `Hash` Specifies a hash of environment variables used when connecting to a remote server. -Default value: $postgresql::server::default_connect_settings +Default value: `$postgresql::server::default_connect_settings` -### postgresql::server::recovery +### `postgresql::server::recovery` This resource manages the parameters that applies to the recovery.conf template. @@ -1975,7 +1976,7 @@ Data type: `Any` The shell command to execute to retrieve an archived segment of the WAL file series. -Default value: `undef` +Default value: ``undef`` ##### `archive_cleanup_command` @@ -1983,7 +1984,7 @@ Data type: `Any` This optional parameter specifies a shell command that will be executed at every restartpoint. -Default value: `undef` +Default value: ``undef`` ##### `recovery_end_command` @@ -1991,7 +1992,7 @@ Data type: `Any` This parameter specifies a shell command that will be executed once only at the end of recovery. -Default value: `undef` +Default value: ``undef`` ##### `recovery_target_name` @@ -1999,7 +2000,7 @@ Data type: `Any` This parameter specifies the named restore point (created with pg_create_restore_point()) to which recovery will proceed. -Default value: `undef` +Default value: ``undef`` ##### `recovery_target_time` @@ -2007,7 +2008,7 @@ Data type: `Any` This parameter specifies the time stamp up to which recovery will proceed. -Default value: `undef` +Default value: ``undef`` ##### `recovery_target_xid` @@ -2015,7 +2016,7 @@ Data type: `Any` This parameter specifies the transaction ID up to which recovery will proceed. -Default value: `undef` +Default value: ``undef`` ##### `recovery_target_inclusive` @@ -2023,7 +2024,7 @@ Data type: `Any` Specifies whether to stop just after the specified recovery target (true), or just before the recovery target (false). -Default value: `undef` +Default value: ``undef`` ##### `recovery_target` @@ -2031,7 +2032,7 @@ Data type: `Any` This parameter specifies that recovery should end as soon as a consistent state is reached, i.e. as early as possible. -Default value: `undef` +Default value: ``undef`` ##### `recovery_target_timeline` @@ -2039,7 +2040,7 @@ Data type: `Any` Specifies recovering into a particular timeline. -Default value: `undef` +Default value: ``undef`` ##### `pause_at_recovery_target` @@ -2047,7 +2048,7 @@ Data type: `Any` Specifies whether recovery should pause when the recovery target is reached. -Default value: `undef` +Default value: ``undef`` ##### `standby_mode` @@ -2055,7 +2056,7 @@ Data type: `Any` Specifies whether to start the PostgreSQL server as a standby. -Default value: `undef` +Default value: ``undef`` ##### `primary_conninfo` @@ -2063,7 +2064,7 @@ Data type: `Any` Specifies a connection string to be used for the standby server to connect with the primary. -Default value: `undef` +Default value: ``undef`` ##### `primary_slot_name` @@ -2071,7 +2072,7 @@ Data type: `Any` Optionally specifies an existing replication slot to be used when connecting to the primary via streaming replication to control resource removal on the upstream node. -Default value: `undef` +Default value: ``undef`` ##### `trigger_file` @@ -2079,7 +2080,7 @@ Data type: `Any` Specifies a trigger file whose presence ends recovery in the standby. -Default value: `undef` +Default value: ``undef`` ##### `recovery_min_apply_delay` @@ -2087,7 +2088,7 @@ Data type: `Any` This parameter allows you to delay recovery by a fixed period of time, measured in milliseconds if no unit is specified. -Default value: `undef` +Default value: ``undef`` ##### `target` @@ -2095,9 +2096,9 @@ Data type: `Any` Provides the target for the rule, and is generally an internal only property. Use with caution. -Default value: $postgresql::server::recovery_conf_path +Default value: `$postgresql::server::recovery_conf_path` -### postgresql::server::role +### `postgresql::server::role` Define for creating a database role. @@ -2111,7 +2112,7 @@ Data type: `Any` If set to true, updates the password on changes. Set this to false to not modify the role's password after creation. -Default value: `true` +Default value: ``true`` ##### `password_hash` @@ -2119,7 +2120,7 @@ Data type: `Any` Sets the hash to use during password creation. -Default value: `false` +Default value: ``false`` ##### `createdb` @@ -2127,7 +2128,7 @@ Data type: `Any` Specifies whether to grant the ability to create new databases with this role. -Default value: `false` +Default value: ``false`` ##### `createrole` @@ -2135,7 +2136,7 @@ Data type: `Any` Specifies whether to grant the ability to create new roles with this role. -Default value: `false` +Default value: ``false`` ##### `db` @@ -2143,7 +2144,7 @@ Data type: `Any` Database used to connect to. -Default value: $postgresql::server::default_database +Default value: `$postgresql::server::default_database` ##### `port` @@ -2151,7 +2152,7 @@ Data type: `Any` Port to use when connecting. -Default value: `undef` +Default value: ``undef`` ##### `login` @@ -2159,7 +2160,7 @@ Data type: `Any` Specifies whether to grant login capability for the new role. -Default value: `true` +Default value: ``true`` ##### `inherit` @@ -2167,7 +2168,7 @@ Data type: `Any` Specifies whether to grant inherit capability for the new role. -Default value: `true` +Default value: ``true`` ##### `superuser` @@ -2175,7 +2176,7 @@ Data type: `Any` Specifies whether to grant super user capability for the new role. -Default value: `false` +Default value: ``false`` ##### `replication` @@ -2183,7 +2184,7 @@ Data type: `Any` Provides provides replication capabilities for this role if set to true. -Default value: `false` +Default value: ``false`` ##### `connection_limit` @@ -2191,7 +2192,7 @@ Data type: `Any` Specifies how many concurrent connections the role can make. Default value: '-1', meaning no limit. -Default value: '-1' +Default value: `'-1'` ##### `username` @@ -2199,7 +2200,7 @@ Data type: `Any` Defines the username of the role to create. -Default value: $title +Default value: `$title` ##### `connect_settings` @@ -2207,7 +2208,7 @@ Data type: `Any` Specifies a hash of environment variables used when connecting to a remote server. -Default value: $postgresql::server::default_connect_settings +Default value: `$postgresql::server::default_connect_settings` ##### `ensure` @@ -2215,7 +2216,7 @@ Data type: `Enum['present', 'absent']` Specify whether to create or drop the role. Specifying 'present' creates the role. Specifying 'absent' drops the role. -Default value: 'present' +Default value: `'present'` ##### `psql_user` @@ -2223,7 +2224,7 @@ Data type: `Any` Sets the OS user to run psql -Default value: $postgresql::server::user +Default value: `$postgresql::server::user` ##### `psql_group` @@ -2231,7 +2232,7 @@ Data type: `Any` Sets the OS group to run psql -Default value: $postgresql::server::group +Default value: `$postgresql::server::group` ##### `psql_path` @@ -2239,7 +2240,7 @@ Data type: `Any` Sets path to psql command -Default value: $postgresql::server::psql_path +Default value: `$postgresql::server::psql_path` ##### `module_workdir` @@ -2247,9 +2248,9 @@ Data type: `Any` Specifies working directory under which the psql command should be executed. May need to specify if '/tmp' is on volume mounted with noexec option. -Default value: $postgresql::server::module_workdir +Default value: `$postgresql::server::module_workdir` -### postgresql::server::schema +### `postgresql::server::schema` Create a new schema. @@ -2275,7 +2276,7 @@ Data type: `Any` Required. Sets the name of the database in which to create this schema. -Default value: $postgresql::server::default_database +Default value: `$postgresql::server::default_database` ##### `owner` @@ -2283,7 +2284,7 @@ Data type: `Any` Sets the default owner of the schema. -Default value: `undef` +Default value: ``undef`` ##### `schema` @@ -2291,7 +2292,7 @@ Data type: `Any` Sets the name of the schema. -Default value: $title +Default value: `$title` ##### `connect_settings` @@ -2299,9 +2300,9 @@ Data type: `Any` Specifies a hash of environment variables used when connecting to a remote server. -Default value: $postgresql::server::default_connect_settings +Default value: `$postgresql::server::default_connect_settings` -### postgresql::server::table_grant +### `postgresql::server::table_grant` This resource wraps the grant resource to manage table grants specifically. @@ -2339,7 +2340,7 @@ Data type: `Any` Specifies whether to grant or revoke the privilege. Default is to grant the privilege. -Default value: `undef` +Default value: ``undef`` ##### `port` @@ -2347,7 +2348,7 @@ Data type: `Any` Port to use when connecting. -Default value: `undef` +Default value: ``undef`` ##### `psql_db` @@ -2355,7 +2356,7 @@ Data type: `Any` Specifies the database to execute the grant against. This should not ordinarily be changed from the default. -Default value: `undef` +Default value: ``undef`` ##### `psql_user` @@ -2363,7 +2364,7 @@ Data type: `Any` Specifies the OS user for running psql. -Default value: `undef` +Default value: ``undef`` ##### `connect_settings` @@ -2371,7 +2372,7 @@ Data type: `Any` Specifies a hash of environment variables used when connecting to a remote server. -Default value: `undef` +Default value: ``undef`` ##### `onlyif_exists` @@ -2379,9 +2380,9 @@ Data type: `Any` Create grant only if it doesn't exist. -Default value: `false` +Default value: ``false`` -### postgresql::server::tablespace +### `postgresql::server::tablespace` This module creates tablespace. @@ -2401,7 +2402,7 @@ Data type: `Any` Set to false if you have file{ $location: } already defined -Default value: `true` +Default value: ``true`` ##### `owner` @@ -2409,7 +2410,7 @@ Data type: `Any` Specifies the default owner of the tablespace. -Default value: `undef` +Default value: ``undef`` ##### `spcname` @@ -2417,7 +2418,7 @@ Data type: `Any` Specifies the name of the tablespace. -Default value: $title +Default value: `$title` ##### `connect_settings` @@ -2425,9 +2426,9 @@ Data type: `Any` Specifies a hash of environment variables used when connecting to a remote server. -Default value: $postgresql::server::default_connect_settings +Default value: `$postgresql::server::default_connect_settings` -### postgresql::validate_db_connection +### `postgresql::validate_db_connection` This validated if the postgres connection can be established between the node on which this resource is run and a specified postgres @@ -2443,7 +2444,7 @@ Data type: `Any` Database host address -Default value: `undef` +Default value: ``undef`` ##### `database_name` @@ -2451,7 +2452,7 @@ Data type: `Any` Specifies the name of the database you wish to test. -Default value: `undef` +Default value: ``undef`` ##### `database_password` @@ -2459,7 +2460,7 @@ Data type: `Any` Specifies the password to connect with. -Default value: `undef` +Default value: ``undef`` ##### `database_username` @@ -2467,7 +2468,7 @@ Data type: `Any` Specifies the username to connect with. -Default value: `undef` +Default value: ``undef`` ##### `database_port` @@ -2475,7 +2476,7 @@ Data type: `Any` Defines the port to use when connecting. -Default value: `undef` +Default value: ``undef`` ##### `connect_settings` @@ -2483,7 +2484,7 @@ Data type: `Any` Specifies a hash of environment variables used when connecting to a remote server. -Default value: `undef` +Default value: ``undef`` ##### `run_as` @@ -2491,7 +2492,7 @@ Data type: `Any` Specifies the user to run the psql command as. -Default value: `undef` +Default value: ``undef`` ##### `sleep` @@ -2499,7 +2500,7 @@ Data type: `Any` Sets the number of seconds to sleep for before trying again after a failure. -Default value: 2 +Default value: `2` ##### `tries` @@ -2507,7 +2508,7 @@ Data type: `Any` Sets the number of attempts after failure before giving up and failing the resource. -Default value: 10 +Default value: `10` ##### `create_db_first` @@ -2515,11 +2516,11 @@ Data type: `Any` Creates the database when obtaining a successful connection. -Default value: `true` +Default value: ``true`` ## Resource types -### postgresql_conf +### `postgresql_conf` This type allows puppet to manage postgresql.conf parameters. @@ -2529,33 +2530,38 @@ The following properties are available in the `postgresql_conf` type. ##### `ensure` -Valid values: present, absent +Valid values: `present`, `absent` The basic property that the resource should be in. -Default value: present - -##### `value` - -The value to set for this parameter. +Default value: `present` ##### `target` The path to postgresql.conf +##### `value` + +The value to set for this parameter. + #### Parameters The following parameters are available in the `postgresql_conf` type. ##### `name` -Valid values: %r{^[\w\.]+$} +Valid values: `%r{^[\w\.]+$}` namevar The postgresql parameter name to manage. -### postgresql_conn_validator +##### `provider` + +The specific backend to use for this `postgresql_conf` resource. You will seldom need to specify this --- Puppet will +usually discover the appropriate provider for your platform. + +### `postgresql_conn_validator` Verify that a connection can be successfully established between a node and the PostgreSQL server. Its primary use is as a precondition to @@ -2569,57 +2575,56 @@ The following properties are available in the `postgresql_conn_validator` type. ##### `ensure` -Valid values: present, absent +Valid values: `present`, `absent` Ensure connection validation -Default value: present +Default value: `present` #### Parameters The following parameters are available in the `postgresql_conn_validator` type. -##### `name` +##### `command` -namevar +Command to run against target database. -An arbitrary name used as the identity of the resource. +Default value: `SELECT 1` -##### `db_name` +##### `connect_settings` -The name of the database you are trying to validate a connection with. +Hash of environment variables for connection to a db. -##### `db_username` +##### `db_name` -A user that has access to the target PostgreSQL database. +The name of the database you are trying to validate a connection with. ##### `db_password` The password required to access the target PostgreSQL database. -##### `host` - -The DNS name or IP address of the server where PostgreSQL should be running. +##### `db_username` -##### `port` +A user that has access to the target PostgreSQL database. -The port that the PostgreSQL server should be listening on. +##### `host` -##### `connect_settings` +The DNS name or IP address of the server where PostgreSQL should be running. -Hash of environment variables for connection to a db. +##### `name` -##### `sleep` +namevar -The length of sleep time between connection tries. +An arbitrary name used as the identity of the resource. -Default value: 2 +##### `port` -##### `tries` +The port that the PostgreSQL server should be listening on. -The number of tries to validate the connection to the target PostgreSQL database. +##### `provider` -Default value: 10 +The specific backend to use for this `postgresql_conn_validator` resource. You will seldom need to specify this --- +Puppet will usually discover the appropriate provider for your platform. ##### `psql_path` @@ -2629,13 +2634,19 @@ Path to the psql command. System user that will run the psql command. -##### `command` +##### `sleep` -Command to run against target database. +The length of sleep time between connection tries. + +Default value: `2` -Default value: SELECT 1 +##### `tries` -### postgresql_psql +The number of tries to validate the connection to the target PostgreSQL database. + +Default value: `10` + +### `postgresql_psql` An arbitrary tag for your own reference; the name of the message. @@ -2651,19 +2662,32 @@ The SQL command to execute via psql. The following parameters are available in the `postgresql_psql` type. +##### `connect_settings` + +Connection settings that will be used when connecting to postgres + +##### `cwd` + +The working directory under which the psql command should be executed. + +Default value: `/tmp` + +##### `db` + +The name of the database to execute the SQL command against, this overrides any PGDATABASE value in connect_settings + +##### `environment` + +Any additional environment variables you want to set for a +SQL command. Multiple environment variables should be +specified as an array. + ##### `name` namevar An arbitrary tag for your own reference; the name of the message. -##### `unless` - -An optional SQL command to execute prior to the main :command; -this is generally intended to be used for idempotency, to check -for the existence of an object in the database to determine whether -or not the main SQL command needs to be executed at all.' - ##### `onlyif` An optional SQL command to execute prior to the main :command; @@ -2671,61 +2695,53 @@ this is generally intended to be used for idempotency, to check for the existence of an object in the database to determine whether or not the main SQL command needs to be executed at all. -##### `connect_settings` - -Connection settings that will be used when connecting to postgres +##### `port` -##### `db` +The port of the database server to execute the SQL command against, this overrides any PGPORT value in connect_settings. -The name of the database to execute the SQL command against, this overrides any PGDATABASE value in connect_settings +##### `provider` -##### `port` +The specific backend to use for this `postgresql_psql` resource. You will seldom need to specify this --- Puppet will +usually discover the appropriate provider for your platform. -The port of the database server to execute the SQL command against, this overrides any PGPORT value in connect_settings. +##### `psql_group` -##### `search_path` +The system user group account under which the psql command should be executed. -The schema search path to use when executing the SQL command +Default value: `postgres` ##### `psql_path` The path to psql executable. -Default value: psql +Default value: `psql` ##### `psql_user` The system user account under which the psql command should be executed. -Default value: postgres - -##### `psql_group` - -The system user group account under which the psql command should be executed. +Default value: `postgres` -Default value: postgres - -##### `cwd` +##### `refreshonly` -The working directory under which the psql command should be executed. +Valid values: ``true``, ``false`` -Default value: /tmp +If 'true', then the SQL will only be executed via a notify/subscribe event. -##### `environment` +Default value: ``false`` -Any additional environment variables you want to set for a -SQL command. Multiple environment variables should be -specified as an array. - -##### `refreshonly` +##### `search_path` -Valid values: `true`, `false` +The schema search path to use when executing the SQL command -If 'true', then the SQL will only be executed via a notify/subscribe event. +##### `unless` -Default value: `false` +An optional SQL command to execute prior to the main :command; +this is generally intended to be used for idempotency, to check +for the existence of an object in the database to determine whether +or not the main SQL command needs to be executed at all.' -### postgresql_replication_slot +### `postgresql_replication_slot` This type allows to create and destroy replication slots to register warm standby replication on a Postgresql @@ -2737,11 +2753,11 @@ The following properties are available in the `postgresql_replication_slot` type ##### `ensure` -Valid values: present, absent +Valid values: `present`, `absent` The basic property that the resource should be in. -Default value: present +Default value: `present` #### Parameters @@ -2749,15 +2765,20 @@ The following parameters are available in the `postgresql_replication_slot` type ##### `name` -Valid values: %r{^[a-z0-9_]+$} +Valid values: `%r{^[a-z0-9_]+$}` namevar The name of the slot to create. Must be a valid replication slot name. +##### `provider` + +The specific backend to use for this `postgresql_replication_slot` resource. You will seldom need to specify this --- +Puppet will usually discover the appropriate provider for your platform. + ## Functions -### postgresql::default +### `postgresql::default` Type: Puppet Language @@ -2791,7 +2812,7 @@ Data type: `String` -### postgresql::postgresql_escape +### `postgresql::postgresql_escape` Type: Ruby 4.x API @@ -2809,7 +2830,7 @@ Data type: `String[1]` The unescaped string you want to escape using `dollar quoting` -### postgresql::postgresql_password +### `postgresql::postgresql_password` Type: Ruby 4.x API @@ -2833,7 +2854,7 @@ Data type: `Variant[String[1],Integer]` The clear text `password` -### postgresql_escape +### `postgresql_escape` Type: Ruby 4.x API @@ -2851,7 +2872,7 @@ Data type: `Any` -### postgresql_password +### `postgresql_password` Type: Ruby 4.x API @@ -2871,7 +2892,7 @@ Data type: `Any` ## Tasks -### sql +### `sql` Allows you to execute arbitary SQL diff --git a/metadata.json b/metadata.json index bc611969ac..dc1cc66fe9 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-postgresql", - "version": "6.6.0", + "version": "6.7.0", "author": "Inkling/Puppet Labs", "summary": "Offers support for basic management of PostgreSQL databases.", "license": "Apache-2.0",