]> review.fuel-infra Code Review - puppet-modules/puppetlabs-firewall.git/commitdiff
Added some more examples and README cleanup.
authorKen Barber <ken@bob.sh>
Wed, 15 Jun 2011 15:28:52 +0000 (17:28 +0200)
committerKen Barber <ken@bob.sh>
Wed, 15 Jun 2011 15:28:52 +0000 (17:28 +0200)
README.markdown

index 856923f9063bbda31fc1ee18eab8826ece2cfe8f..a358bcc1debd0ea4eeea0ab9108984a6410d4f64 100644 (file)
@@ -14,6 +14,25 @@ Please see the included Apache Software License for more legal details regarding
 
 From github, download the module into your modulepath on your Puppetmaster. If you are not sure where your module path is try this command:
 
-  puppet --configprint modulepath
+    puppet --configprint modulepath
 
 Depending on the version of Puppet, you may need to restart the puppetmasterd (or Apache) process before this module will work.
+
+### Quickstart
+
+Once the module is in the correct modulepath, you should be able to create some
+firewall rules like the below examples. Remember, that rules are lexically 
+ordered by the resource title at this point.
+
+Basic accept ICMP request example:
+
+    firewall { "000 accept all icmp requests":
+      proto => "icmp",
+      jump => "ACCEPT",
+    }
+
+Deny all:
+
+    firewall { "999 deny all other requests":
+      jump => "DENY",
+    }