summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorJames Shubin <james@shubin.ca>2013-06-03 19:54:43 -0400
committerJames Shubin <james@shubin.ca>2013-06-03 19:54:43 -0400
commit2a65757ead328e87e2ae656d39040d5c96bc2f0d (patch)
treedc03e044baa50959d1ae3df1285d9fa6b5f50a69 /README
parent9aae259df87ab22b47185d9ff61d1d0020f33d2a (diff)
downloadpuppet-gluster-2a65757ead328e87e2ae656d39040d5c96bc2f0d.tar.gz
puppet-gluster-2a65757ead328e87e2ae656d39040d5c96bc2f0d.tar.xz
puppet-gluster-2a65757ead328e87e2ae656d39040d5c96bc2f0d.zip
Cleanup some small things.
Diffstat (limited to 'README')
-rw-r--r--README26
1 files changed, 18 insertions, 8 deletions
diff --git a/README b/README
index c08b9de..03355e6 100644
--- a/README
+++ b/README
@@ -1,13 +1,23 @@
-puppet-gluster, by James Shubin <james@shubin.ca>, https://ttboj.wordpress.com/
+This is puppet-gluster a puppet module for gluster.
-WARNING: This module is in development phase, and things might change drastically. You've been warned. Sorry about any ugliness that is present at the moment.
+Please read the INSTALL file for instructions on getting this installed.
+Look in the examples/ folder for usage. If none exist, please contribute one!
+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.
-DEPENDENCIES: This module (optionally) depends on my unreleased puppet-shorewall module.
+Module specific notes:
+* All the participating nodes, need to have an identical puppet-gluster config.
+* There is an experimental gluster::wrapper class, for easier deployment.
+* You can use less of the available resources, if you only want to manage some.
-PATCHES/DISCUSSION: Initially both welcome by email, although I'd prefer you give me a heads up first so that we're working in the same direction.
+Dependencies:
+* puppetlabs-stdlib (required)
+* my puppet-common module (optional)
+* my puppet-shorewall module (optional)
+* my puppet-puppet module (optional)
-USAGE:
-Put these two folders in your $PUPPET_MODULE_DIR/gluster/
-Configure your nodes... (All server nodes should have identical puppet config)
-Profit!!!
+
+Happy hacking,
+James Shubin <james@shubin.ca>, https://ttboj.wordpress.com/