* Update README.md file.
This commit is contained in:
parent
ee48f48678
commit
b048db6511
|
|
@ -9,3 +9,4 @@
|
|||
* Install package ipmitool
|
||||
* Ensure needed modules load at boot time
|
||||
* Load one needed module (for Debian) one time
|
||||
* Update README.md file.
|
||||
|
|
|
|||
101
README.md
101
README.md
|
|
@ -3,51 +3,45 @@
|
|||
#### Table of Contents
|
||||
|
||||
1. [Overview](#overview)
|
||||
2. [Module Description - What the module does and why it is useful](#module-description)
|
||||
3. [Setup - The basics of getting started with ipmi](#setup)
|
||||
* [What ipmi affects](#what-ipmi-affects)
|
||||
* [Setup requirements](#setup-requirements)
|
||||
* [Beginning with ipmi](#beginning-with-ipmi)
|
||||
4. [Usage - Configuration options and additional functionality](#usage)
|
||||
5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
|
||||
5. [Limitations - OS compatibility, etc.](#limitations)
|
||||
6. [Development - Guide for contributing to the module](#development)
|
||||
2. [Module Description](#module-description)
|
||||
3. [Setup](#setup)
|
||||
* [What IPMI affects](#what-ipmi-affects)
|
||||
* [Beginning with IPMI](#beginning-with-ipmi)
|
||||
4. [Usage](#usage)
|
||||
5. [Reference](#reference)
|
||||
* [Classes](#classes)
|
||||
* [Defined types](#defined-types)
|
||||
* [Parameters](#parameters)
|
||||
6. [Limitations](#limitations)
|
||||
7. [Development](#development)
|
||||
8. [License](#license)
|
||||
|
||||
|
||||
|
||||
## Overview
|
||||
|
||||
A one-maybe-two sentence summary of what the module does/what problem it solves.
|
||||
This is your 30 second elevator pitch for your module. Consider including
|
||||
OS/Puppet version it works with.
|
||||
The ipmi module provide a simple way to install IPMI service on a machine.
|
||||
You also can configure user and device.
|
||||
|
||||
## Module Description
|
||||
|
||||
If applicable, this section should have a brief description of the technology
|
||||
the module integrates with and what that integration enables. This section
|
||||
should answer the questions: "What does this module *do*?" and "Why would I use
|
||||
it?"
|
||||
|
||||
If your module has a range of functionality (installation, configuration,
|
||||
management, etc.) this is the time to mention it.
|
||||
The module install all needed packages and load the modules to be able to
|
||||
manage the BMC with a Debian family system.
|
||||
|
||||
## Setup
|
||||
|
||||
### What ipmi affects
|
||||
### What IPMI affects
|
||||
|
||||
* A list of files, packages, services, or operations that the module will alter,
|
||||
impact, or execute on the system it's installed on.
|
||||
* This is a great place to stick any warnings.
|
||||
* Can be in list or paragraph form.
|
||||
* Package for IPMI
|
||||
* Kernel modules at boot time
|
||||
|
||||
### Setup Requirements **OPTIONAL**
|
||||
### Beginning with IPMI
|
||||
|
||||
If your module requires anything extra before setting up (pluginsync enabled,
|
||||
etc.), mention it here.
|
||||
To begin using ipmi with default parameters, declare the main class with:
|
||||
```
|
||||
include ipmi
|
||||
```
|
||||
|
||||
### Beginning with ipmi
|
||||
|
||||
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).
|
||||
|
||||
|
|
@ -58,22 +52,39 @@ the fancy stuff with your module here.
|
|||
|
||||
## Reference
|
||||
|
||||
Here, list the classes, types, providers, facts, etc contained in your module.
|
||||
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!)
|
||||
### Classes
|
||||
|
||||
## Limitations
|
||||
* `ipmi`: Main class, load all subclasses to install and configure IPMI.
|
||||
|
||||
This is where you list OS compatibility, version compatibility, etc.
|
||||
### Defined types
|
||||
|
||||
## Development
|
||||
* Not yet implemented
|
||||
|
||||
Since your module is awesome, other users will want to play with it. Let them
|
||||
know what the ground rules for contributing are.
|
||||
### Parameters
|
||||
|
||||
#### ipmi
|
||||
|
||||
* `pkg_ensure`: What to set the packages to. Can be 'present', 'absent' or 'version'. Defaults to 'present'.
|
||||
* `pkg_name`: The list of packages. Can be an array [ 'ipmitool', 'openipmi' ].
|
||||
* `modules_list`: The modules list to load at boot time.
|
||||
* `modules_file_path`: The configuration file will contain the modules list. Defaults to '/etc/modules-load.d/ipmi.conf'.
|
||||
* `modules_file_content`: Template file to use to generate the previous configuration file. Defaults to 'ipmi/ipmi_modules.conf.erb'.
|
||||
* `needed_module_name`: The module it's necessary to load one time to be able to use ipmi devices.
|
||||
|
||||
|
||||
Limitations
|
||||
-----------
|
||||
|
||||
This module will work only on Debian 7.x versions and maybe on Debian 8.x (to test).
|
||||
|
||||
Development
|
||||
-----------
|
||||
|
||||
Free to send contributions, fork it, ...
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
WTFPL (http://wtfpl.org/)
|
||||
|
||||
## Release Notes/Contributors/Etc **Optional**
|
||||
|
||||
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.
|
||||
|
|
|
|||
Loading…
Reference in New Issue