OP#647 initial commit after fork

README.md

@@ -1,14 +1,26 @@
 # Readme
 
-[![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=alloy_cd)](https://jenkins.confdroid.com/job/alloy_cd/)
+[![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_alloy&style=plastic)](https://jenkins.confdroid.com/job/confdroid_alloy/)
 
-[[_TOC_]]
+- [Readme](#readme)
+  - [Synopsis](#synopsis)
+  - [WARNING](#warning)
+  - [Features](#features)
+  - [Repo Documentation](#repo-documentation)
+  - [Dependencies](#dependencies)
+  - [Deployment](#deployment)
+  - [SELINUX](#selinux)
+  - [Known Problems](#known-problems)
+  - [Support](#support)
+  - [Tests](#tests)
+  - [Contact Us](#contact-us)
+  - [Disclaimer](#disclaimer)
 
 ## Synopsis
 
 Grafana Alloy is a log management agent built by Grafana labs to scrape and forward logs to Loki, a log management system also built by Grafana labs.  Then you can use Grafana itself to visualize those logs and built an alerting system.
 
-`alloy_cd` is a Puppet module to automate installation and configuration of alloy.
+`confdroid_alloy` is a Puppet module to automate installation and configuration of alloy.
 
 ## WARNING
 
@@ -18,13 +30,13 @@ Grafana Alloy is a log management agent built by Grafana labs to scrape and forw
 
 INSTALLATION
 
-* installs alloy binaries
+- installs alloy binaries
 
 CONFIGURATION
 
-* manage directories and files including templates
-* manages the main alloy jenkins for loki and prometheus
-* manage service
+- manage directories and files including templates
+- manages the main alloy jenkins for loki and prometheus
+- manage service
 
 ## Repo Documentation
 
@@ -36,17 +48,17 @@ All dependencies must be included in the catalogue.
 
 ## Deployment
 
-* native Puppet deployment
+- native Puppet deployment
 
 via site.pp or nodes.pp
 
 ```bash
 node 'example.example.net' {
-  include cd_kubernetes
+  include confdroid_alloy
 }
 ```
 
-* 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.
 
@@ -60,19 +72,22 @@ All files and directories are configured with correct selinux context. If selinu
 
 ## Support
 
-* OS: Rocky 9
-* Puppet 6,8
+- OS: Rocky 9
+- Puppet 8
 
 ## Tests
 
-* Puppet Lint
-* Puppet Parser
-* ERB Template Parser
-* Sonar Quality Gate
+- 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/)
+- [contact Us](https://confdroid.com/contact/)
+- [Feedback Portal](https://feedback.confdroid.com)
 
 ## Disclaimer