# Readme

[![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=puppet_cd)](https://jenkins.confdroid.com/job/puppet_cd/)|

[[_TOC_]]

## Synopsis

This Puppet module configures settings for Puppet master and agents, PuppetDB and R10k, the full bundle.
The syntax etc is specifically for Puppet Core 8 and Rocky 9, although might work elsewhere as well.
This module is also designed to work with External Node Classifiers (ENC), for instance Foreman.

## WARNING

***Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previous configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production***

## Features

* install packages depending on whether the host fqdn equals either master fqdn, db fqdn or none (agent).
* open firewall ports depending on fqdn choices
* start services as required
* manage directories
* manage user settings (optional)

## Support

* Rocky 9
* Puppet Core 8

## Parameter Inheritance

All parameters are listed in `params.pp` and inherited from there.  Variable parameters are in the upper section and also documented in the top. These can be overridden by the ENC. Parameters in the bottom section (curly brackets) cannot be overridden and usually are used for keeping the code in the classes more readable.

## Module Deployment

ALmost every puppet setup is done in very custom ways, and hence the way the modules are deployed to nodes are different. This module assumes [Foreman][def] as ENC, so the modules just have to be present on the master node and Foreman will take care for it.

## Tests

* Puppet Lint
  * excluded tests:
    * `--no-variable_scope-check`: not applicable as we are inheriting parameters from params class. the lint check does not distinguish between facts and inherited parameters.
* Puppet Parser
* ERB Template Parser
* Sonar Quality Gate

## Contact Us

[contact Us](https://confdroid.com/contact/)

## Disclaimer

ConfDroid as entity is entirely independent from Puppet. We provide custom configuration modules, written for specific purposes and specific environments.
The modules are tested and supported only as documented, and require testing in designated environments  (i.e. lab or development environments) for parameter tuning etc. before deploying into production environments.

[def]: https://www.theforeman.org/manuals/3.13/quickstart_guide.html