From 2ab024ab14bdf831233d727f55d0a3cc0cf5e5b3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rapha=C3=ABl=20Pinson?= Date: Tue, 9 Dec 2014 15:37:21 +0100 Subject: Improve metadata.json --- README.markdown | 91 --------------------------------------------------------- README.md | 73 +++++++++++++++++++++++++++++++++++++++++++++ metadata.json | 55 ++++++++++++++++++++++++++++++++-- 3 files changed, 126 insertions(+), 93 deletions(-) delete mode 100644 README.markdown create mode 100644 README.md diff --git a/README.markdown b/README.markdown deleted file mode 100644 index a25cb40..0000000 --- a/README.markdown +++ /dev/null @@ -1,91 +0,0 @@ -# Augeas Puppet module - -[![Puppet Forge](http://img.shields.io/puppetforge/v/camptocamp/augeas.svg)](https://forge.puppetlabs.com/camptocamp/augeas) -[![Build Status](https://travis-ci.org/camptocamp/puppet-augeas.png?branch=master)](https://travis-ci.org/camptocamp/puppet-augeas) - -**Install and configure Augeas.** - -This module is provided by [Camptocamp](http://www.camptocamp.com/) - -## Usage - -Simple usage: - - include augeas - -### Classes - -The module provides an `augeas` class which installs and configures Augeas. - - -* lets you force the augeas version by defining `$augeas_version`, otherwise puppet will - only ensure the packages are present; -* lets you force the ruby library version by defining `$augeas_ruby_version`, otherwise puppet will - only ensure the libaugeas-ruby version will be installed according to internal critera; -* provides an `augeas()` master-side function to manipulate strings using Augeas; - -### Definitions - -#### `augeas::lens` - -The `augeas::lens` definition allows you to 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', - } - -### Functions - -#### `augeas()` - -Modifies a string using Augeas. - -*Example:* - - augeas("proc /proc proc nodev,noexec,nosuid 0 0\n", 'Fstab.lns', ['rm ./1/opt[3]']) - -Would result in: - - "proc /proc proc nodev,noexec 0 0\n" - - -- *Type*: rvalue - -## Contributing - -Please report bugs and feature request using [GitHub issue -tracker](https://github.com/camptocamp/puppet-augeas/issues). - -For pull requests, it is very much appreciated to check your Puppet manifest -with [puppet-lint](https://github.com/camptocamp/puppet-augeas/issues) to follow the recommended Puppet style guidelines from the -[Puppet Labs style guide](http://docs.puppetlabs.com/guides/style_guide.html). - -## License - -Copyright (c) 2013 All rights reserved. - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - diff --git a/README.md b/README.md new file mode 100644 index 0000000..4a7bed1 --- /dev/null +++ b/README.md @@ -0,0 +1,73 @@ +# Augeas Puppet module + +[![Puppet Forge](http://img.shields.io/puppetforge/v/camptocamp/augeas.svg)](https://forge.puppetlabs.com/camptocamp/augeas) +[![Build Status](https://travis-ci.org/camptocamp/puppet-augeas.png?branch=master)](https://travis-ci.org/camptocamp/puppet-augeas) + +**Install and configure Augeas.** + +This module is provided by [Camptocamp](http://www.camptocamp.com/) + +## Usage + +Simple usage: + + include augeas + +### Classes + +The module provides an `augeas` class which installs and configures Augeas. + + +* lets you force the augeas version by defining `$augeas_version`, otherwise puppet will + only ensure the packages are present; +* lets you force the ruby library version by defining `$augeas_ruby_version`, otherwise puppet will + only ensure the libaugeas-ruby version will be installed according to internal critera; +* provides an `augeas()` master-side function to manipulate strings using Augeas; + +### Definitions + +#### `augeas::lens` + +The `augeas::lens` definition allows you to 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', + } + +### Functions + +#### `augeas()` + +Modifies a string using Augeas. + +*Example:* + + augeas("proc /proc proc nodev,noexec,nosuid 0 0\n", 'Fstab.lns', ['rm ./1/opt[3]']) + +Would result in: + + "proc /proc proc nodev,noexec 0 0\n" + + +- *Type*: rvalue + +## Contributing + +Please report bugs and feature request using [GitHub issue +tracker](https://github.com/camptocamp/puppet-augeas/issues). + +For pull requests, it is very much appreciated to check your Puppet manifest +with [puppet-lint](https://github.com/camptocamp/puppet-augeas/issues) to follow the recommended Puppet style guidelines from the +[Puppet Labs style guide](http://docs.puppetlabs.com/guides/style_guide.html). diff --git a/metadata.json b/metadata.json index 190d22b..6116923 100644 --- a/metadata.json +++ b/metadata.json @@ -3,12 +3,63 @@ "version": "1.0.3", "author": "camptocamp", "summary": "Camptocamp Augeas module", - "license": "GNU GPLv3", + "license": "Apache-2.0", "source": "https://github.com/camptocamp/puppet-augeas", "project_page": "https://github.com/camptocamp/puppet-augeas", "issues_url": "https://github.com/camptocamp/puppet-augeas/issues", "description": "Augeas Module for Puppet", "dependencies": [ - {"name":"puppetlabs/stdlib","version_requirement":">= 3.2.0"} + { + "name":"puppetlabs/stdlib", + "version_requirement":">= 3.2.0 <5.0.0" + } + ], + "requirements": [ + { + "name": "pe", + "version_requirement": "3.x" + }, + { + "name": "puppet", + "version_requirement": "3.x" + } + ], + "operatingsystem_support": [ + { + "operatingsystem": "Debian", + "operatingsystemrelease": [ + "6", + "7" + ] + }, + { + "operatingsystem": "Ubuntu", + "operatingsystemrelease": [ + "10.04", + "12.04", + "14.04" + ] + }, + { + "operatingsystem": "RedHat", + "operatingsystemrelease": [ + "5", + "6" + ] + }, + { + "operatingsystem": "SLES" + } + ], + "puppet_version": [ + "2.7", + "3.0", + "3.1", + "3.2", + "3.3", + "3.4", + "3.5", + "3.6", + "3.7" ] } -- cgit v1.2.3