summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMicah Anderson <micah@riseup.net>2013-02-20 11:14:11 -0500
committerMicah Anderson <micah@riseup.net>2013-02-20 11:14:11 -0500
commit3174a2d0f8e453067a64428bad8af92fe98c53f1 (patch)
tree3e045509135ac4b2e3f4b73f8c2338a90b569de9
parent4d8c8ba362cc57c12451e581f27feea97797e8c0 (diff)
Update README
-rw-r--r--README23
1 files changed, 20 insertions, 3 deletions
diff --git a/README b/README
index 84d77c6..8de2801 100644
--- a/README
+++ b/README
@@ -7,8 +7,25 @@
== Description ==
This module does 3 things:
-
- o provides a few lenses only included in recent augeas releases.
- o let's you force the version by defining $augeas_version, else puppet will
+ o lets you force the augeas version by defining $augeas_version, otherwise puppet will
only ensure the packages are present.
+ o lets you force the ruby library version by defining $augeas_ruby_version, otherwise puppet will
+ only ensure the libagueas-ruby version will be installed according to internal critera
+ o lets you deploy an augeas lens and any associated test files, running unit tests and not installing if they fail:
+
+ Parameters:
+ - *ensure*: present/absent
+ - *lens_source*: the source for the lens
+ - *test_source*: optionally, the source for the test file.
+ - *stock_since*: optionally, indicate in which version of Augeas
+ the lens became stock, so it will not be deployed above that version.
+
+ Example usage:
+
+ augeas::lens { 'networkmanager':
+ lens_source => 'puppet:///modules/networkmanager/lenses/networkmanager.aug',
+ test_source => 'puppet:///modules/networkmanager/lenses/test_networkmanager.aug',
+ stock_since => '1.0.0',
+ }
+