-- mode: markdown; mode: visual-line; --
Network Puppet Module
Configure various network aspects (interfaces etc.)
Copyright (c) 2017 UL HPC Team <hpc-sysadmins@uni.lu>
| Project Page | Sources | Documentation | Issues |
Synopsis
Configure various network aspects (interfaces etc.).
This module implements the following elements:
-
Puppet classes:
network
network::common
network::common::debian
network::common::redhat
network::params
-
Puppet definitions:
network::interface
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
Overview and Usage
network
Class 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 ' network'
See also tests/init.pp
network::interface
Definition The definition network::interface
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:
network::interface { 'toto':
ensure => 'present',
}
See also tests/interface.pp
Librarian-Puppet / R10K Setup
You can of course configure the network 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-network"
or, if you prefer to work on the git version:
mod "ULHPC-network",
:git => 'https://github.com/ULHPC/puppet-network',
:ref => 'production'
Issues / Feature request
You can submit bug / issues / feature request using the ULHPC-network 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-network 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.