summaryrefslogtreecommitdiffstats
path: root/DOCUMENTATION.md
diff options
context:
space:
mode:
authorJames Shubin <james@shubin.ca>2014-10-27 21:10:14 -0400
committerJames Shubin <james@shubin.ca>2014-10-27 21:10:14 -0400
commit9c7190bffb6c6455dfe3751b6fac055ce59ca962 (patch)
treeb52816be9d5a65852be98cb292ae891f304ec5c2 /DOCUMENTATION.md
parent8f848765e00f8fac93fa8c48ef4d499b506125c0 (diff)
downloadpuppet-gluster-9c7190bffb6c6455dfe3751b6fac055ce59ca962.tar.gz
puppet-gluster-9c7190bffb6c6455dfe3751b6fac055ce59ca962.tar.xz
puppet-gluster-9c7190bffb6c6455dfe3751b6fac055ce59ca962.zip
Add a section about hiera data in modules to the documentation.
Diffstat (limited to 'DOCUMENTATION.md')
-rw-r--r--DOCUMENTATION.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
index 2d359b1..8e9ff24 100644
--- a/DOCUMENTATION.md
+++ b/DOCUMENTATION.md
@@ -506,6 +506,18 @@ things are found. The multi-distro support has been designed to make it
particularly easy to add support for additional platforms. If your platform
doesn't work, please submit a yaml data file with the platform specific values.
+###How do I get the OS independent aspects of this module to work?
+The OS independent aspects of this module use the hiera "data-in-modules"
+technique. It is actually very simple to get this to work. For a longer write
+up of this technique, please read:
+[https://ttboj.wordpress.com/2014/06/04/hiera-data-in-modules-and-os-independent-puppet/](https://ttboj.wordpress.com/2014/06/04/hiera-data-in-modules-and-os-independent-puppet/)
+
+In short, this requires puppet version 3.0.0 or greater, and needs the
+[module_data](https://github.com/ripienaar/puppet-module-data)
+puppet module to be present on the puppet server in the _modules/_ directory.
+The *module_data* code should be in a module folder named: *module_data/*.
+That's it!
+
###Awesome work, but it's missing support for a feature and/or platform!
Since this is an Open Source / Free Software project that I also give away for