add missing parameter documentation to database::postgresql class

Author: h0tw1r3

REFERENCE.md

@@ -964,19 +964,18 @@ create the PuppetDB postgresql database
 The following parameters are available in the `puppetdb::database::postgresql` class:
 
 * [`listen_addresses`](#-puppetdb--database--postgresql--listen_addresses)
+* [`puppetdb_server`](#-puppetdb--database--postgresql--puppetdb_server)
 * [`database_name`](#-puppetdb--database--postgresql--database_name)
 * [`database_username`](#-puppetdb--database--postgresql--database_username)
 * [`database_password`](#-puppetdb--database--postgresql--database_password)
+* [`database_port`](#-puppetdb--database--postgresql--database_port)
+* [`manage_database`](#-puppetdb--database--postgresql--manage_database)
 * [`manage_server`](#-puppetdb--database--postgresql--manage_server)
-* [`test_url`](#-puppetdb--database--postgresql--test_url)
 * [`manage_package_repo`](#-puppetdb--database--postgresql--manage_package_repo)
 * [`postgres_version`](#-puppetdb--database--postgresql--postgres_version)
-* [`puppetdb_server`](#-puppetdb--database--postgresql--puppetdb_server)
-* [`database_port`](#-puppetdb--database--postgresql--database_port)
-* [`manage_database`](#-puppetdb--database--postgresql--manage_database)
 * [`postgresql_ssl_on`](#-puppetdb--database--postgresql--postgresql_ssl_on)
-* [`postgresql_ssl_key_path`](#-puppetdb--database--postgresql--postgresql_ssl_key_path)
 * [`postgresql_ssl_cert_path`](#-puppetdb--database--postgresql--postgresql_ssl_cert_path)
+* [`postgresql_ssl_key_path`](#-puppetdb--database--postgresql--postgresql_ssl_key_path)
 * [`postgresql_ssl_ca_cert_path`](#-puppetdb--database--postgresql--postgresql_ssl_ca_cert_path)
 * [`read_database_username`](#-puppetdb--database--postgresql--read_database_username)
 * [`read_database_password`](#-puppetdb--database--postgresql--read_database_password)
@@ -993,6 +992,14 @@ config option. Use a `*` to allow connections on any accessible address.
 
 Default value: `$puppetdb::params::database_host`
 
+##### <a name="-puppetdb--database--postgresql--puppetdb_server"></a>`puppetdb_server`
+
+Data type: `Any`
+
+Hostname or IP address to configure for SSL rules.
+
+Default value: `$puppetdb::params::puppetdb_server`
+
 ##### <a name="-puppetdb--database--postgresql--database_name"></a>`database_name`
 
 Data type: `Any`
@@ -1017,6 +1024,22 @@ Sets the password for the database user above. Defaults to `puppetdb`.
 
 Default value: `$puppetdb::params::database_password`
 
+##### <a name="-puppetdb--database--postgresql--database_port"></a>`database_port`
+
+Data type: `Any`
+
+The port that the database server listens on. Defaults to `5432`.
+
+Default value: `$puppetdb::params::database_port`
+
+##### <a name="-puppetdb--database--postgresql--manage_database"></a>`manage_database`
+
+Data type: `Any`
+
+If true, the PostgreSQL database will be managed by this module. Defaults to `true`.
+
+Default value: `$puppetdb::params::manage_database`
+
 ##### <a name="-puppetdb--database--postgresql--manage_server"></a>`manage_server`
 
 Data type: `Any`
@@ -1027,11 +1050,6 @@ to `true`. If set to `false`, this class will create the database and user via
 
 Default value: `$puppetdb::params::manage_dbserver`
 
-##### <a name="-puppetdb--database--postgresql--test_url"></a>`test_url`
-
-The URL to use for testing if the PuppetDB instance is running. Defaults to
-`/pdb/meta/v1/version`.
-
 ##### <a name="-puppetdb--database--postgresql--manage_package_repo"></a>`manage_package_repo`
 
 Data type: `Any`
@@ -1050,83 +1068,66 @@ postgres. Defaults to `11` with PuppetDB version 7.0.0 or newer, and `9.6` in ol
 
 Default value: `$puppetdb::params::postgres_version`
 
-##### <a name="-puppetdb--database--postgresql--puppetdb_server"></a>`puppetdb_server`
-
-Data type: `Any`
-
-
-
-Default value: `$puppetdb::params::puppetdb_server`
-
-##### <a name="-puppetdb--database--postgresql--database_port"></a>`database_port`
-
-Data type: `Any`
-
-
-
-Default value: `$puppetdb::params::database_port`
-
-##### <a name="-puppetdb--database--postgresql--manage_database"></a>`manage_database`
-
-Data type: `Any`
-
-
-
-Default value: `$puppetdb::params::manage_database`
-
 ##### <a name="-puppetdb--database--postgresql--postgresql_ssl_on"></a>`postgresql_ssl_on`
 
 Data type: `Any`
 
-
+If `true`, it configures SSL connections between PuppetDB and the PostgreSQL database.
+Defaults to `false`.
 
 Default value: `$puppetdb::params::postgresql_ssl_on`
 
-##### <a name="-puppetdb--database--postgresql--postgresql_ssl_key_path"></a>`postgresql_ssl_key_path`
+##### <a name="-puppetdb--database--postgresql--postgresql_ssl_cert_path"></a>`postgresql_ssl_cert_path`
 
 Data type: `Any`
 
+Path to the Postgresql SSL certificate.
 
+Default value: `$puppetdb::params::postgresql_ssl_cert_path`
 
-Default value: `$puppetdb::params::postgresql_ssl_key_path`
-
-##### <a name="-puppetdb--database--postgresql--postgresql_ssl_cert_path"></a>`postgresql_ssl_cert_path`
+##### <a name="-puppetdb--database--postgresql--postgresql_ssl_key_path"></a>`postgresql_ssl_key_path`
 
 Data type: `Any`
 
+Path to the Postgresql SSL key.
 
-
-Default value: `$puppetdb::params::postgresql_ssl_cert_path`
+Default value: `$puppetdb::params::postgresql_ssl_key_path`
 
 ##### <a name="-puppetdb--database--postgresql--postgresql_ssl_ca_cert_path"></a>`postgresql_ssl_ca_cert_path`
 
 Data type: `Any`
 
-
+Path to the Postgresql SSL CA.
 
 Default value: `$puppetdb::params::postgresql_ssl_ca_cert_path`
 
 ##### <a name="-puppetdb--database--postgresql--read_database_username"></a>`read_database_username`
 
 Data type: `Any`
 
-
+The name of the read database user to connect as. Defaults to `puppetdb-read`. This
+option is supported in PuppetDB >= 1.6.
 
 Default value: `$puppetdb::params::read_database_username`
 
 ##### <a name="-puppetdb--database--postgresql--read_database_password"></a>`read_database_password`
 
 Data type: `Any`
 
-
+The password for the read database user. Defaults to `puppetdb-read`. This option is
+supported in PuppetDB >= 1.6.
 
 Default value: `$puppetdb::params::read_database_password`
 
 ##### <a name="-puppetdb--database--postgresql--read_database_host"></a>`read_database_host`
 
 Data type: `Any`
 
+*This parameter must be set to use another PuppetDB instance for queries.*
 
+The hostname or IP address of the read database server. If set to `undef`, and
+`manage_database` is set to `true`, it will use the value of the `database_host`
+parameter. This option is supported in PuppetDB >= 1.6.
 
 Default value: `$puppetdb::params::read_database_host`
 

manifests/database/postgresql.pp

@@ -6,6 +6,9 @@
 #   to `localhost`. This parameter maps directly to PostgreSQL's `listen_addresses`
 #   config option. Use a `*` to allow connections on any accessible address.
 #
+# @param puppetdb_server
+#   Hostname or IP address to configure for SSL rules.
+#
 # @param database_name
 #   Sets the name of the database. Defaults to `puppetdb`.
 #
@@ -15,15 +18,17 @@
 # @param database_password
 #   Sets the password for the database user above. Defaults to `puppetdb`.
 #
+# @param database_port
+#   The port that the database server listens on. Defaults to `5432`.
+#
+# @param manage_database
+#   If true, the PostgreSQL database will be managed by this module. Defaults to `true`.
+#
 # @param manage_server
 #   Conditionally manages the PostgreSQL server via `postgresql::server`. Defaults
 #   to `true`. If set to `false`, this class will create the database and user via
 #   `postgresql::server::db` but not attempt to install or manage the server itself.
 #
-# @param test_url
-#   The URL to use for testing if the PuppetDB instance is running. Defaults to
-#   `/pdb/meta/v1/version`.
-#
 # @param manage_package_repo
 #   If `true`, the official postgresql.org repo will be added and postgres won't
 #   be installed from the regular repository. Defaults to `true`.
@@ -32,6 +37,34 @@
 #   If the postgresql.org repo is installed, you can install several versions of
 #   postgres. Defaults to `11` with PuppetDB version 7.0.0 or newer, and `9.6` in older versions.
 #
+# @param postgresql_ssl_on
+#   If `true`, it configures SSL connections between PuppetDB and the PostgreSQL database.
+#   Defaults to `false`.
+#
+# @param postgresql_ssl_cert_path
+#   Path to the Postgresql SSL certificate.
+#
+# @param postgresql_ssl_key_path
+#   Path to the Postgresql SSL key.
+#
+# @param postgresql_ssl_ca_cert_path
+#   Path to the Postgresql SSL CA.
+#
+# @param read_database_username
+#   The name of the read database user to connect as. Defaults to `puppetdb-read`. This
+#   option is supported in PuppetDB >= 1.6.
+#
+# @param read_database_password
+#   The password for the read database user. Defaults to `puppetdb-read`. This option is
+#   supported in PuppetDB >= 1.6.
+#
+# @param read_database_host
+#   *This parameter must be set to use another PuppetDB instance for queries.*
+#
+#   The hostname or IP address of the read database server. If set to `undef`, and
+#   `manage_database` is set to `true`, it will use the value of the `database_host`
+#   parameter. This option is supported in PuppetDB >= 1.6.
+#
 class puppetdb::database::postgresql (
   $listen_addresses            = $puppetdb::params::database_host,
   $puppetdb_server             = $puppetdb::params::puppetdb_server,