doc/file.README.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="file_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/prometheus_cd/"><img src="https://jenkins.confdroid.com/buildStatus/icon?job=prometheus_cd"></a></p>

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

<p>Prometheus is an open-source monitoring system with a dimensional data model, flexible query language, efficient time series database and modern alerting approach.</p>

<p><code>prometheus_cd</code> is a Puppet module to automate installation and configuration of prometheus and node exporter. This module supports either managing prometheus or node_exporter or both. You need to set the parameters <code>$manage_prometheus</code>and / or <code>$manage_node_exporter</code>to true ( false by default)</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>

<p>INSTALLATION</p>
<ul><li>
<p>installs prometheus binaries (optional)</p>
</li><li>
<p>installs node_exporter binaries (optional)</p>
</li></ul>

<p>CONFIGURATION</p>
<ul><li>
<p>manage directories</p>
</li><li>
<p>manage files including templates</p>
</li><li>
<p>manage service</p>
</li></ul>

<p>Configurable options: - –storage.tsdb.retention.time via <code>$ps_retention_time</code> - –storage.tsdb.retention.size via <code>$ps_retention_size</code> - –storage.tsdb.wal-segment-size via <code>ps_wal_seg_size</code> - –storage.tsdb.min-block-duration via <code>ps_min_block_dur</code> - –storage.tsdb.max-block-duration via <code>ps_max_block_dur</code> - authentication user via <code>$ps_auth_user</code> - authentication password via <code>$ps_auth_pass</code> - web authentication password via <code>$ps_web_pass</code> ( different format required) - external remote write ( writing to a remote instance like pg-adapter):  - <code>ps_write_external</code> true enables it  - <code>ps_external_url</code> must be a valid full url  - <code>ps_auth_ext_user</code>must be a valid user  - <code>ps_auth_ext_pass</code>must be a valid password</p>

<h2 id="label-Puppet+Documentation">Puppet Documentation</h2>

<p>See the full Puppet documentation including parameters in <code>docs/index.html</code></p>

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

<p>All dependencies must be included in the catalogue.</p>

<h2 id="label-Deployment">Deployment</h2>
<ul><li>
<p>native Puppet deployment</p>
</li></ul>

<p>via site.pp or nodes.pp</p>

<pre class="code ruby"><code class="ruby">node &#39;example.example.net&#39; {
  include cd_prometheus
}
</code></pre>
<ul><li>
<p>through Foreman:</p>
</li></ul>

<p>In order to apply parameters through Foreman, the params.pp must be added to the host or host group in question.</p>

<p>See <a href="https://confdroid.com/2017/05/deploying-our-puppet-modules/">more details about class deployment on Confdroid.com</a>.</p>

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

<p>All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.</p>

<h2 id="label-Known+Problems">Known Problems</h2>

<h2 id="label-Support">Support</h2>
<ul><li>
<p>OS: Rocky 9</p>
</li><li>
<p>Puppet 8</p>
</li></ul>

<h2 id="label-Tests">Tests</h2>
<ul><li>
<p>Puppet Lint</p>
</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-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. v</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>