Files
confdroid_nagios/doc/file.README.html

233 lines
8.6 KiB
HTML
Raw Normal View History

2026-02-13 19:30:20 +01:00
<!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>
2026-02-21 13:09:22 +01:00
<p><a href="https://jenkins.confdroid.com/job/confdroid_nagios/"><img src="https://jenkins.confdroid.com/job/confdroid_nagios/badge/icon?style=plastic"></a> <a href="https://sonarqube.confdroid.com/dashboard?id=confdroid_nagios"><img src="https://sonarqube.confdroid.com/api/project_badges/measure?project=confdroid_nagios&amp;metric=security_hotspots&amp;token=sqb_927c2cd1f1b90805cde962af0f5eda9ec936eb6f"></a></p>
2026-02-13 19:30:20 +01:00
<ul><li>
<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>
2026-02-14 21:29:11 +01:00
<ul><li>
<p><a href="#configuring-user-access">configuring user access</a></p>
2026-02-28 15:54:09 +01:00
</li><li>
<p><a href="#additional-users">Additional users</a></p>
2026-02-14 21:29:11 +01:00
</li></ul>
2026-02-13 19:30:20 +01:00
</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="#puppetdb">PuppetDB</a></p>
</li><li>
<p><a href="#selinux">SELINUX</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>
<p>Nagios is a powerful open source software solution for monitoring your IT environments.</p>
<p><code>confdroid_nagios</code> is a Puppet module allowing to fully automate the setup &amp; configuration of the Nagios server, as well as actively adding client hosts and services to the monitoring environment through defines and <code>PuppetDB</code>.</p>
2026-02-21 13:19:42 +01:00
<p>At this stage, the module is being redeveloped and being built to the latest standards for Puppet 8.</p>
2026-02-13 19:30:20 +01:00
<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>
<ul><li>
<p>if FQDN equals the specified <code>ng_nagios_server</code>, nagios server with all required specs is installed, else only nagios client packages and the target specs</p>
</li><li>
2026-02-19 16:50:31 +01:00
<p>an additional directory /etc/nagios/conf.d is created to place the custom checks etc. without being overwritten by updates.</p>
</li><li>
2026-02-21 13:45:51 +01:00
<p>configures all required directories for server and clients and sets proper permissions and selinux contexts</p>
2026-02-21 14:05:20 +01:00
</li><li>
<p>configures the main nagios configuration file and sets values as (pre)configured per values in params, which can be overwritten.</p>
</li><li>
<p>if <code>ng_include_nrpe</code>is set to <code>true</code>, the confdroid_nrpe module is automatically applied on clients (<a href="https://sourcecode.confdroid.com/confdroid/confdroid_nrpe">confdroid_nrpe</a> must be in the catalogue then)</p>
2026-02-13 19:30:20 +01:00
</li></ul>
2026-02-14 21:29:11 +01:00
<h3 id="label-configuring+user+access">configuring user access</h3>
2026-02-28 15:54:09 +01:00
<p>Main access to the user interface requires defining an administrative user and password via <code>ng_main_user</code> and <code>ng_main_password</code>. The password should be encrypted like this:</p>
<pre class="code ruby"><code class="ruby">htpasswd -B -n testuser
New password:
Re-type new password:
</code></pre>
<p>This results in</p>
<pre class="code ruby"><code class="ruby">testuser: $2y$05$rNy/P22OfYZlpdEPnCAIg.OUizRD34P7pDRwUGiaYjH44PcRuZ2ia
</code></pre>
<p>Use that value to override the default password in ENC or Hiera, if you use it.</p>
<h3 id="label-Additional+users">Additional users</h3>
<p>The main user is automatically created. If you want to add more users, this should be done via the define confdroid_nagios::server::access. In your control repo, site.pp etc. address the access define like this:</p>
<pre class="code ruby"><code class="ruby">confdroid_nagios::server::access { &#39;example&#39;:
ng_htpasswd_user =&gt; &#39;example_user&#39;,
ng_htpasswd_password =&gt; &#39;example_password_encrypted&#39;
}
</code></pre>
2026-02-14 21:29:11 +01:00
2026-02-13 19:30:20 +01:00
<h2 id="label-Repo+Documentation">Repo 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>
2026-03-01 14:22:56 +01:00
<ul><li>
<p><code>puppetlabs-firewall</code></p>
</li><li>
<p><code>puppetlabs-stdlib</code></p>
</li><li>
<p><code>puppetlabs-concat</code></p>
</li><li>
<p><code>puppetlabs-nagios_core</code></p>
</li></ul>
2026-02-13 19:30:20 +01:00
<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 confdroid_nagios
}
</code></pre>
<ul><li>
<p>through Foreman:</p>
</li></ul>
<p>In order to apply parameters through Foreman, *<strong><em>confdroid_nagios::params</em></strong>- 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-PuppetDB">PuppetDB</h2>
<p>A working instance of PuppetDB connected to the Puppet master is required for this to work. Installation and configuration of PuppetDB is out of scope for this module, however <a href="https://gitlab.confdroid.com/puppet/cd_puppetdb">cd_puppetdb</a> is available to automate this task for you as well within a few minutes.</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-Support">Support</h2>
<ul><li>
<p>OS: Rocky 9</p>
</li><li>
<p>Puppet 7 # Puppet does not support Nagios in Puppet 8 anymore, although it still works</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>
<ul><li>
<p><a href="https://confdroid.com/contact/">contact Us</a></p>
</li><li>
<p><a href="https://feedback.confdroid.com/">Feedback Portal</a></p>
</li></ul>
<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>