Skip to content
Snippets Groups Projects
README.md 2.79 KiB
Newer Older
12ww1160's avatar
12ww1160 committed
# Readme
12ww1160's avatar
12ww1160 committed


12ww1160's avatar
12ww1160 committed
[![Build Status](https://pipelines.confdroid.com/buildStatus/icon?job=hosts_cd)](https://pipelines.confdroid.com/job/hosts_cd/)
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
[[_TOC_]]
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
## Synopsis
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
Linux manages local hosts entries for name resolution where regular DNS cannot be used, for instance with dual-homed networks, were only the primary network is resolved through DNS.
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
`hosts_cd` is a Puppet module to automate the population of hosts files.
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
## WARNING
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
***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***
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
## Features
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
## Repo Documentation
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
See the full Puppet documentation including parameters in `docs/index.html`.
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
## Deployment
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
* native Puppet deployment
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
via `site.pp` or `nodes.pp`
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
```ruby
node 'example.example.net' {
  include cd_swap
}
```
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
* through Foreman:
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
In order to apply parameters through Foreman, **__swap_cd::params__** must be added to the host or host group in question.
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
See [more details about class deployment on Confdroid.com](https://confdroid.com/2017/05/deploying-our-puppet-modules/).
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
## SELINUX
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.
12ww1160's avatar
12ww1160 committed

## Support

12ww1160's avatar
12ww1160 committed
* OS: Rocky 9
* Puppet 8

Anything else might work but is untested.
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
## Tests
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
* Puppet Lint
  * excluded tests:
    * `--no-class_inherits_from_params_class-check`:relevant only to non-supported outdated puppet versions
    * `--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.
    * `--no-80chars-check`: it is not always possible to stay within 80 characters, although typically only occurring on the parameter vault `params.pp`.
    * `--no-arrow_alignment-check`: this check leads to actually not having am easily readable arrow alignment, as this checks `per block`, not per class.
* Puppet Parser
* ERB Template Parser
* Test for unwanted UTF8 files in the Puppet code (see tests/UTF_Files)
* Markdown-lint
* Spellcheck
* Sonar Quality Gate
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
## Contact Us
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
[contact Us](https://confdroid.com/contact/)
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
## Disclaimer
12ww1160's avatar
12ww1160 committed

12ww1160's avatar
12ww1160 committed
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.