[#213] Improve manifest documentation

Bad me. I should have written these the first time round.

diff --git a/manifests/init.pp b/manifests/init.pp
index a1a65c6822f406267bbe7bb6d2e6b22880c81644..759f3282351a4fa66b7db48e23b1d30b8b78cb55 100644 (file)
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -1,7 +1,15 @@
-# Class: firewall
+# = Class: firewall
 #
-# Manages the installation of packages for operating systems that are
-# currently supported by the firewall type.
+# Manages packages and services required by the firewall type/provider.
+#
+# This class includes the appropriate sub-class for your operating system,
+# where supported.
+#
+# == Parameters:
+#
+# [*ensure*]
+#   Ensure parameter passed onto Service[] resources.
+#   Default: running
 #
 class firewall (
   $ensure = running

diff --git a/manifests/linux.pp b/manifests/linux.pp
index 184d9e995b77308b252138916b5c7691e3b9747e..feaf0e66f329dd008b3341d27da152bf2013c375 100644 (file)
--- a/manifests/linux.pp
+++ b/manifests/linux.pp
@@ -1,5 +1,16 @@
+# = Class: firewall::linux
+#
+# Installs the `iptables` package for Linux operating systems and includes
+# the appropriate sub-class for any distribution specific services and
+# additional packages.
+#
+# == Parameters:
+#
+# [*ensure*]
+#   Ensure parameter passed onto Service[] resources. When `running` the
+#   service will be started on boot, and when `stopped` it will not.
+#   Default: running
 #
-#This class includes the proper sub-class for the distro being run
 class firewall::linux (
   $ensure = running
 ) {

diff --git a/manifests/linux/archlinux.pp b/manifests/linux/archlinux.pp
index 317cdb5044a21d6e684924c4ce6246c2c1ee02b4..546a5a80fe2fc6c09d3e0623c27d39cd60f1a797 100644 (file)
--- a/manifests/linux/archlinux.pp
+++ b/manifests/linux/archlinux.pp
@@ -1,5 +1,18 @@
+# = Class: firewall::linux::archlinux
+#
+# Manages `iptables` and `ip6tables` services, and creates files used for
+# persistence, on Arch Linux systems.
+#
+# == Parameters:
+#
+# [*ensure*]
+#   Ensure parameter passed onto Service[] resources.
+#   Default: running
+#
+# [*enable*]
+#   Enable parameter passed onto Service[] resources.
+#   Default: true
 #
-#This class manages iptables on archlinux
 class firewall::linux::archlinux (
   $ensure = 'running',
   $enable = true

diff --git a/manifests/linux/debian.pp b/manifests/linux/debian.pp
index bbf666abb2f33780c78bbf11f6d0adffe49eb1ac..2a0f7e588a1627787013c93c41796a24b1fa1a6e 100644 (file)
--- a/manifests/linux/debian.pp
+++ b/manifests/linux/debian.pp
@@ -1,5 +1,18 @@
+# = Class: firewall::linux::debian
+#
+# Installs the `iptables-persistent` package for Debian-alike systems. This
+# allows rules to be stored to file and restored on boot.
+#
+# == Parameters:
+#
+# [*ensure*]
+#   Ensure parameter passed onto Service[] resources.
+#   Default: running
+#
+# [*enable*]
+#   Enable parameter passed onto Service[] resources.
+#   Default: true
 #
-#This class manages iptables on debian
 class firewall::linux::debian (
   $ensure = running,
   $enable = true

diff --git a/manifests/linux/redhat.pp b/manifests/linux/redhat.pp
index bb917575b8760f99568161e23b9079ccbdacbc38..c3d0628ed0d0ecaa3f63328e78fdc39ec0c9eb00 100644 (file)
--- a/manifests/linux/redhat.pp
+++ b/manifests/linux/redhat.pp
@@ -1,5 +1,17 @@
+# = Class: firewall::linux::redhat
+#
+# Manages the `iptables` service on RedHat-alike systems.
+#
+# == Parameters:
+#
+# [*ensure*]
+#   Ensure parameter passed onto Service[] resources.
+#   Default: running
+#
+# [*enable*]
+#   Enable parameter passed onto Service[] resources.
+#   Default: true
 #
-#This class manages iptables on redhat
 class firewall::linux::redhat (
   $ensure = running,
   $enable = true