Add description for recovery and validation

Author: Daniel Carabas

REFERENCE.md

@@ -1838,119 +1838,119 @@ The following parameters are available in the `postgresql::server::recovery` def
 
 Data type: `Any`
 
-
+The shell command to execute to retrieve an archived segment of the WAL file series.
 
 Default value: `undef`
 
 ##### `archive_cleanup_command`
 
 Data type: `Any`
 
-
+This optional parameter specifies a shell command that will be executed at every restartpoint.
 
 Default value: `undef`
 
 ##### `recovery_end_command`
 
 Data type: `Any`
 
-
+This parameter specifies a shell command that will be executed once only at the end of recovery.
 
 Default value: `undef`
 
 ##### `recovery_target_name`
 
 Data type: `Any`
 
-
+This parameter specifies the named restore point (created with pg_create_restore_point()) to which recovery will proceed.
 
 Default value: `undef`
 
 ##### `recovery_target_time`
 
 Data type: `Any`
 
-
+This parameter specifies the time stamp up to which recovery will proceed.
 
 Default value: `undef`
 
 ##### `recovery_target_xid`
 
 Data type: `Any`
 
-
+This parameter specifies the transaction ID up to which recovery will proceed.
 
 Default value: `undef`
 
 ##### `recovery_target_inclusive`
 
 Data type: `Any`
 
-
+Specifies whether to stop just after the specified recovery target (true), or just before the recovery target (false).
 
 Default value: `undef`
 
 ##### `recovery_target`
 
 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`
 
 ##### `recovery_target_timeline`
 
 Data type: `Any`
 
-
+Specifies recovering into a particular timeline.
 
 Default value: `undef`
 
 ##### `pause_at_recovery_target`
 
 Data type: `Any`
 
-
+Specifies whether recovery should pause when the recovery target is reached.
 
 Default value: `undef`
 
 ##### `standby_mode`
 
 Data type: `Any`
 
-Can be specified with the string ('on'/'off'), or by using a Boolean value (true/false).
+Specifies whether to start the PostgreSQL server as a standby.
 
 Default value: `undef`
 
 ##### `primary_conninfo`
 
 Data type: `Any`
 
-
+Specifies a connection string to be used for the standby server to connect with the primary.
 
 Default value: `undef`
 
 ##### `primary_slot_name`
 
 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`
 
 ##### `trigger_file`
 
 Data type: `Any`
 
-
+Specifies a trigger file whose presence ends recovery in the standby.
 
 Default value: `undef`
 
 ##### `recovery_min_apply_delay`
 
 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`
 
@@ -2266,79 +2266,79 @@ The following parameters are available in the `postgresql::validate_db_connectio
 
 Data type: `Any`
 
-
+Database host address
 
 Default value: `undef`
 
 ##### `database_name`
 
 Data type: `Any`
 
-
+Specifies the name of the database you wish to test.
 
 Default value: `undef`
 
 ##### `database_password`
 
 Data type: `Any`
 
-
+Specifies the password to connect with.
 
 Default value: `undef`
 
 ##### `database_username`
 
 Data type: `Any`
 
-
+Specifies the username to connect with.
 
 Default value: `undef`
 
 ##### `database_port`
 
 Data type: `Any`
 
-
+Defines the port to use when connecting.
 
 Default value: `undef`
 
 ##### `connect_settings`
 
 Data type: `Any`
 
-
+Specifies a hash of environment variables used when connecting to a remote server.
 
 Default value: `undef`
 
 ##### `run_as`
 
 Data type: `Any`
 
-
+Specifies the user to run the psql command as.
 
 Default value: `undef`
 
 ##### `sleep`
 
 Data type: `Any`
 
-
+Sets the number of seconds to sleep for before trying again after a failure.
 
 Default value: 2
 
 ##### `tries`
 
 Data type: `Any`
 
-
+Sets the number of attempts after failure before giving up and failing the resource.
 
 Default value: 10
 
 ##### `create_db_first`
 
 Data type: `Any`
 
-
+Creates the database when obtaining a successful connection.
 
 Default value: `true`
 

manifests/server/recovery.pp

@@ -6,21 +6,21 @@
 #  A detailed description of all listed parameters can be found in the PostgreSQL documentation.
 #  Only the specified parameters are recognized in the template. The recovery.conf is only created if at least one parameter is set and manage_recovery_conf is set to true.
 #
-# @param restore_command
-# @param archive_cleanup_command
-# @param recovery_end_command
-# @param recovery_target_name 
-# @param recovery_target_time
-# @param recovery_target_xid
-# @param recovery_target_inclusive
-# @param recovery_target
-# @param recovery_target_timeline
-# @param pause_at_recovery_target
-# @param standby_mode Can be specified with the string ('on'/'off'), or by using a Boolean value (true/false).
-# @param primary_conninfo
-# @param primary_slot_name
-# @param trigger_file
-# @param recovery_min_apply_delay
+# @param restore_command The shell command to execute to retrieve an archived segment of the WAL file series.
+# @param archive_cleanup_command This optional parameter specifies a shell command that will be executed at every restartpoint.
+# @param recovery_end_command This parameter specifies a shell command that will be executed once only at the end of recovery.
+# @param recovery_target_name This parameter specifies the named restore point (created with pg_create_restore_point()) to which recovery will proceed.
+# @param recovery_target_time This parameter specifies the time stamp up to which recovery will proceed.
+# @param recovery_target_xid This parameter specifies the transaction ID up to which recovery will proceed.
+# @param recovery_target_inclusive Specifies whether to stop just after the specified recovery target (true), or just before the recovery target (false).
+# @param recovery_target This parameter specifies that recovery should end as soon as a consistent state is reached, i.e. as early as possible.
+# @param recovery_target_timeline Specifies recovering into a particular timeline.
+# @param pause_at_recovery_target Specifies whether recovery should pause when the recovery target is reached.
+# @param standby_mode Specifies whether to start the PostgreSQL server as a standby.
+# @param primary_conninfo  Specifies a connection string to be used for the standby server to connect with the primary.
+# @param primary_slot_name 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.
+# @param trigger_file Specifies a trigger file whose presence ends recovery in the standby.
+# @param recovery_min_apply_delay This parameter allows you to delay recovery by a fixed period of time, measured in milliseconds if no unit is specified.
 # @param target Provides the target for the rule, and is generally an internal only property. Use with caution.
 define postgresql::server::recovery(
   $restore_command                = undef,

manifests/validate_db_connection.pp

@@ -6,16 +6,16 @@
 # instance (host/port/user/password/database name).
 #
 #
-# @param database_host
-# @param database_name
-# @param database_password
-# @param database_username
-# @param database_port
-# @param connect_settings
-# @param run_as
-# @param sleep
-# @param tries
-# @param create_db_first
+# @param database_host Database host address
+# @param database_name Specifies the name of the database you wish to test.
+# @param database_password Specifies the password to connect with.
+# @param database_username Specifies the username to connect with.
+# @param database_port Defines the port to use when connecting.
+# @param connect_settings Specifies a hash of environment variables used when connecting to a remote server.
+# @param run_as Specifies the user to run the psql command as.
+# @param sleep Sets the number of seconds to sleep for before trying again after a failure.
+# @param tries Sets the number of attempts after failure before giving up and failing the resource.
+# @param create_db_first Creates the database when obtaining a successful connection.
 #
 define postgresql::validate_db_connection(
   $database_host     = undef,