From 28aa04be3fc2bc19b1b840acc138af6e8765f123 Mon Sep 17 00:00:00 2001
From: Jenkins Server <jenkins@confdroid.com>
Date: Wed, 26 Nov 2025 19:07:52 +0100
Subject: [PATCH] Recommit for updates in build 108

---
 doc/file.README.html | 60 +++++++++++++++++++++++++++++---------------
 doc/index.html       | 60 +++++++++++++++++++++++++++++---------------
 2 files changed, 80 insertions(+), 40 deletions(-)

diff --git a/doc/file.README.html b/doc/file.README.html
index 3398d3c..079b7bf 100644
--- a/doc/file.README.html
+++ b/doc/file.README.html
@@ -66,9 +66,11 @@
 
 <h2 id="label-Synopsis">Synopsis</h2>
 
-<p>This Puppet module configures settings for Puppet master , agents and R10k, the full bundle. Puppetdb has been outsourced to a <a href="https://gitlab.confdroid.com/puppet/puppetdb_cd">module</a> on its own, due to complexity</p>
+<p>This Puppet module configures settings a full Puppet environment, i.e. Puppet master, Puppet agents pointed to the master.</p>
 
-<p>The syntax 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.</p>
+<p>Optionally: * R10k to connect to a control repo and manage puppet modules * webhook listener to trigger r10k when a puppet module has been updated. * PuppetDB for exporting and storing resources.</p>
+
+<p>The syntax is specifically for Puppet Core 8 and Rocky 9, although might work elsewhere as well. This module is also designed to work with Foreman as External Node Classifier (ENC), although it does not install Foreman.</p>
 
 <h2 id="label-WARNING">WARNING</h2>
 
@@ -83,23 +85,6 @@
 <p>Any other system becomes a puppet agent.</p>
 </li></ul>
 
-<h3 id="label-R10k+service+-28optional-29">R10k service (optional)</h3>
-<ul><li>
-<p>install r10k service on your puppetmaster.  If you set <code>$pt_use_r10k</code>to <code>true</code>, it also installs r10k to connect to a control repo and manage the code available to clients via Puppetfile.</p>
-</li></ul>
-
-<h3 id="label-R10k+Web+hook">R10k Web hook</h3>
-<ul><li>
-<p>installs a webhook listener  If you set <code>$pt_use_r10k_webhook</code>to <code>true</code>, it also installs a simple webhook listener to watch for post_hooks from gitlab, and triggers the r10k deployment.</p>
-</li></ul>
-
-<h3 id="label-Puppetdb">Puppetdb</h3>
-<ul><li>
-<p>to do</p>
-</li><li>
-<p>install node.rb from the foreman for puppetdb</p>
-</li></ul>
-
 <h3 id="label-Firewall">Firewall</h3>
 <ul><li>
 <p>open firewall ports depending on choices above</p>
@@ -112,6 +97,25 @@
 <p>start services as required</p>
 </li></ul>
 
+<h3 id="label-Optional">Optional</h3>
+
+<h4 id="label-R10k+service">R10k service</h4>
+<ul><li>
+<p>install r10k service on your puppetmaster.  If you set <code>$pt_use_r10k</code>to <code>true</code>, it also installs r10k to connect to a control repo and manage the code available to clients via Puppetfile.</p>
+</li></ul>
+
+<h4 id="label-R10k+Web+hook">R10k Web hook</h4>
+<ul><li>
+<p>installs a webhook listener  If you set <code>$pt_use_r10k_webhook</code>to <code>true</code>, it also installs a simple webhook listener to watch for post_hooks from gitlab, and triggers the r10k deployment.</p>
+</li></ul>
+
+<h4 id="label-Puppetdb">Puppetdb</h4>
+<ul><li>
+<p>to do</p>
+</li><li>
+<p>install node.rb from the foreman for puppetdb</p>
+</li></ul>
+
 <h2 id="label-Support">Support</h2>
 <ul><li>
 <p>Rocky 9</p>
@@ -125,7 +129,21 @@
 
 <h2 id="label-Module+Deployment">Module Deployment</h2>
 
-<p>ALmost every puppet setup is done in very custom ways, and hence the way the modules are deployed to nodes are different. This module assumes <a href="https://www.theforeman.org/manuals/3.13/quickstart_guide.html">Foreman</a> as ENC, so the modules just have to be present on the master node and Foreman will take care for it.</p>
+<h3 id="label-native+Puppet+deployment-3A+via+site.pp+or+nodes.pp">native Puppet deployment: via site.pp or nodes.pp</h3>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_include'>include</span> <span class='id identifier rubyid_cd_puppet'>cd_puppet</span>
+</code></pre>
+
+<h3 id="label-through+Foreman">through Foreman</h3>
+<ul><li>
+<p>ensure the module is present on the puppetmaster running Foreman in the module path, i.e. /etc/puppetlabs/code/environments/production/ . use r10k or clone the module there through git</p>
+</li><li>
+<p>import the module in Foreman</p>
+</li><li>
+<p>assign <code>puppet_cd::params</code> to the nodes in question, typically a host group.</p>
+</li><li>
+<p>overwrite the value for <code>$pt_pm_fqdn</code>to match your puppetmaster’s fqdn. <strong>This will overwrite the puppet.conf with the settings set in params.pp. It is highly recommended to use a test system first to see and fine tune those settings!</strong> Any node not matching this fqdn will become an agent.</p>
+</li></ul>
 
 <h2 id="label-Tests">Tests</h2>
 <ul><li>
