puppet
/
megacli
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

* Add a README.md file.

This commit is contained in:
gardouille 2015-03-24 11:21:04 +01:00
parent 83e50f18e7
commit a2209440d1
3 changed files with 48 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -8,3 +8,4 @@ Initial release.
##### Changes ##### Changes
* Add a repository (hwraid for Debian). * Add a repository (hwraid for Debian).
* Ensure that Megacli is installed. * Ensure that Megacli is installed.
* Add a README.md file.

97
README.md
View File

@ -3,77 +3,74 @@
#### Table of Contents #### Table of Contents
1. [Overview](#overview) 1. [Overview](#overview)
2. [Module Description - What the module does and why it is useful](#module-description) 2. [Module Description](#module-description)
3. [Setup - The basics of getting started with megacli](#setup) 3. [Setup](#setup)
* [What megacli affects](#what-megacli-affects) * [What megacli affects](#what-megacli-affects)
* [Setup requirements](#setup-requirements) 4. [Usage](#usage)
* [Beginning with megacli](#beginning-with-megacli) 5. [Reference](#reference)
4. [Usage - Configuration options and additional functionality](#usage) * [Classes](#classes)
5. [Reference - An under-the-hood peek at what the module is doing and how](#reference) * [Parameters](#parameters)
5. [Limitations - OS compatibility, etc.](#limitations) 6. [Limitations](#limitations)
6. [Development - Guide for contributing to the module](#development) 7. [Development](#development)
8. [License](#license)
## Overview ## Overview
A one-maybe-two sentence summary of what the module does/what problem it solves. This module just provide a simple way to install Megacli (MegaRaid management).
This is your 30 second elevator pitch for your module. Consider including
OS/Puppet version it works with.
## Module Description ## Module Description
If applicable, this section should have a brief description of the technology Based on a default repository it will be easy to manage Megacli for Debian
the module integrates with and what that integration enables. This section systems. If you want some Redhat/Fedora/Ubuntu support, please send repository
should answer the questions: "What does this module *do*?" and "Why would I use URL :)
it?"
If your module has a range of functionality (installation, configuration,
management, etc.) this is the time to mention it.
## Setup ## Setup
### What megacli affects ### What megacli affects
* A list of files, packages, services, or operations that the module will alter, * A new `sources.list` file for Megacli.
impact, or execute on the system it's installed on. * Package for Megacli.
* This is a great place to stick any warnings.
* Can be in list or paragraph form.
### Setup Requirements **OPTIONAL**
If your module requires anything extra before setting up (pluginsync enabled,
etc.), mention it here.
### Beginning with megacli
The very basic steps needed for a user to get the module up and running.
If your most recent release breaks compatibility or requires particular steps
for upgrading, you may wish to include an additional section here: Upgrading
(For an example, see http://forge.puppetlabs.com/puppetlabs/firewall).
## Usage ## Usage
Put the classes, types, and resources for customizing, configuring, and doing To begin using Megacli module with defaults parameters:
the fancy stuff with your module here. ```
include megacli
```
## Reference ## Reference
Here, list the classes, types, providers, facts, etc contained in your module. ### Classes
This section should include all of the under-the-hood workings of your module so
people know what the module is touching on their system but don't need to mess
with things. (We are working on automating this section!)
## Limitations * `megacli`: Main class call all subclasses.
* `megacli::repo`: Manage the repository to provide Megacli.
* `megacli::install`: Install Megacli packages.
This is where you list OS compatibility, version compatibility, etc. ### Parameters
## Development #### megacli
* `repo_ensure`: What to set the repository to. Can be 'present' or 'absent'. Defaults to 'present'.
* `repo_url`: The URL of the repository. Default to 'http://hwraid.le-vert.net/debian/' for Debian systems.
* `repo_key`: The key to ensure the repository is trusted. Defaults to '23B3D3B4' for Debian systems.
* `repo_key_server`: The server used to validate the repository's key. Defaults to 'keyserver.ubuntu.com' for Debian systems.
* `repo_include_src`: If set to 'true', it will include the source packages. Can be 'true' or 'false'. Defaults to 'false'.
* `repos`: Which sections to use for the repository. Can be an array. Defaults to 'main' for Debian systems.
* `pkg_ensure`: What to set the Megacli package to. Can be 'present' or 'absent'. Defaults to 'present'.
* `pkg_name`: The Megacli's package name to install. Defaults to 'megacli'.
Since your module is awesome, other users will want to play with it. Let them Limitations
know what the ground rules for contributing are. -----------
## Release Notes/Contributors/Etc **Optional** This module has only be tested on Debian 7.x versions, but should work on Debian <=7.
The default repository for Debian doesn't provide packages for Debian 8 (aka Jessie).
Development
-----------
Free to send contributions, fork it, ...
License
-------
WTFPL (http://wtfpl.org/)
If you aren't using changelog, put your release notes here (though you should
consider using changelog). You may also add any additional sections you feel are
necessary or important to include here. Please use the `## ` header.

1
manifests/init.pp
View File

@ -35,7 +35,6 @@
# WTFPL # WTFPL
# #
class megacli ( class megacli (
# Repository
$repo_ensure = $megacli::params::repo_ensure, $repo_ensure = $megacli::params::repo_ensure,
$repo_url = $megacli::params::repo_url, $repo_url = $megacli::params::repo_url,
$repo_key = $megacli::params::repo_key, $repo_key = $megacli::params::repo_key,