From: Dan Carley <dan.carley@gmail.com>
Date: Sun, 16 Jun 2013 19:51:43 +0000 (+0100)
Subject: [#213] Improve manifest documentation
X-Git-Tag: list~6^2~1
X-Git-Url: https://review.fuel-infra.org/gitweb?a=commitdiff_plain;h=48f534c880b7ba6a9556973fe8ea08b3e1826c37;p=puppet-modules%2Fpuppetlabs-firewall.git

[#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 a1a65c6..759f328 100644
--- 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 184d9e9..feaf0e6 100644
--- 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 317cdb5..546a5a8 100644
--- 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 bbf666a..2a0f7e5 100644
--- 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 bb91757..c3d0628 100644
--- 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