diff --git a/README.md b/README.md index f94db55..3ecb899 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,13 @@ Puppet 6 repo for managing Jenkins. Internal only due to access details for gitl ## 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*** +> **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 INSTALLATION -* installs required binaries +- installs required binaries ## Repo Documentation @@ -26,11 +26,11 @@ See the full Puppet documentation including parameters in `docs/index.html` All dependencies must be included in the catalogue. -* [java_cd](https://gitlab.confdroid.com/puppet/java_cd) to install java +- [java_cd](https://gitlab.confdroid.com/puppet/java_cd) to install java ## Deployment -* native Puppet deployment +- native Puppet deployment via site.pp or nodes.pp @@ -40,7 +40,7 @@ node 'example.example.net' { } ``` -* through Foreman: +- through Foreman: In order to apply parameters through Foreman, the params.pp must be added to the host or host group in question. @@ -54,21 +54,22 @@ All files and directories are configured with correct selinux context. If selinu ## Support -* OS: Rocky 9 -* Puppet 6-8 +- OS: Rocky 9 (all RHEL-based OS should work but Rocky 9 is tested) +- Puppet 8 ## Tests -* Puppet Lint -* Puppet Parser -* ERB Template Parser -* Sonar Quality Gate +- Puppet Lint +- Puppet Parser +- ERB Template Parser +- Sonar Quality Gate ## Contact Us -[contact Us](https://confdroid.com/contact/) +- [contact Us](https://confdroid.com/contact/) +- [Feedback Portal](https://feedback.confdroid.com/) ## 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. \ No newline at end of file +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.