Add markdown readme and clear up old info from README

This commit is contained in:
R.I.Pienaar 2010-05-13 19:48:30 +01:00
parent 166891e281
commit d21209f7c9
2 changed files with 66 additions and 3 deletions

3
README
View file

@ -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

66
README.markdown Normal file
View file

@ -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