From 3174a2d0f8e453067a64428bad8af92fe98c53f1 Mon Sep 17 00:00:00 2001 From: Micah Anderson Date: Wed, 20 Feb 2013 11:14:11 -0500 Subject: Update README --- README | 23 ++++++++++++++++++++--- 1 file 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', + } + -- cgit v1.2.3