@@ -147,6 +165,8 @@
 
 <p><a href="https://confdroid.com/contact/">contact Us</a></p>
 
+<h2 id="label-Documentation">Documentation</h2>
+
 <h2 id="label-Disclaimer">Disclaimer</h2>
 
 <p>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.</p>
diff --git a/doc/index.html b/doc/index.html
index 243777b..31e6f5e 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -66,9 +66,11 @@
 
 <h2 id="label-Synopsis">Synopsis</h2>
 
-<p>This Puppet module configures settings for Puppet master , agents and R10k, the full bundle. Puppetdb has been outsourced to a <a href="https://gitlab.confdroid.com/puppet/puppetdb_cd">module</a> on its own, due to complexity</p>
+<p>This Puppet module configures settings a full Puppet environment, i.e. Puppet master, Puppet agents pointed to the master.</p>
 
-<p>The syntax 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.</p>
+<p>Optionally: * R10k to connect to a control repo and manage puppet modules * webhook listener to trigger r10k when a puppet module has been updated. * PuppetDB for exporting and storing resources.</p>
+
+<p>The syntax is specifically for Puppet Core 8 and Rocky 9, although might work elsewhere as well. This module is also designed to work with Foreman as External Node Classifier (ENC), although it does not install Foreman.</p>
 
 <h2 id="label-WARNING">WARNING</h2>
 
@@ -83,23 +85,6 @@
 <p>Any other system becomes a puppet agent.</p>
 </li></ul>
 
-<h3 id="label-R10k+service+-28optional-29">R10k service (optional)</h3>
-<ul><li>
-<p>install r10k service on your puppetmaster.  If you set <code>$pt_use_r10k</code>to <code>true</code>, it also installs r10k to connect to a control repo and manage the code available to clients via Puppetfile.</p>
-</li></ul>
-
-<h3 id="label-R10k+Web+hook">R10k Web hook</h3>
-<ul><li>
-<p>installs a webhook listener  If you set <code>$pt_use_r10k_webhook</code>to <code>true</code>, it also installs a simple webhook listener to watch for post_hooks from gitlab, and triggers the r10k deployment.</p>
-</li></ul>
-
-<h3 id="label-Puppetdb">Puppetdb</h3>
-<ul><li>
-<p>to do</p>
-</li><li>
-<p>install node.rb from the foreman for puppetdb</p>
-</li></ul>
-
 <h3 id="label-Firewall">Firewall</h3>
 <ul><li>
 <p>open firewall ports depending on choices above</p>
@@ -112,6 +97,25 @@
 <p>start services as required</p>
 </li></ul>
 
+<h3 id="label-Optional">Optional</h3>
+
+<h4 id="label-R10k+service">R10k service</h4>
+<ul><li>
+<p>install r10k service on your puppetmaster.  If you set <code>$pt_use_r10k</code>to <code>true</code>, it also installs r10k to connect to a control repo and manage the code available to clients via Puppetfile.</p>
+</li></ul>
+
+<h4 id="label-R10k+Web+hook">R10k Web hook</h4>
+<ul><li>
+<p>installs a webhook listener  If you set <code>$pt_use_r10k_webhook</code>to <code>true</code>, it also installs a simple webhook listener to watch for post_hooks from gitlab, and triggers the r10k deployment.</p>
+</li></ul>
+
+<h4 id="label-Puppetdb">Puppetdb</h4>
+<ul><li>
+<p>to do</p>
+</li><li>
+<p>install node.rb from the foreman for puppetdb</p>
+</li></ul>
+
 <h2 id="label-Support">Support</h2>
 <ul><li>
 <p>Rocky 9</p>
@@ -125,7 +129,21 @@
 
 <h2 id="label-Module+Deployment">Module Deployment</h2>
 
-<p>ALmost every puppet setup is done in very custom ways, and hence the way the modules are deployed to nodes are different. This module assumes <a href="https://www.theforeman.org/manuals/3.13/quickstart_guide.html">Foreman</a> as ENC, so the modules just have to be present on the master node and Foreman will take care for it.</p>
+<h3 id="label-native+Puppet+deployment-3A+via+site.pp+or+nodes.pp">native Puppet deployment: via site.pp or nodes.pp</h3>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_include'>include</span> <span class='id identifier rubyid_cd_puppet'>cd_puppet</span>
+</code></pre>
+
+<h3 id="label-through+Foreman">through Foreman</h3>
+<ul><li>
+<p>ensure the module is present on the puppetmaster running Foreman in the module path, i.e. /etc/puppetlabs/code/environments/production/ . use r10k or clone the module there through git</p>
+</li><li>
+<p>import the module in Foreman</p>
+</li><li>
+<p>assign <code>puppet_cd::params</code> to the nodes in question, typically a host group.</p>
+</li><li>
+<p>overwrite the value for <code>$pt_pm_fqdn</code>to match your puppetmaster’s fqdn. <strong>This will overwrite the puppet.conf with the settings set in params.pp. It is highly recommended to use a test system first to see and fine tune those settings!</strong> Any node not matching this fqdn will become an agent.</p>
+</li></ul>
 
 <h2 id="label-Tests">Tests</h2>
 <ul><li>
@@ -147,6 +165,8 @@
 
 <p><a href="https://confdroid.com/contact/">contact Us</a></p>
 
+<h2 id="label-Documentation">Documentation</h2>
+
 <h2 id="label-Disclaimer">Disclaimer</h2>
 
 <p>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.</p>