Puppet Strings

Author: Daniel Carabas

REFERENCE.md

@@ -1,4 +1,18 @@
-# Install client cli tool. See README.md for more details.
+# @summary Install client cli tool. 
+#
+# @param file_ensure
+#   Enum['file','absent'].
+# 
+# @param validcon_script_path
+#   Optional. Absolute path for the postgresql connection validation script.
+#
+# @param package_name
+#   String. Client package name.
+#
+# @param package_ensure
+#   String. Defaults to 'present'.
+#
+#
 class postgresql::client (
   Enum['file', 'absent'] $file_ensure        = 'file',
   Stdlib::Absolutepath $validcon_script_path = $postgresql::params::validcon_script_path,

manifests/client.pp

@@ -1,5 +1,65 @@
-# Class for setting cross-class global overrides. See README.md for more
-# details.
+# @summary Class for setting cross-class global overrides.
+#
+# @param client_package_name      
+# @param server_package_name      
+# @param contrib_package_name     
+# @param devel_package_name       
+# @param java_package_name        
+# @param docs_package_name        
+# @param perl_package_name        
+# @param plperl_package_name      
+# @param plpython_package_name    
+# @param python_package_name      
+# @param postgis_package_name     
+#
+# @param service_name             
+# @param service_provider         
+# @param service_status           
+# @param default_database         
+#
+# @param validcon_script_path     
+#
+# @param initdb_path              
+# @param createdb_path            
+# @param psql_path                
+# @param pg_hba_conf_path         
+# @param pg_ident_conf_path       
+# @param postgresql_conf_path     
+# @param recovery_conf_path       
+# @param default_connect_settings
+#
+# @param pg_hba_conf_defaults     
+#
+# @param datadir                  
+# @param confdir                  
+# @param bindir                   
+# @param xlogdir                  
+# @param logdir                   
+# @param log_line_prefix          
+#
+# @param user                     
+# @param group                    
+#
+# @param version                  
+# @param postgis_version          
+# @param repo_proxy               
+# @param repo_baseurl             
+#
+# @param needs_initdb             
+#
+# @param encoding                 
+# @param locale                   
+# @param data_checksums           
+# @param timezone                 
+#
+# @param manage_pg_hba_conf       
+# @param manage_pg_ident_conf     
+# @param manage_recovery_conf     
+#
+# @param manage_package_repo      
+# @param module_workdir           
+#
+#
 class postgresql::globals (
   $client_package_name      = undef,
   $server_package_name      = undef,

manifests/globals.pp

@@ -1,5 +1,13 @@
-# This class installs postgresql development libraries. See README.md for more
-# details.
+# @summary This class installs postgresql development libraries. 
+#
+# @param package_name
+#   String.
+# @param package_ensure
+#   String. Defaults to 'present'.
+# @param link_pg_config
+#   Boolean. 
+#
+#
 class postgresql::lib::devel(
   String $package_name      = $postgresql::params::devel_package_name,
   String[1] $package_ensure = 'present',

manifests/lib/devel.pp

@@ -1,5 +1,11 @@
-# This class installs the postgresql-docs See README.md for more
-# details.
+# @summary This class installs the postgresql-docs
+#
+# @param package_name
+#   String.
+# @param package_ensure
+#   String. Defaults to 'present'.
+# 
+#
 class postgresql::lib::docs (
   String $package_name      = $postgresql::params::docs_package_name,
   String[1] $package_ensure = 'present',

manifests/lib/docs.pp

@@ -1,5 +1,10 @@
-# This class installs the postgresql jdbc connector. See README.md for more
-# details.
+# @summary This class installs the postgresql jdbc connector.
+#
+# @param package_name
+#  String.
+# @param package_ensure
+#  String. Defaults to 'present'.
+#
 class postgresql::lib::java (
   String $package_name      = $postgresql::params::java_package_name,
   String[1] $package_ensure = 'present'

manifests/lib/java.pp

@@ -1,5 +1,10 @@
-# This class installs the perl libs for postgresql. See README.md for more
-# details.
+# @summary This class installs the perl libs for postgresql.
+#
+# @param package_name
+#   String.
+# @param package_ensure
+#   String. Defaults to 'present'.
+#
 class postgresql::lib::perl(
   String $package_name      = $postgresql::params::perl_package_name,
   String[1] $package_ensure = 'present'

manifests/lib/perl.pp

@@ -1,5 +1,10 @@
-# This class installs the python libs for postgresql. See README.md for more
-# details.
+# @summary This class installs the python libs for postgresql.
+#
+# @param package_name
+#  String.
+# @param package_ensure
+#  String. Defaults to 'present'.
+#
 class postgresql::lib::python(
   String[1] $package_name   = $postgresql::params::python_package_name,
   String[1] $package_ensure = 'present'

manifests/lib/python.pp

@@ -1,4 +1,4 @@
-# PRIVATE CLASS: do not use directly
+# @api private
 class postgresql::params inherits postgresql::globals {
   $version                    = $postgresql::globals::globals_version
   $postgis_version            = $postgresql::globals::globals_postgis_version

manifests/params.pp

@@ -1,4 +1,4 @@
-# PRIVATE CLASS: do not use directly
+# @api private
 class postgresql::repo (
   $version = undef,
   $proxy = undef,

manifests/repo.pp

@@ -1,4 +1,67 @@
-# This installs a PostgreSQL server. See README.md for more details.
+# @summary This installs a PostgreSQL server
+#
+# @param postgres_password
+# @param package_name
+# @param package_ensure
+#
+# @param plperl_package_name
+# @param plpython_package_name
+#
+# @param service_ensure
+# @param service_enable
+# @param service_manage
+# @param service_name
+# @param service_restart_on_change
+# @param service_provider
+# @param service_reload
+# @param service_status
+# @param default_database
+# @param default_connect_settings
+# @param listen_addresses
+# @param port
+# @param ip_mask_deny_postgres_user
+# @param ip_mask_allow_all_users
+# @param ipv4acls
+# @param ipv6acls
+#
+# @param initdb_path
+# @param createdb_path
+# @param psql_path
+# @param pg_hba_conf_path
+# @param pg_ident_conf_path
+# @param postgresql_conf_path
+# @param recovery_conf_path
+#
+# @param datadir
+# @param xlogdir
+# @param logdir
+#
+# @param log_line_prefix
+#
+# @param pg_hba_conf_defaults
+#
+# @param user
+# @param group
+#
+# @param needs_initdb
+#
+# @param encoding
+# @param locale
+# @param data_checksums
+# @param timezone
+#
+# @param manage_pg_hba_conf
+# @param manage_pg_ident_conf
+# @param manage_recovery_conf
+# @param module_workdir
+#
+# @param roles
+# @param config_entries
+# @param pg_hba_rules
+#
+# @param version
+#
+#
 class postgresql::server (
   $postgres_password          = undef,
 

manifests/server.pp

@@ -1,4 +1,4 @@
-# PRIVATE CLASS: do not call directly
+# @api private
 class postgresql::server::config {
   $ip_mask_deny_postgres_user = $postgresql::server::ip_mask_deny_postgres_user
   $ip_mask_allow_all_users    = $postgresql::server::ip_mask_allow_all_users

manifests/server/config.pp

@@ -1,4 +1,10 @@
-# Manage a postgresql.conf entry. See README.md for more details.
+# @summary Manage a postgresql.conf entry.
+#
+# @param ensure
+# @param value
+# @param path
+#   Boolean. Defaults to false.
+#
 define postgresql::server::config_entry (
   $ensure = 'present',
   $value  = undef,

manifests/server/config_entry.pp

@@ -1,4 +1,11 @@
-# Install the contrib postgresql packaging. See README.md for more details.
+# @summary Install the contrib postgresql packaging.
+#
+# @param package_name
+#   String.
+# @param package_ensure
+#   String. Defaults to 'present'.
+# 
+#
 class postgresql::server::contrib (
   String $package_name      = $postgresql::params::contrib_package_name,
   String[1] $package_ensure = 'present'

manifests/server/contrib.pp

@@ -1,4 +1,15 @@
-# Define for creating a database. See README.md for more details.
+# @summary Define for creating a database.
+#
+# @param comment 
+# @param dbname
+# @param owner
+# @param tablespace
+# @param template
+# @param encoding
+# @param locale
+# @param istemplate
+# @param connect_settings
+#
 define postgresql::server::database(
   $comment          = undef,
   $dbname           = $title,

manifests/server/database.pp

@@ -1,4 +1,13 @@
-# Manage a database grant. See README.md for more details.
+# @summary Manage a database grant.
+#
+# @param privilege
+# @param db
+# @param role
+# @param ensure
+# @param psql_db
+# @param psql_user
+# @param connect_settings
+#
 define postgresql::server::database_grant(
   $privilege,
   $db,

manifests/server/database_grant.pp

@@ -1,5 +1,18 @@
-# Define for conveniently creating a role, database and assigning the correct
-# permissions. See README.md for more details.
+# @ summary Define for conveniently creating a role, database and assigning the correctpermissions.
+# 
+# @param user
+# @param password
+# @param comment
+# @param dbname
+# @param encoding
+# @param locale
+# @param grant
+# @param tablespace
+# @param template
+# @param istemplate
+# @param owner 
+#
+#
 define postgresql::server::db (
   $user,
   $password,

manifests/server/db.pp

@@ -1,4 +1,14 @@
-# Activate an extension on a postgresql database
+# @summary Activate an extension on a postgresql database.
+#
+# @param database
+# @param extension
+# @param schema
+# @param version
+# @param ensure
+# @param package_name
+# @param package_ensure
+# @param connect_settings
+#
 define postgresql::server::extension (
   $database,
   $extension                   = $name,

manifests/server/extension.pp

@@ -1,4 +1,17 @@
-# Define for granting permissions to roles. See README.md for more details.
+# @summary Define for granting permissions to roles.
+#
+# @param role
+# @param db
+# @param privilege
+# @param object_type
+# @param object_name
+# @param psql_db
+# @param psql_user
+# @param port
+# @param onlyif_exists
+# @param connect_settings
+# @param ensure
+#
 define postgresql::server::grant (
   String $role,
   String $db,

manifests/server/grant.pp

@@ -1,4 +1,13 @@
-# Define for granting membership to a role. See README.md for more information
+# @summary Define for granting membership to a role.
+#
+# @param group
+# @param role
+# @param ensure
+# @param psql_db
+# @param psql_user
+# @param port
+# @param connect_settings
+#
 define postgresql::server::grant_role (
   String[1] $group,
   String[1] $role                   = $name,

manifests/server/grant_role.pp

@@ -1,4 +1,4 @@
-# PRIVATE CLASS: do not call directly
+# @api private
 class postgresql::server::initdb {
   $needs_initdb   = $postgresql::server::needs_initdb
   $initdb_path    = $postgresql::server::initdb_path

manifests/server/initdb.pp

@@ -1,4 +1,4 @@
-# PRIVATE CLASS: do not call directly
+# @api private
 class postgresql::server::install {
   $package_ensure      = $postgresql::server::package_ensure
   $package_name        = $postgresql::server::package_name

manifests/server/install.pp

@@ -1,4 +1,4 @@
-# PRIVATE CLASS: do not call directly
+# @api private
 class postgresql::server::passwd {
   $postgres_password = $postgresql::server::postgres_password
   $user              = $postgresql::server::user