doc/index.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
  File: README
  
    &mdash; Documentation by YARD 0.9.36
  
</title>

  <link rel="stylesheet" href="css/style.css" type="text/css" />

  <link rel="stylesheet" href="css/common.css" type="text/css" />

<script type="text/javascript">
  pathId = "";
  relpath = '';
</script>


  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>

  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>


  </head>
  <body>
    <div class="nav_wrap">
      <iframe id="nav" src="puppet_class_list.html?1"></iframe>
      <div id="resizer"></div>
    </div>

    <div id="main" tabindex="-1">
      <div id="header">
        <div id="menu">
  
    <a href="_index.html">Index</a> &raquo; 
    <span class="title">File: README</span>
  
</div>

        <div id="search">
  
    <a class="full_list_link" id="puppet_class_list_link"
        href="puppet_class_list.html">

        <svg width="24" height="24">
          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
        </svg>
    </a>
  
</div>
        <div class="clear"></div>
      </div>

      <div id="content"><div id='filecontents'>
<h1 id="label-Readme">Readme</h1>

<p><a href="https://jenkins.confdroid.com/job/puppet_cd/"><img src="https://jenkins.confdroid.com/buildStatus/icon?job=puppet_cd"></a>|</p>

<p>[[<em>TOC</em>]]</p>

<h2 id="label-Synopsis">Synopsis</h2>

<p>This Puppet module configures settings a full Puppet environment, i.e. Puppet master, Puppet agents pointed to the master.</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>

<p><strong><em>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</em></strong></p>

<h2 id="label-Features">Features</h2>

<h3 id="label-Puppet+server+and+agent">Puppet server and agent</h3>
<ul><li>
<p>if the host FQDN matches your specified Puppet master via <code>$pt_pm_fqdn</code>, it installs and configures a puppetmaster ready for serving with Foreman as ENC ( Foreman not yet included).</p>
</li><li>
<p>Any other system becomes a puppet agent.</p>
</li></ul>

<h3 id="label-Firewall">Firewall</h3>
<ul><li>
<p>open firewall ports depending on choices above</p>
</li></ul>

<h3 id="label-Directories-2C+Files+and+Services-2C">Directories, Files and Services,</h3>
<ul><li>
<p>manage directories and required files including  permissions and selinux context (todo)</p>
</li><li>
<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>
</li><li>
<p>Puppet Core 8</p>
</li></ul>

<h2 id="label-Parameter+Inheritance">Parameter Inheritance</h2>

<p>All parameters are listed in <code>params.pp</code> and inherited from there. Variable parameters are in the upper section and also documented in the top. These can be overridden by the ENC. Parameters in the bottom section (curly brackets) cannot be overridden and usually are used for keeping the code in the classes more readable.</p>

<h2 id="label-Module+Deployment">Module Deployment</h2>

<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>
<p>Puppet Lint</p>
</li><li>
<p>excluded tests:</p>
<ul><li>
<p><code>--no-variable_scope-check</code>: not applicable as we are inheriting parameters from params class. the lint check does not distinguish between facts and inherited parameters.</p>
</li></ul>
</li><li>
<p>Puppet Parser</p>
</li><li>
<p>ERB Template Parser</p>
</li><li>
<p>Sonar Quality Gate</p>
</li></ul>

<h2 id="label-Contact+Us">Contact Us</h2>

<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>
</div></div>

      <div id="footer">
     Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
</div>

    </div>
  </body>
</html>