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

# Dhcp Puppet Module 

[![Puppet Forge](http://img.shields.io/puppetforge/v/ULHPC/dhcp.svg)](https://forge.puppetlabs.com/ULHPC/dhcp)
[![License](http://img.shields.io/:license-GPL3.0-blue.svg)](LICENSE)
![Supported Platforms](http://img.shields.io/badge/platform-debian-lightgrey.svg)
[![Documentation Status](https://readthedocs.org/projects/ulhpc-puppet-dhcp/badge/?version=latest)](https://readthedocs.org/projects/ulhpc-puppet-dhcp/?badge=latest)

Configure DHCP client and server

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

| [Project Page](https://github.com/ULHPC/puppet-dhcp) | [Sources](https://github.com/ULHPC/puppet-dhcp) | [Documentation](https://ulhpc-puppet-dhcp.readthedocs.org/en/latest/) | [Issues](https://github.com/ULHPC/puppet-dhcp/issues) |

## Synopsis

Configure DHCP client and server.

This module implements the following elements: 

* __Puppet classes__:
    - `dhcp` 
    - `dhcp::client` 
    - `dhcp::client::common` 
    - `dhcp::client::debian` 
    - `dhcp::client::redhat` 
    - `dhcp::params` 
    - `dhcp::server` 
    - `dhcp::server::common` 
    - `dhcp::server::debian` 
    - `dhcp::server::redhat` 

* __Puppet definitions__: 

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)
* [puppet/rsyslog](https://forge.puppetlabs.com/puppet/rsyslog)

## Overview and Usage

### Class `dhcp`

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 ' dhcp'

See also [`tests/init.pp`](tests/init.pp)

### Class `dhcp::client`

See [`tests/client.pp`](tests/client.pp)
### Class `dhcp::client::debian`

See [`tests/client/debian.pp`](tests/client/debian.pp)
### Class `dhcp::client::redhat`

See [`tests/client/redhat.pp`](tests/client/redhat.pp)
### Class `dhcp::server`

See [`tests/server.pp`](tests/server.pp)
### Class `dhcp::server::debian`

See [`tests/server/debian.pp`](tests/server/debian.pp)
### Class `dhcp::server::redhat`

See [`tests/server/redhat.pp`](tests/server/redhat.pp)


## Librarian-Puppet / R10K Setup

You can of course configure the dhcp 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/dhcp"

or, if you prefer to work on the git version: 

     mod "ULHPC/dhcp", 
         :git => 'https://github.com/ULHPC/puppet-dhcp',
         :ref => 'production' 

## Issues / Feature request

You can submit bug / issues / feature request using the [ULHPC/dhcp Puppet Module Tracker](https://github.com/ULHPC/puppet-dhcp/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/dhcp](https://github.com/ULHPC/puppet-dhcp) puppet module has its documentation (see the `docs/` directly) hosted on [readthedocs](http://ulhpc-puppet-dhcp.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.


[![Licence](https://www.gnu.org/graphics/gplv3-88x31.png)](LICENSE)