summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown52
1 files changed, 40 insertions, 12 deletions
diff --git a/README.markdown b/README.markdown
index a15338f..68186c2 100644
--- a/README.markdown
+++ b/README.markdown
@@ -1,23 +1,51 @@
-## puppetlabs-functions module
+# Puppet Labs Standard Library #
-### Overview
+This module provides a "standard library" of resources for developing Puppet
+Modules. This modules will include the following additions to Puppet
-This is the puppet-functions module. Here we are providing a library of various functions that extend the basic function library that is provided in Puppet.
+ * Stages
+ * Facts
+ * Functions
+ * Defined resource types
+ * Types
+ * Providers
-### Disclaimer
+This module is officially curated and provided by Puppet Labs. The modules
+Puppet Labs writes and distributes will make heavy use of this standard
+library.
-Warning! While this software is written in the best interest of quality it has not been formally tested by our QA teams. Use at your own risk, but feel free to enjoy and perhaps improve it while you do.
+# Compatibility #
-Please see the included Apache Software License for more legal details regarding warranty.
+This module is designed to work with Puppet version 2.6 and later. It may be
+forked if Puppet 2.7 specific features are added. There are currently no plans
+for a Puppet 0.25 standard library module.
-### Installation
+# Functions #
-From github, download the module into your modulepath on your Puppetmaster. If you are not sure where your module path is try this command:
+ Please see `puppet doc -r function` for documentation on each function. The
+ current list of functions is:
- puppet --configprint modulepath
+ * getvar
+ * has\_key
+ * loadyaml
+ * merge.rb
+ * validate\_array
+ * validate\_bool
+ * validate\_hash
+ * validate\_re
+ * validate\_string
-Depending on the version of Puppet, you may need to restart the puppetmasterd (or Apache) process before the functions will work.
+## validate\_hash ##
-## Functions
+ $somehash = { 'one' => 'two' }
+ validate\_hash($somehash)
-TODO
+## getvar() ##
+
+This function aims to look up variables in user-defined namespaces within
+puppet. Note, if the namespace is a class, it should already be evaluated
+before the function is used.
+
+ $namespace = 'site::data'
+ include "${namespace}"
+ $myvar = getvar("${namespace}::myvar")