Merge build 9 into master

README.md

@@ -1,8 +1,23 @@
 # Readme
 
-[![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_jenkins)](https://jenkins.confdroid.com/job/confdroid_jenkins/)|
+[![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_jenkins&style=plastic)](https://jenkins.confdroid.com/job/confdroid_jenkins/)
+[![Security Hotspots](https://sonarqube.confdroid.com/api/project_badges/measure?project=confdroid_jenkins&metric=security_hotspots&token=sqb_ab7299f9502c7e498c19b03bb06497fa15bdd70c)](https://sonarqube.confdroid.com/dashboard?id=confdroid_jenkins)
 
-[[_TOC_]]
+- [Readme](#readme)
+  - [Synopsis](#synopsis)
+  - [WARNING](#warning)
+  - [Features](#features)
+    - [Core](#core)
+    - [Optional](#optional)
+  - [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
 
@@ -14,9 +29,15 @@ Puppet 6 repo for managing Jenkins. Internal only due to access details for gitl
 
 ## Features
 
-INSTALLATION
+### Core
 
 - installs required binaries
+- manage service
+
+### Optional
+
+- create a sudoers file for the Jenkins user to allow passwordless sudo, via `js_use_sudo`. Defaults to `false`
+- manage firewall ports via `js_enable_fw`. Defaults to `true`. requires `puppetlabs-firewall`.
 
 ## Repo Documentation
 
@@ -26,7 +47,8 @@ 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
+- [confdroid_java](https://sourcecode.confdroid.com/confdroid/confdroid_java) to install java
+- puppetlabs-firewall via r10k
 
 ## Deployment
 

doc/file.README.html

@@ -60,9 +60,39 @@
       <div id="content"><div id='filecontents'>
 <h1 id="label-Readme">Readme</h1>
 
-<p><a href="https://jenkins.confdroid.com/job/confdroid_jenkins/"><img src="https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_jenkins"></a>|</p>
+<p><a href="https://jenkins.confdroid.com/job/confdroid_jenkins/"><img src="https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_jenkins&amp;style=plastic"></a> <a href="https://sonarqube.confdroid.com/dashboard?id=confdroid_jenkins"><img src="https://sonarqube.confdroid.com/api/project_badges/measure?project=confdroid_jenkins&amp;metric=security_hotspots&amp;token=sqb_ab7299f9502c7e498c19b03bb06497fa15bdd70c"></a></p>
-
+<ul><li>
-<p>[[<em>TOC</em>]]</p>
+<p><a href="#readme">Readme</a></p>
+</li><li>
+<p><a href="#synopsis">Synopsis</a></p>
+</li><li>
+<p><a href="#warning">WARNING</a></p>
+</li><li>
+<p><a href="#features">Features</a></p>
+<ul><li>
+<p><a href="#core">Core</a></p>
+</li><li>
+<p><a href="#optional">Optional</a></p>
+</li></ul>
+</li><li>
+<p><a href="#repo-documentation">Repo Documentation</a></p>
+</li><li>
+<p><a href="#dependencies">Dependencies</a></p>
+</li><li>
+<p><a href="#deployment">Deployment</a></p>
+</li><li>
+<p><a href="#selinux">SELINUX</a></p>
+</li><li>
+<p><a href="#known-problems">Known Problems</a></p>
+</li><li>
+<p><a href="#support">Support</a></p>
+</li><li>
+<p><a href="#tests">Tests</a></p>
+</li><li>
+<p><a href="#contact-us">Contact Us</a></p>
+</li><li>
+<p><a href="#disclaimer">Disclaimer</a></p>
+</li></ul>
 
 <h2 id="label-Synopsis">Synopsis</h2>
 
@@ -76,9 +106,18 @@
 
 <h2 id="label-Features">Features</h2>
 
-<p>INSTALLATION</p>
+<h3 id="label-Core">Core</h3>
 <ul><li>
 <p>installs required binaries</p>
+</li><li>
+<p>manage service</p>
+</li></ul>
+
+<h3 id="label-Optional">Optional</h3>
+<ul><li>
+<p>create a sudoers file for the Jenkins user to allow passwordless sudo, via <code>js_use_sudo</code>. Defaults to <code>false</code></p>
+</li><li>
+<p>manage firewall ports via <code>js_enable_fw</code>. Defaults to <code>true</code>. requires <code>puppetlabs-firewall</code>.</p>
 </li></ul>
 
 <h2 id="label-Repo+Documentation">Repo Documentation</h2>
@@ -89,7 +128,9 @@
 
 <p>All dependencies must be included in the catalogue.</p>
 <ul><li>
-<p><a href="https://gitlab.confdroid.com/puppet/java_cd">java_cd</a> to install java</p>
+<p><a href="https://sourcecode.confdroid.com/confdroid/confdroid_java">confdroid_java</a> to install java</p>
+</li><li>
+<p>puppetlabs-firewall via r10k</p>
 </li></ul>
 
 <h2 id="label-Deployment">Deployment</h2>

doc/index.html

@@ -60,9 +60,39 @@
       <div id="content"><div id='filecontents'>
 <h1 id="label-Readme">Readme</h1>
 
-<p><a href="https://jenkins.confdroid.com/job/confdroid_jenkins/"><img src="https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_jenkins"></a>|</p>
+<p><a href="https://jenkins.confdroid.com/job/confdroid_jenkins/"><img src="https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_jenkins&amp;style=plastic"></a> <a href="https://sonarqube.confdroid.com/dashboard?id=confdroid_jenkins"><img src="https://sonarqube.confdroid.com/api/project_badges/measure?project=confdroid_jenkins&amp;metric=security_hotspots&amp;token=sqb_ab7299f9502c7e498c19b03bb06497fa15bdd70c"></a></p>
-
+<ul><li>
-<p>[[<em>TOC</em>]]</p>
+<p><a href="#readme">Readme</a></p>
+</li><li>
+<p><a href="#synopsis">Synopsis</a></p>
+</li><li>
+<p><a href="#warning">WARNING</a></p>
+</li><li>
+<p><a href="#features">Features</a></p>
+<ul><li>
+<p><a href="#core">Core</a></p>
+</li><li>
+<p><a href="#optional">Optional</a></p>
+</li></ul>
+</li><li>
+<p><a href="#repo-documentation">Repo Documentation</a></p>
+</li><li>
+<p><a href="#dependencies">Dependencies</a></p>
+</li><li>
+<p><a href="#deployment">Deployment</a></p>
+</li><li>
+<p><a href="#selinux">SELINUX</a></p>
+</li><li>
+<p><a href="#known-problems">Known Problems</a></p>
+</li><li>
+<p><a href="#support">Support</a></p>
+</li><li>
+<p><a href="#tests">Tests</a></p>
+</li><li>
+<p><a href="#contact-us">Contact Us</a></p>
+</li><li>
+<p><a href="#disclaimer">Disclaimer</a></p>
+</li></ul>
 
 <h2 id="label-Synopsis">Synopsis</h2>
 
@@ -76,9 +106,18 @@
 
 <h2 id="label-Features">Features</h2>
 
-<p>INSTALLATION</p>
+<h3 id="label-Core">Core</h3>
 <ul><li>
 <p>installs required binaries</p>
+</li><li>
+<p>manage service</p>
+</li></ul>
+
+<h3 id="label-Optional">Optional</h3>
+<ul><li>
+<p>create a sudoers file for the Jenkins user to allow passwordless sudo, via <code>js_use_sudo</code>. Defaults to <code>false</code></p>
+</li><li>
+<p>manage firewall ports via <code>js_enable_fw</code>. Defaults to <code>true</code>. requires <code>puppetlabs-firewall</code>.</p>
 </li></ul>
 
 <h2 id="label-Repo+Documentation">Repo Documentation</h2>
@@ -89,7 +128,9 @@
 
 <p>All dependencies must be included in the catalogue.</p>
 <ul><li>
-<p><a href="https://gitlab.confdroid.com/puppet/java_cd">java_cd</a> to install java</p>
+<p><a href="https://sourcecode.confdroid.com/confdroid/confdroid_java">confdroid_java</a> to install java</p>
+</li><li>
+<p>puppetlabs-firewall via r10k</p>
 </li></ul>
 
 <h2 id="label-Deployment">Deployment</h2>