2017-07-07 17:18:31 +02:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="UTF-8">
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
|
<title>
|
|
|
|
|
File: README
|
|
|
|
|
|
2018-08-26 16:59:39 +02:00
|
|
|
— Documentation by YARD 0.9.16
|
2017-07-07 17:18:31 +02:00
|
|
|
|
|
|
|
|
</title>
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" charset="utf-8">
|
|
|
|
|
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> »
|
|
|
|
|
<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'>
|
2021-08-05 16:41:08 +02:00
|
|
|
<h1 id="label-README">README</h1>
|
|
|
|
|
|
2020-12-01 18:06:22 +01:00
|
|
|
<p><a href="https://pipelines.confdroid.com/job/cd_apache/"><img
|
2021-08-05 16:41:08 +02:00
|
|
|
src="https://pipelines.confdroid.com/buildStatus/icon?job=cd_apache"></a>|</p>
|
|
|
|
|
|
|
|
|
|
<p>[[<em>TOC</em>]]</p>
|
2017-07-07 17:18:31 +02:00
|
|
|
|
2021-08-05 16:41:08 +02:00
|
|
|
<h2 id="label-Synopsis">Synopsis</h2>
|
2017-07-07 17:18:31 +02:00
|
|
|
|
|
|
|
|
<p><code>Apache httpd</code> is a very powerful and widely used web server.</p>
|
|
|
|
|
|
|
|
|
|
<p><code>cd_apache</code> automates the installation and configuration of
|
2017-07-09 17:24:08 +02:00
|
|
|
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.</p>
|
2017-07-07 17:18:31 +02:00
|
|
|
|
2021-08-05 16:41:08 +02:00
|
|
|
<h2 id="label-WARNING">WARNING</h2>
|
2017-07-07 17:18:31 +02:00
|
|
|
|
|
|
|
|
<p><code>**__!!! Attention: Never use this puppet module on systems which have
|
|
|
|
|
been previously configured manually. It is impossible to predict how and
|
2021-09-10 12:41:08 +02:00
|
|
|
what would have been configured, hence previous configurations outside the
|
2017-07-07 17:18:31 +02:00
|
|
|
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!!! __**</code></p>
|
|
|
|
|
|
2021-08-05 16:41:08 +02:00
|
|
|
<h2 id="label-Features">Features</h2>
|
|
|
|
|
|
|
|
|
|
<p>Installation</p>
|
2017-07-07 17:18:31 +02:00
|
|
|
<ul><li>
|
2021-08-05 16:41:08 +02:00
|
|
|
<p>install required binaries and dependencies</p>
|
|
|
|
|
</li></ul>
|
|
|
|
|
|
|
|
|
|
<p>Configuration</p>
|
|
|
|
|
<ul><li>
|
|
|
|
|
<p>manage user settings (optional)</p>
|
2017-07-07 17:18:31 +02:00
|
|
|
</li><li>
|
2021-08-05 16:41:08 +02:00
|
|
|
<p>manage directory structure (optional)</p>
|
2017-07-07 17:18:31 +02:00
|
|
|
</li><li>
|
2021-08-05 16:41:08 +02:00
|
|
|
<p>manage configuration files (optional):</p>
|
2017-07-07 17:18:31 +02:00
|
|
|
</li><li>
|
2021-08-05 16:41:08 +02:00
|
|
|
<p>file system permissions</p>
|
2017-07-07 17:18:31 +02:00
|
|
|
</li><li>
|
2021-08-05 16:41:08 +02:00
|
|
|
<p>selinux context</p>
|
2017-07-07 17:18:31 +02:00
|
|
|
</li><li>
|
2021-08-05 16:41:08 +02:00
|
|
|
<p>manage firewall settings (optional)</p>
|
2017-07-07 17:18:31 +02:00
|
|
|
</li><li>
|
2021-08-05 16:41:08 +02:00
|
|
|
<p>manage nagios monitoring (optional)</p>
|
2017-07-07 17:18:31 +02:00
|
|
|
</li></ul>
|
|
|
|
|
|
2021-08-05 16:41:08 +02:00
|
|
|
<p>Maintenance</p>
|
|
|
|
|
<ul><li>
|
|
|
|
|
<p>manage the service</p>
|
|
|
|
|
</li></ul>
|
2017-07-07 17:18:31 +02:00
|
|
|
|
2021-08-05 16:41:08 +02:00
|
|
|
<h3 id="label-vHosts">vHosts</h3>
|
2017-07-09 17:24:08 +02:00
|
|
|
|
2021-08-05 16:41:08 +02:00
|
|
|
<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>
|
2017-07-09 17:24:08 +02:00
|
|
|
<ul><li>
|
2021-08-05 16:41:08 +02:00
|
|
|
<p>front-end proxy for other applications to avoid having to put the port
|
2017-07-09 17:24:08 +02:00
|
|
|
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>cd_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
|
2021-08-05 16:41:08 +02:00
|
|
|
create a define for vHosts, i.e. using the example parameters, and simply
|
2017-07-09 17:24:08 +02:00
|
|
|
add <code>cd_apache</code> as requirement (i.e. require cd_apache) so it
|
|
|
|
|
gets installed automatically.</p>
|
|
|
|
|
|
2017-07-07 17:18:31 +02:00
|
|
|
<h3 id="label-Dependencies">Dependencies</h3>
|
|
|
|
|
|
|
|
|
|
<p>All dependencies must be included in the catalogue.</p>
|
|
|
|
|
<ul><li>
|
|
|
|
|
<p><a
|
2021-09-10 12:01:57 +02:00
|
|
|
href="https://sourcecode.confdroid.com/12WW1160/cd_resources">cd_resources</a></p>
|
2017-07-07 17:18:31 +02:00
|
|
|
</li></ul>
|
|
|
|
|
|
2021-08-05 16:41:08 +02:00
|
|
|
<h2 id="label-Deployment">Deployment</h2>
|
|
|
|
|
<ul><li>
|
|
|
|
|
<p>native Puppet deployment</p>
|
|
|
|
|
</li></ul>
|
2017-07-07 17:18:31 +02:00
|
|
|
|
|
|
|
|
<p>via site.pp or nodes.pp</p>
|
|
|
|
|
|
|
|
|
|
<pre class="code ruby"><code class="ruby">node 'example.example.net' {
|
|
|
|
|
include cd_puppetdb
|
|
|
|
|
}</code></pre>
|
2021-08-05 16:41:08 +02:00
|
|
|
<ul><li>
|
|
|
|
|
<p>through Foreman:</p>
|
|
|
|
|
</li></ul>
|
2017-07-07 17:18:31 +02:00
|
|
|
|
|
|
|
|
<p>In order to apply parameters through Foreman,
|
2021-08-05 16:41:08 +02:00
|
|
|
<strong>cd_apache::params</strong> must be added to the host or host group
|
2017-07-07 17:18:31 +02:00
|
|
|
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>
|
|
|
|
|
|
2021-08-05 16:41:08 +02:00
|
|
|
<h2 id="label-Parameters">Parameters</h2>
|
2017-07-07 17:18:31 +02:00
|
|
|
|
2021-08-05 16:41:08 +02:00
|
|
|
<p>The parameters are documented via puppet strings and <a
|
|
|
|
|
href="/docs/index.html">listed here</a>. Simply open in web browser.</p>
|
2017-07-07 17:18:31 +02:00
|
|
|
|
2021-08-05 16:41:08 +02:00
|
|
|
<h2 id="label-SELINUX">SELINUX</h2>
|
2017-07-07 17:18:31 +02:00
|
|
|
|
|
|
|
|
<p>All files and directories are configured with correct selinux context. If
|
|
|
|
|
selinux is disabled, these contexts are ignored.</p>
|
|
|
|
|
|
2021-08-05 16:41:08 +02:00
|
|
|
<h2 id="label-Support">Support</h2>
|
2017-07-07 17:18:31 +02:00
|
|
|
<ul><li>
|
2018-08-26 16:59:39 +02:00
|
|
|
<p>OS: CentOS 7</p>
|
|
|
|
|
</li><li>
|
|
|
|
|
<p>Puppet 5</p>
|
2017-07-07 17:18:31 +02:00
|
|
|
</li></ul>
|
|
|
|
|
|
2021-08-05 16:41:08 +02:00
|
|
|
<h2 id="label-Tests">Tests</h2>
|
2017-07-07 17:18:31 +02:00
|
|
|
<ul><li>
|
|
|
|
|
<p>Puppet Lint</p>
|
|
|
|
|
</li><li>
|
|
|
|
|
<p>excluded tests:</p>
|
|
|
|
|
<ul><li>
|
2021-08-05 16:41:08 +02:00
|
|
|
<p><code>--no-class_inherits_from_params_class-check</code>:relevant only to
|
2017-07-07 17:18:31 +02:00
|
|
|
non-supported outdated puppet versions</p>
|
|
|
|
|
</li><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><li>
|
|
|
|
|
<p><code>--no-80chars-check</code>: it is not always possible to stay within
|
|
|
|
|
80 characters, although typically only occurring on the parameter vault
|
|
|
|
|
<code>params.pp</code>.</p>
|
|
|
|
|
</li><li>
|
|
|
|
|
<p><code>--no-arrow_alignment-check</code>: this check leads to actually not
|
|
|
|
|
having am easily readable arrow alignment, as this checks <code>per
|
|
|
|
|
block</code>, not per class.</p>
|
|
|
|
|
</li></ul>
|
|
|
|
|
</li><li>
|
|
|
|
|
<p>Puppet Parser</p>
|
|
|
|
|
</li><li>
|
|
|
|
|
<p>ERB Template Parser</p>
|
2017-07-11 18:32:16 +02:00
|
|
|
</li><li>
|
2017-07-11 19:01:52 +02:00
|
|
|
<p>Test for unwanted UTF8 files in the Puppet code (see tests/UTF_Files)</p>
|
2021-08-05 16:41:08 +02:00
|
|
|
</li><li>
|
|
|
|
|
<p>Markdown-lint</p>
|
|
|
|
|
</li><li>
|
|
|
|
|
<p>Spellcheck</p>
|
|
|
|
|
</li><li>
|
|
|
|
|
<p>Sonar Quality Gate</p>
|
2017-07-07 17:18:31 +02:00
|
|
|
</li></ul>
|
|
|
|
|
|
2021-08-05 16:41:08 +02:00
|
|
|
<h2 id="label-Contact+Us">Contact Us</h2>
|
2017-07-07 17:18:31 +02:00
|
|
|
|
|
|
|
|
<p><a href="https://confdroid.com/contact/">contact Us</a></p>
|
|
|
|
|
|
2021-08-05 16:41:08 +02:00
|
|
|
<h2 id="label-Disclaimer">Disclaimer</h2>
|
2017-07-07 17:18:31 +02:00
|
|
|
|
|
|
|
|
<p>ConfDroid as entity is entirely independent from Puppet. We provide custom
|
|
|
|
|
configuration modules, written for specific purposes and specific
|
2018-12-07 14:00:07 +01:00
|
|
|
environments. The modules are tested and supported only as documented, and
|
2017-07-07 17:18:31 +02:00
|
|
|
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">
|
2018-04-10 13:06:02 +02:00
|
|
|
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
|
2017-07-07 17:18:31 +02:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
