add installation and yumrepo

README.md

@@ -14,7 +14,66 @@ Puppet 6 repo for managing Jenkins. Internal only due to access details for gitl
 
 ## Features
 
+INSTALLATION
+
+* installs required binaries
+
+## Repo Documentation
+
+See the full Puppet documentation including parameters in `docs/index.html`
+
+## Dependencies
+
+All dependencies must be included in the catalogue.
+
+* [java_cd](https://gitlab.confdroid.com/puppet/java_cd) to install java
+
+## Deployment
+
+* native Puppet deployment
+
+via site.pp or nodes.pp
+
+```bash
+node 'example.example.net' {
+  include jenkins_cd
+}
+```
+
+* through Foreman:
+
+In order to apply parameters through Foreman, the params.pp must be added to the host or host group in question.
+
+See [more details about class deployment on Confdroid.com](https://confdroid.com/2017/05/deploying-our-puppet-modules/).
+
+## SELINUX
+
+All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.
+
+## Known Problems
+
 ## Support
 
-* Rocky 9
-* Puppet 8
+* OS: Rocky 9
+* Puppet 6-8
+
+## Tests
+
+* 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
+* 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.