summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorR.I.Pienaar <rip@devco.net>2010-05-13 19:48:30 +0100
committerR.I.Pienaar <rip@devco.net>2010-05-13 19:48:30 +0100
commitd21209f7c94ab82b839cabc427e2c84c7123f50d (patch)
tree1020c84b0752091e4ae9d39462c0799b5fe9150b
parent166891e2811db4df1f512b92fd662751fb84ed2b (diff)
downloadpuppet-concat-d21209f7c94ab82b839cabc427e2c84c7123f50d.tar.gz
puppet-concat-d21209f7c94ab82b839cabc427e2c84c7123f50d.tar.bz2
Add markdown readme and clear up old info from README
-rw-r--r--README3
-rw-r--r--README.markdown66
2 files changed, 66 insertions, 3 deletions
diff --git a/README b/README
index f69ce92..8dbaf5c 100644
--- a/README
+++ b/README
@@ -60,9 +60,6 @@ KNOWN ISSUES:
to how 0.24.8 does the purging of unhandled files, this is improved
in 0.25.x and we cannot work around it in our code.
-- At present you cannot change the ownership of the file by just setting
- the property on the resources, we have a work around in mind.
-
CHANGELOG:
- 2010/02/19 - initial release
- 2010/03/12 - add support for 0.24.8 and newer
diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..aca7b72
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,66 @@
+What is it?
+===========
+
+A Puppet module that can construct files from fragments.
+
+Please see the comments in the various .pp files for details
+as well as posts on my blog at www.devco.net
+
+Released under the Apache 2.0 licence
+
+Usage:
+======
+
+If you wanted a /etc/motd file that listed all the major modules
+on the machine. And that would be maintained automatically even
+if you just remove the include lines for other modules you could
+use code like below, a sample /etc/motd would be:
+
+<pre>
+Puppet modules on this server:
+
+ -- Apache
+ -- MySQL
+</pre>
+
+
+<pre>
+# class to setup basic motd, include on all nodes
+class motd {
+ concat{"/etc/motd":
+ owner => root,
+ group => root,
+ mode => 644
+ }
+
+ concat::fragment{"motd_header":
+ content => "\nPuppet modules on this server:\n\n",
+ order => 1,
+ }
+}
+
+# used by other modules to register themselves in the motd
+define motd::register($content="", $order=10) {
+ if $content == "" {
+ $body = $name
+ } else {
+ $body = $content
+ }
+
+ concat::fragment{"motd_fragment_$name":
+ target => "/etc/motd",
+ content => " -- $body\n"
+ }
+}
+
+# a sample apache module
+class apache {
+ include apache::install, apache::config, apache::service
+
+ motd::register{"Apache": }
+}
+</pre>
+
+Contact:
+========
+You can contact me on rip@devco.net or follow my blog at www.devco.net I am also on twitter as ripienaar