3
0

update Readme

This commit is contained in:
Arne Teuke
2025-02-26 14:50:35 +01:00
parent 21c73d52d5
commit 37587f58f3
2 changed files with 12 additions and 3 deletions

View File

@@ -8,6 +8,7 @@
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
@@ -22,6 +23,14 @@ The syntax etc is specifically for Puppet Core 8 and Rocky 9, although might wor
* 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) are not overridable and usually used for keeping the code in the classes more readable.
## Module Deployment
ALmost all puppet setups are 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
@@ -44,4 +53,6 @@ The syntax etc is specifically for Puppet Core 8 and Rocky 9, although might wor
## 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.
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

View File

@@ -4,7 +4,5 @@
# @summary Class initialize the puppet_cd module.
###############################################################################
class puppet_cd {
include puppet_cd::params
}