https://github.com/ulhpc/puppet-multipath
Configure multipath to detect multiple paths to devices for fail-over or performance reasons and coalesces them
https://github.com/ulhpc/puppet-multipath
Last synced: 8 months ago
JSON representation
Configure multipath to detect multiple paths to devices for fail-over or performance reasons and coalesces them
- Host: GitHub
- URL: https://github.com/ulhpc/puppet-multipath
- Owner: ULHPC
- License: other
- Created: 2016-07-19T13:08:23.000Z (almost 10 years ago)
- Default Branch: devel
- Last Pushed: 2022-11-08T08:52:02.000Z (over 3 years ago)
- Last Synced: 2025-09-12T16:27:05.455Z (9 months ago)
- Language: Puppet
- Size: 87.9 KB
- Stars: 0
- Watchers: 7
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing/index.md
- License: LICENSE
Awesome Lists containing this project
README
-*- mode: markdown; mode: visual-line; -*-
# Multipath Puppet Module
[](https://forge.puppetlabs.com/ULHPC/multipath)
[](LICENSE)
[](https://readthedocs.org/projects/ulhpc-puppet-multipath/?badge=latest)
Configure multipath to detect multiple paths to devices for fail-over or performance reasons and coalesces them
Copyright (c) 2017 UL HPC Team
| [Project Page](https://github.com/ULHPC/puppet-multipath) | [Sources](https://github.com/ULHPC/puppet-multipath) | [Documentation](https://ulhpc-puppet-multipath.readthedocs.org/en/latest/) | [Issues](https://github.com/ULHPC/puppet-multipath/issues) |
## Synopsis
Configure multipath to detect multiple paths to devices for fail-over or performance reasons and coalesces them.
This module implements the following elements:
* __Puppet classes__:
- `multipath`
- `multipath::common`
- `multipath::common::debian`
- `multipath::common::redhat`
- `multipath::params`
* __Puppet definitions__:
- `multipath::blacklist`
- `multipath::device`
- `multipath::path`
All these components are configured through a set of variables you will find in
[`manifests/params.pp`](manifests/params.pp).
_Note_: the various operations that can be conducted from this repository are piloted from a [`Rakefile`](https://github.com/ruby/rake) and assumes you have a running [Ruby](https://www.ruby-lang.org/en/) installation.
See `docs/contributing.md` for more details on the steps you shall follow to have this `Rakefile` working properly.
## Dependencies
See [`metadata.json`](metadata.json). In particular, this module depends on
* [puppetlabs/stdlib](https://forge.puppetlabs.com/puppetlabs/stdlib)
* [puppetlabs/concat](https://forge.puppetlabs.com/puppetlabs/concat)
* [ULHPC/rclocal](https://forge.puppetlabs.com/ULHPC/rclocal)
## Overview and Usage
### Class `multipath`
This is the main class defined in this module.
It accepts the following parameters:
* `$ensure`: default to 'present', can be 'absent'
Use it as follows:
include ' multipath'
See also [`tests/init.pp`](tests/init.pp)
### Definition `multipath::blacklist`
The definition `multipath::blacklist` provides ...
This definition accepts the following parameters:
* `$ensure`: default to 'present', can be 'absent'
* `$content`: specify the contents of the directive as a string
* `$source`: copy a file as the content of the directive.
Example:
multipath::blacklist { 'toto':
ensure => 'present',
}
See also [`tests/blacklist.pp`](tests/blacklist.pp)
### Definition `multipath::device`
The definition `multipath::device` provides ...
This definition accepts the following parameters:
* `$ensure`: default to 'present', can be 'absent'
* `$content`: specify the contents of the directive as a string
* `$source`: copy a file as the content of the directive.
Example:
multipath::device { 'toto':
ensure => 'present',
}
See also [`tests/device.pp`](tests/device.pp)
### Definition `multipath::path`
The definition `multipath::path` provides ...
This definition accepts the following parameters:
* `$ensure`: default to 'present', can be 'absent'
* `$content`: specify the contents of the directive as a string
* `$source`: copy a file as the content of the directive.
Example:
multipath::path { 'toto':
ensure => 'present',
}
See also [`tests/path.pp`](tests/path.pp)
## Librarian-Puppet / R10K Setup
You can of course configure the multipath module in your `Puppetfile` to make it available with [Librarian puppet](http://librarian-puppet.com/) or
[r10k](https://github.com/adrienthebo/r10k) by adding the following entry:
# Modules from the Puppet Forge
mod "ULHPC/multipath"
or, if you prefer to work on the git version:
mod "ULHPC/multipath",
:git => 'https://github.com/ULHPC/puppet-multipath',
:ref => 'production'
## Issues / Feature request
You can submit bug / issues / feature request using the [ULHPC/multipath Puppet Module Tracker](https://github.com/ULHPC/puppet-multipath/issues).
## Developments / Contributing to the code
If you want to contribute to the code, you shall be aware of the way this module is organized.
These elements are detailed on [`docs/contributing.md`](contributing/index.md).
You are more than welcome to contribute to its development by [sending a pull request](https://help.github.com/articles/using-pull-requests).
## Puppet modules tests within a Vagrant box
The best way to test this module in a non-intrusive way is to rely on [Vagrant](http://www.vagrantup.com/).
The `Vagrantfile` at the root of the repository pilot the provisioning various vagrant boxes available on [Vagrant cloud](https://atlas.hashicorp.com/boxes/search?utf8=%E2%9C%93&sort=&provider=virtualbox&q=svarrette) you can use to test this module.
See [`docs/vagrant.md`](vagrant.md) for more details.
## Online Documentation
[Read the Docs](https://readthedocs.org/) aka RTFD hosts documentation for the open source community and the [ULHPC/multipath](https://github.com/ULHPC/puppet-multipath) puppet module has its documentation (see the `docs/` directly) hosted on [readthedocs](http://ulhpc-puppet-multipath.rtfd.org).
See [`docs/rtfd.md`](rtfd.md) for more details.
## Licence
This project and the sources proposed within this repository are released under the terms of the [GPL-3.0](LICENCE) licence.
[](LICENSE)