Merge pull request #212 from tampakrap/documentation

Improve documentation

Author: danieldreier

manifests/agent.pp

@@ -4,24 +4,70 @@
 #
 # == Parameters
 #
+# [*ensure*]
+# The package ensure value.
+# Default: present
+#
 # [*server*]
-#   The puppet server to use for fetching catalogs. Required.
+# The puppet server to use for fetching catalogs.
+# Default: puppet
+#
 # [*ca_server*]
-#   The puppet server to use for certificate requests and similar actions.
-#   Default: puppet::agent::server
+# The puppet server to use for certificate requests and similar actions.
+# Default: puppet::agent::server
+#
+# [*report*]
+# The report variable in puppet.conf, whether to send reports or not
+# Default: true
+#
 # [*report_server*]
-#   The puppet server to send reports.
-#   Default: puppet::agent::server
+# The puppet server to send reports.
+# Default: puppet::agent::server
+#
 # [*manage_repos*]
-#   Whether to manage Puppet Labs APT or YUM package repos.
-#   Default: true
-# [*method*]
-#   The mechanism for performing puppet runs.
-#   Supported methods: [cron, service]
-#   Default: cron
+# Whether to manage Puppet Labs APT or YUM package repos.
+# Default: false
+#
 # [*environment*]
-#   What environment the agent should be part of.
-#   Default: $::environment
+# What environment the agent should be part of.
+# Default: $::environment
+#
+# [*pluginsync*]
+# The pluginsync variable in puppet.conf
+# Default: true
+#
+# [*certname*]
+# The certname variable in puppet.conf
+# Default: $::clientcert
+#
+# [*show_diff*]
+# The show_diff variable in puppet.conf
+# Default: false
+#
+# [*splay*]
+# The splay variable in puppet.conf
+# Default: false
+#
+# [*configtimeout*]
+# The configtimeout variable in puppet.conf
+# Default: 360
+#
+# [*usecacheonfailure*]
+# The usecacheonfailure variable in puppet.conf
+# Default: true
+#
+# [*method*]
+# The mechanism for performing puppet runs.
+# Supported methods: [cron, service, only_service, none]
+# Default: platform dependent
+#
+# [*manage_package*]
+# Whether to manage the puppet agent package or not
+# Default: true
+#
+# [*package*]
+# The puppet agent package name
+# Default: platform dependent
 #
 # == Example:
 #

manifests/agent/cron.pp

