move class database::postgresql parameter reference to pp

Author: h0tw1r3

README.md

@@ -393,46 +393,6 @@ creating and managing the PuppetDB database and database user accounts.
       listen_addresses => 'my.postgres.host.name',
     }
 
-#### `listen_addresses`
-
-The `listen_address` is a comma-separated list of hostnames or IP addresses on
-which the postgres server should listen for incoming connections. This defaults
-to `localhost`. This parameter maps directly to PostgreSQL's `listen_addresses`
-config option. Use a `*` to allow connections on any accessible address.
-
-#### `database_name`
-
-Sets the name of the database. Defaults to `puppetdb`.
-
-#### `database_username`
-
-Creates a user for access the database. Defaults to `puppetdb`.
-
-#### `database_password`
-
-Sets the password for the database user above. Defaults to `puppetdb`.
-
-#### `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.
-
-#### `test_url`
-
-The URL to use for testing if the PuppetDB instance is running. Defaults to
-`/pdb/meta/v1/version`.
-
-#### `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`.
-
-#### `postgres_version`
-
-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.
-
 Implementation
 ---------------
 

REFERENCE.md

@@ -953,15 +953,16 @@ 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)
@@ -974,81 +975,93 @@ The following parameters are available in the `puppetdb::database::postgresql` c
 
 Data type: `Any`
 
-
+The `listen_address` is a comma-separated list of hostnames or IP addresses on
+which the postgres server should listen for incoming connections. This defaults
+to `localhost`. This parameter maps directly to PostgreSQL's `listen_addresses`
+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`
-
-
-
-Default value: `$puppetdb::params::puppetdb_server`
-
 ##### <a name="-puppetdb--database--postgresql--database_name"></a>`database_name`
 
 Data type: `Any`
 
-
+Sets the name of the database. Defaults to `puppetdb`.
 
 Default value: `$puppetdb::params::database_name`
 
 ##### <a name="-puppetdb--database--postgresql--database_username"></a>`database_username`
 
 Data type: `Any`
 
-
+Creates a user for access the database. Defaults to `puppetdb`.
 
 Default value: `$puppetdb::params::database_username`
 
 ##### <a name="-puppetdb--database--postgresql--database_password"></a>`database_password`
 
 Data type: `Any`
 
-
+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`
+##### <a name="-puppetdb--database--postgresql--manage_server"></a>`manage_server`
 
 Data type: `Any`
 
+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.
 
+Default value: `$puppetdb::params::manage_dbserver`
 
-Default value: `$puppetdb::params::database_port`
+##### <a name="-puppetdb--database--postgresql--test_url"></a>`test_url`
 
-##### <a name="-puppetdb--database--postgresql--manage_database"></a>`manage_database`
+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`
 
+If `true`, the official postgresql.org repo will be added and postgres won't
+be installed from the regular repository. Defaults to `true`.
 
+Default value: `$puppetdb::params::manage_pg_repo`
 
-Default value: `$puppetdb::params::manage_database`
+##### <a name="-puppetdb--database--postgresql--postgres_version"></a>`postgres_version`
 
-##### <a name="-puppetdb--database--postgresql--manage_server"></a>`manage_server`
+Data type: `Any`
+
+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.
+
+Default value: `$puppetdb::params::postgres_version`
+
+##### <a name="-puppetdb--database--postgresql--puppetdb_server"></a>`puppetdb_server`
 
 Data type: `Any`
 
 
 
-Default value: `$puppetdb::params::manage_dbserver`
+Default value: `$puppetdb::params::puppetdb_server`
 
-##### <a name="-puppetdb--database--postgresql--manage_package_repo"></a>`manage_package_repo`
+##### <a name="-puppetdb--database--postgresql--database_port"></a>`database_port`
 
 Data type: `Any`
 
 
 
-Default value: `$puppetdb::params::manage_pg_repo`
+Default value: `$puppetdb::params::database_port`
 
-##### <a name="-puppetdb--database--postgresql--postgres_version"></a>`postgres_version`
+##### <a name="-puppetdb--database--postgresql--manage_database"></a>`manage_database`
 
 Data type: `Any`
 
 
 
-Default value: `$puppetdb::params::postgres_version`
+Default value: `$puppetdb::params::manage_database`
 
 ##### <a name="-puppetdb--database--postgresql--postgresql_ssl_on"></a>`postgresql_ssl_on`
 

manifests/database/postgresql.pp

@@ -1,5 +1,37 @@
 # create the PuppetDB postgresql database
 #
+# @param listen_addresses
+#   The `listen_address` is a comma-separated list of hostnames or IP addresses on
+#   which the postgres server should listen for incoming connections. This defaults
+#   to `localhost`. This parameter maps directly to PostgreSQL's `listen_addresses`
+#   config option. Use a `*` to allow connections on any accessible address.
+#
+# @param database_name
+#   Sets the name of the database. Defaults to `puppetdb`.
+#
+# @param database_username
+#   Creates a user for access the database. Defaults to `puppetdb`.
+#
+# @param database_password
+#   Sets the password for the database user above. Defaults to `puppetdb`.
+#
+# @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`.
+#
+# @param postgres_version
+#   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.
+#
 class puppetdb::database::postgresql (
   $listen_addresses            = $puppetdb::params::database_host,
   $puppetdb_server             = $puppetdb::params::puppetdb_server,