From e463cdaa206720a64ffa2be7396070c8b9c1258b Mon Sep 17 00:00:00 2001 From: Ewoud Kohl van Wijngaarden Date: Tue, 23 Aug 2022 17:47:08 +0200 Subject: [PATCH] Fix puppet-strings documentation In 37e5bea4399ab926e6041190347e24d55a08a51c an empty line was added, splitting the documentation block. Removing the empty line creates a single documentation block again. Fixes: 37e5bea4399ab926e6041190347e24d55a08a51c --- REFERENCE.md | 36 +++++++++++++++++++++++++++++++++--- manifests/server.pp | 2 +- 2 files changed, 34 insertions(+), 4 deletions(-) diff --git a/REFERENCE.md b/REFERENCE.md index 87f1e8c29a..ee140fe370 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -23,6 +23,7 @@ #### Private Classes +* `postgresql::backup::pg_dump`: "Provider" for pg_dump backup * `postgresql::dnfmodule`: Manage the DNF module * `postgresql::params` * `postgresql::repo` @@ -858,6 +859,9 @@ The following parameters are available in the `postgresql::server` class: * [`roles`](#roles) * [`config_entries`](#config_entries) * [`pg_hba_rules`](#pg_hba_rules) +* [`backup_enable`](#backup_enable) +* [`backup_options`](#backup_options) +* [`backup_provider`](#backup_provider) * [`version`](#version) * [`extra_systemd_config`](#extra_systemd_config) * [`manage_selinux`](#manage_selinux) @@ -1286,6 +1290,30 @@ Specifies a hash from which to generate postgresql::server::pg_hba_rule resource Default value: `{}` +##### `backup_enable` + +Data type: `Boolean` + +Whether a backup job should be enabled. + +Default value: `$postgresql::params::backup_enable` + +##### `backup_options` + +Data type: `Hash` + +A hash of options that should be passed through to the backup provider. + +Default value: `{}` + +##### `backup_provider` + +Data type: `Enum['pg_dump']` + +Specifies the backup provider to use. + +Default value: `$postgresql::params::backup_provider` + ##### `version` Data type: `Any` @@ -1644,13 +1672,15 @@ The following parameters are available in the `postgresql::server::db` defined t Data type: `Any` -User to create and assign access to the database upon creation. Mandatory. +User to assign access to the database upon creation (will be created if not defined elsewhere). Mandatory. ##### `password` -Data type: `Variant[String, Sensitive[String]]` +Data type: `Optional[Variant[String, Sensitive[String]]]` + +Sets the password for the created user (if a user is created). -Required Sets the password for the created user. +Default value: ``undef`` ##### `comment` diff --git a/manifests/server.pp b/manifests/server.pp index 7727ddc479..db84e478e1 100644 --- a/manifests/server.pp +++ b/manifests/server.pp @@ -77,7 +77,7 @@ # @param roles Specifies a hash from which to generate postgresql::server::role resources. # @param config_entries Specifies a hash from which to generate postgresql::server::config_entry resources. # @param pg_hba_rules Specifies a hash from which to generate postgresql::server::pg_hba_rule resources. - +# # @param backup_enable Whether a backup job should be enabled. # @param backup_options A hash of options that should be passed through to the backup provider. # @param backup_provider Specifies the backup provider to use.