diff options
Diffstat (limited to 'README.md')
| -rw-r--r--[l---------] | README.md | 45 |
1 files changed, 44 insertions, 1 deletions
diff --git a/README.md b/README.md index fc84f4f..b4a0e3c 120000..100644 --- a/README.md +++ b/README.md @@ -1 +1,44 @@ -DOCUMENTATION.md
\ No newline at end of file +# *puppet-gluster*: a puppet module for GlusterFS + +[](http://travis-ci.org/purpleidea/puppet-gluster) + +## Documentation: +Please see: [DOCUMENTATION.md](DOCUMENTATION.md) or [puppet-gluster-documentation.pdf](puppet-gluster-documentation.pdf). + +## Installation: +Please read the [INSTALL](INSTALL) file for instructions on getting this installed. + +## Examples: +Please look in the [examples/](examples/) folder for usage. If none exist, please contribute one! + +## Module specific notes: +* This is _the_ puppet module for gluster. Accept no imitations! +* All the participating nodes, need to have an identical puppet-gluster config. +* Using gluster::simple is probably the best way to try this out. +* This is easily deployed with vagrant. See the [vagrant/](vagrant/) directory! +* You can use less of the available resources, if you only want to manage some. +* You can get CentOS and RHEL rpms from: +** http://download.gluster.org/pub/gluster/glusterfs/LATEST/CentOS/ or: +** http://repos.fedorapeople.org/repos/kkeithle/glusterfs/epel-6/x86_64/ +* Documentation is now available! Please report grammar and spelling bugs. + +## Dependencies: +* [puppetlabs-stdlib](https://github.com/puppetlabs/puppetlabs-stdlib) (required) +* [puppet-module-data](https://github.com/ripienaar/puppet-module-data/) (optional, puppet >= 3.0.0) +* my [puppet-common](https://github.com/purpleidea/puppet-common) module (optional) +* my [puppet-shorewall](https://github.com/purpleidea/puppet-shorewall) module (optional) +* my [puppet-keepalived](https://github.com/purpleidea/puppet-keepalived) module (optional) +* my [puppet-puppet](https://github.com/purpleidea/puppet-puppet) module (optional) +* my [puppet-yum](https://github.com/purpleidea/puppet-yum) module (optional) +* gluster packages (see above notes) +* pandoc (for building a pdf of the documentation) + +## Patches: +This code may be a work in progress. The interfaces may change without notice. +Patches are welcome, but please be patient. They are best received by email. +Please ping me if you have big changes in mind, before you write a giant patch. + +## + +Happy hacking! + |