205 lines
6.6 KiB
HTML
205 lines
6.6 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>
|
|
File: README
|
|
|
|
— 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> »
|
|
<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/confdroid_ntp/"><img src="https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_ntp&style=plastic"></a></p>
|
|
|
|
<p><a href="https://deepwiki.com/grizzlycoda/puppet_collection"><img src="https://deepwiki.com/badge.svg"></a></p>
|
|
<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>
|
|
</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>
|
|
|
|
<p>Time management in Linux is important. The underlying protocol is ntp, the service nowadays is chrony.</p>
|
|
|
|
<p><code>confdroid_ntp</code> is a Puppet module to automate installation and configuration of chrony.</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>This module differentiates between client- and server configuration. If the <code>FQDN</code> of the puppet client matches the value of <code>cy_server_fqdn</code>, it assumes this to be an ntp time server, else it will be a client.</p>
|
|
|
|
<p>If you have no local time server(s), leave <code>cy_use_lan_server</code> at <code>false</code> (default), else set it to <code>true</code>. This affects only client configurations.</p>
|
|
|
|
<p>The value for <code>cy_server_fqdn</code> is a string rather array, assuming either a single time server or a round-robin DNS CNAME entry returning several values for the time server (not configured by this module).</p>
|
|
|
|
<p>INSTALLATION</p>
|
|
<ul><li>
|
|
<p>installs chrony binaries</p>
|
|
</li></ul>
|
|
|
|
<p>CONFIGURATION</p>
|
|
<ul><li>
|
|
<p>manage directories including selinux contexts</p>
|
|
</li><li>
|
|
<p>and files and their templates including selinux contexts</p>
|
|
</li><li>
|
|
<p>manage service</p>
|
|
</li><li>
|
|
<p>optional: include nagios target for the chrony service (set <code>cy_manage_nagios</code>to <code>true</code>)</p>
|
|
</li></ul>
|
|
|
|
<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>
|
|
<ul><li>
|
|
<p><a href="https://sourcecode.confdroid.com/confdroid/confdroid_nagios">confdroid_nagios</a> if nagios monitoring is desired</p>
|
|
</li></ul>
|
|
|
|
<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 'example.example.net' {
|
|
include confdroid_ntp
|
|
}
|
|
</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>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> |