@@ -1,3 +1,4 @@
+# Private class
 class puppet::agent::cron (
   $enable   = true,
   $run_noop = false,

manifests/agent/service.pp

@@ -1,7 +1,4 @@
-# Class: puppet::agent::service
-#
-# Manages enabling and disabling the Puppet agent service
-#
+# Private class
 class puppet::agent::service (
   $enable = true
 ) {

manifests/config.pp

@@ -1,3 +1,4 @@
+# Private class
 class puppet::config {
 
   include puppet::agent

manifests/init.pp

@@ -2,10 +2,53 @@
 #
 # == Description
 #
-# This manifest provides for shared behavior and resources between the agent
-# and master.
+# Sets up the /etc/puppet ownership and various puppet.conf variables under the
+# [main] section
 #
-# This module should not be directly included.
+# This class should not be directly included. Its parameters should be defined
+# in hieradata.
+#
+# == Parameters
+#
+# [*logdir*]
+# The logdir variable in puppet.conf.
+# Default: platform dependent
+#
+# [*vardir*]
+# The vardir variable in puppet.conf.
+# Default: platform dependent
+#
+# [*ssldir*]
+# The ssldir variable in puppet.conf.
+# Default: platform dependent
+#
+# [*rundir*]
+# The rundir variable in puppet.conf.
+# Default: platform dependent
+#
+# [*confdir*]
+# The confdir variable in puppet.conf.
+# Default: platform dependent
+#
+# [*user*]
+# The owner of /etc/puppet directory
+# Default: platform dependent
+#
+# [*group*]
+# The group of /etc/puppet directory
+# Default: platform dependent
+#
+# [*conf*]
+# The path of the puppet.conf file
+# Default: platform dependent
+#
+# [*use_srv_records*]
+# The use_srv_records variable in puppet.conf.
+# Default: false
+#
+# [*srv_domain*]
+# The srv_domain variable in puppet.conf.
+# Default: $::domain
 #
 class puppet (
   $logdir          = $puppet::params::puppet_logdir,

manifests/package.pp

@@ -1,3 +1,4 @@
+# Private class
 class puppet::package {
 
   if $puppet::agent::manage_repos {

manifests/package/gentoo.pp

@@ -1,3 +1,16 @@
+# == Class: puppet::package::gentoo
+#
+# Additional configuration needed for Gentoo. This class is private. Its
+# parameters should be set in hieradata
+#
+# == Parameters
+#
+# [*keywords*]
+# ACCEPT_KEYWORDS for the puppet package
+#
+# [*use*]
+# USE flags for the puppet package
+#
 class puppet::package::gentoo (
   $keywords,
   $use,

manifests/package/repository.pp

@@ -5,12 +5,13 @@
 # == Parameters
 #
 # [*devel*]
-#   Include development repositories for bleeding edge releases.
-#   Default: false
+# Include development repositories for bleeding edge releases.
+# Default: false
 #
 # == Requirements
 #
 # If used on apt based distributions, this requires the puppetlabs/apt module.
+# If used on yum based distributions, this requires the puppetlabs/yum module.
 #
 class puppet::package::repository($devel = false) {
 

manifests/server.pp

@@ -9,9 +9,113 @@
 #
 # ==  Parameters
 #
-# * modulepath
-# * storeconfigs
-# * servertype
+# [*autosign*]
+# The autosign variable in puppet.conf
+# Default: undef
+#
+# [*bindaddress*]
+# The bindaddress variable in puppet.conf
+# Default: 0.0.0.0
+#
+# [*ca*]
+# The ca variable in puppet.conf
+# Default: false
+#
+# [*config_version*]
+# The config_version variable in puppet.conf
+# Default: /usr/bin/git --git-dir $confdir/environments/$environment/.git rev-parse --short HEAD 2>/dev/null || echo
+#
+# [*dns_alt_names*]
+# The dns_alt_names variable in puppet.conf
+# Default: undef
+#
+# [*enc*]
+# ??
+# Default: empty string
+#
+# [*enc_exec*]
+# ??
+# Default: empty string
+#
+# [*ensure*]
+# The ensure value for the puppet master package
+# Default: present
+#
+# [*directoryenvs*]
+# Whether we should be using directory environments
+# Default: true
+#
+# [*environmentpath*]
+# The environmentpath variable in puppet.conf
+# Default: undef
+#
+# [*basemodulepath*]
+# The basemodulepath variable in puppet.conf
+# Default: empty list
+#
+# [*default_manifest*]
+# The default_manifest variable in puppet.conf
+# Default: undef
+#
+# [*manage_package*]
+# Whether to manage the puppet master package
+# Default: true
+#
+# [*manifest*]
+# The manifest variable in puppet.conf
+# Default: $confdir/modules/site/site.pp
+#
+# [*modulepath*]
+# The modulepath variable in puppet.conf
+# Default: empty list
+#
+# [*parser*]
+# ??
+# Default: undef
+#
+# [*manage_puppetdb*]
+# Whether to manage puppetdb through puppetlabs/puppetdb module
+# Default: false
+#
+# [*report_dir*]
+# The report_dir variable in puppet.conf
+# Default: platform dependent
+#
+# [*reportfrom*]
+# The reportfrom variable in puppet.conf
+# Default: undef
+#
+# [*reports*]
+# The reports variable from puppet.conf
+# Default: ['store', 'https']
+#
+# [*reporturl*]
+# The reporturl variable in puppet.conf
+# Default: https://${::fqdn}/reports
+#
+# [*servername*]
+# The Puppet Master's name, used for the web servers that serve puppetmaster
+# Default: $::fqdn
+#
+# [*serverssl_ciphers*]
+# SSL ciphers to enable on the web servers that serve puppetmaster
+# Default: application dependent
+#
+# [*serverssl_protos*]
+# SSL protocols to enable on the web servers that serve puppetmaster
+# Default: application dependent
+#
+# [*servertype*]
+# The web server to choose for serving the puppetmaster
+# Default: unicorn
+#
+# [*storeconfigs*]
+# The storeconfigs backend
+# Default: undef
+#
+# [*package*]
+# The puppetmaster package name
+# Default: platform dependent
 #
 # == Example
 # Sample Usage:

manifests/server/config.pp

@@ -1,3 +1,4 @@
+# Private class
 class puppet::server::config {
 
   include puppet