-- mode: markdown; mode: visual-line; --

Multipath Puppet Module

Configure multipath to detect multiple paths to devices for fail-over or performance reasons and coalesces them

  Copyright (c) 2017 UL HPC Team <hpc-sysadmins@uni.lu>

| Project Page | Sources | Documentation | 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.

Note: the various operations that can be conducted from this repository are piloted from a Rakefile and assumes you have a running Ruby installation. See docs/contributing.md for more details on the steps you shall follow to have this Rakefile working properly.

Dependencies

See metadata.json. In particular, this module depends on

• puppetlabs/stdlib
• puppetlabs/concat
• 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

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

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

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

Librarian-Puppet / R10K Setup

You can of course configure the multipath module in your Puppetfile to make it available with Librarian puppet or 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.

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.

You are more than welcome to contribute to its development by sending a pull request.

Puppet modules tests within a Vagrant box

The best way to test this module in a non-intrusive way is to rely on Vagrant. The Vagrantfile at the root of the repository pilot the provisioning various vagrant boxes available on Vagrant cloud you can use to test this module.

See docs/vagrant.md for more details.

Online Documentation

Read the Docs aka RTFD hosts documentation for the open source community and the ULHPC/multipath puppet module has its documentation (see the docs/ directly) hosted on readthedocs.

See docs/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.