211 lines
7.4 KiB
HTML
211 lines
7.4 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_apache/"><img src="https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_apache"></a> <a href="https://sonarqube.confdroid.com/dashboard?id=confdroid_apache"><img src="https://sonarqube.confdroid.com/api/project_badges/measure?project=confdroid_apache&metric=security_hotspots&token=sqb_783a19acf8d97e87e5c570981a8e9019d40c4654"></a> <a href="https://sonarqube.confdroid.com/dashboard?id=confdroid_apache"><img src="https://sonarqube.confdroid.com/api/project_badges/quality_gate?project=confdroid_apache&token=sqb_783a19acf8d97e87e5c570981a8e9019d40c4654"></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>
|
||
<ul><li>
|
||
<p><a href="#vhosts">vHosts</a></p>
|
||
</li><li>
|
||
<p><a href="#dependencies">Dependencies</a></p>
|
||
</li></ul>
|
||
</li><li>
|
||
<p><a href="#deployment">Deployment</a></p>
|
||
</li><li>
|
||
<p><a href="#parameters">Parameters</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><code>Apache httpd</code> is a very powerful and widely used web server.</p>
|
||
|
||
<p><code>confdroid_apache</code> automates the installation and configuration of httpd. This module is a base module simply providing the httpd service itself to be used by other role- or profile modules, adding more detailed configurations specific to the particular use case, like for instance Wordpress.</p>
|
||
|
||
<h2 id="label-WARNING">WARNING</h2>
|
||
|
||
<p>—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—</p>
|
||
|
||
<h2 id="label-Features">Features</h2>
|
||
|
||
<p>Installation</p>
|
||
<ul><li>
|
||
<p>install required binaries and dependencies</p>
|
||
</li></ul>
|
||
|
||
<p>Configuration</p>
|
||
<ul><li>
|
||
<p>manage directory structure (optional)</p>
|
||
</li><li>
|
||
<p>manage configuration files (optional):</p>
|
||
</li><li>
|
||
<p>file system permissions</p>
|
||
</li><li>
|
||
<p>selinux context</p>
|
||
</li><li>
|
||
<p>manage firewall settings (optional)</p>
|
||
</li><li>
|
||
<p>manage nagios monitoring (optional)</p>
|
||
</li></ul>
|
||
|
||
<p>Maintenance</p>
|
||
<ul><li>
|
||
<p>manage the service</p>
|
||
</li></ul>
|
||
|
||
<h3 id="label-vHosts">vHosts</h3>
|
||
|
||
<p>As stated in the synopsis, this module was written particularly for usage as base module. <code>Apache httpd</code> has a great number of use cases where it actually is not used directly as full-blown web server by itself, but instead as platform for other applications. Examples here would be:</p>
|
||
<ul><li>
|
||
<p>front-end proxy for other applications to avoid having to put the port number into the URL</p>
|
||
</li><li>
|
||
<p>applications like phpMyAdmin, phpPgAdmin</p>
|
||
</li><li>
|
||
<p>WordPress</p>
|
||
</li><li>
|
||
<p>Nagios etc.</p>
|
||
</li></ul>
|
||
|
||
<p>With those use cases, you would provide the vHosts at the Puppet module for the application, not the base module. Also, if you plan to use this module to run a plain fully fledged web server, you would use a role- or profile class/module on top of <code>confdroid_apache</code> to set up your vHost exactly as needed. Examples for regular basic vHost configuration files are included in the examples directory as parameterized .erb files. You would create a define for vHosts, i.e. using the example parameters, and simply add <code>confdroid_apache</code> as requirement (i.e. require confdroid_apache) so it gets installed automatically.</p>
|
||
|
||
<h3 id="label-Dependencies">Dependencies</h3>
|
||
|
||
<p>All listed 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 'example.example.net' {
|
||
include confdroid_apache
|
||
}
|
||
</code></pre>
|
||
<ul><li>
|
||
<p>through Foreman:</p>
|
||
</li></ul>
|
||
|
||
<p>In order to apply parameters through Foreman, –<em>confdroid_apache::params</em>– 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-Parameters">Parameters</h2>
|
||
|
||
<p>The parameters are documented via puppet strings and <a href="/docs/index.html">listed here</a>. Simply open in web browser.</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 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>Test for unwanted UTF8 files in the Puppet code (see tests/UTF_Files)</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> <a href="https://feedback.confdroid.com/">Feedback Portal</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.</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> |