Merge branch 'master' of sourcecode.confdroid.com:12ww1160/cd_apache into HEAD

This commit is contained in:
2021-09-10 13:44:00 +02:00
5 changed files with 138 additions and 194 deletions

0
.scannerwork/.sonar_lock Normal file
View File

View File

View File

@@ -0,0 +1,6 @@
projectKey=cd_apache
serverUrl=http://sonarqube.confdroid.com
serverVersion=7.9.1.27448
dashboardUrl=http://sonarqube.confdroid.com/dashboard?id=cd_apache
ceTaskId=AXvPS-uq1C1yMMr1H4D-
ceTaskUrl=http://sonarqube.confdroid.com/api/ce/task?id=AXvPS-uq1C1yMMr1H4D-

View File

@@ -58,11 +58,14 @@
</div>
<div id="content"><div id='filecontents'>
<p>|Repo Name| version | Build Status| |—|—|—|—| |<code>cd_apache</code>|
1.1.2.8 | <a href="https://pipelines.confdroid.com/job/cd_apache/"><img
<h1 id="label-README">README</h1>
<p><a href="https://pipelines.confdroid.com/job/cd_apache/"><img
src="https://pipelines.confdroid.com/buildStatus/icon?job=cd_apache"></a>|</p>
<h3 id="label-Synopsis">Synopsis</h3>
<p>[[<em>TOC</em>]]</p>
<h2 id="label-Synopsis">Synopsis</h2>
<p><code>Apache httpd</code> is a very powerful and widely used web server.</p>
@@ -71,69 +74,53 @@ 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>
<h3 id="label-WARNING">WARNING</h3>
<h2 id="label-WARNING">WARNING</h2>
<p><code>**__!!! 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 previuos configurations outside the
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!!! __**</code></p>
<h3 id="label-Table+of+Contents">Table of Contents</h3>
<h2 id="label-Features">Features</h2>
<p>Installation</p>
<ul><li>
<p><a href="#label-Features">Features</a></p>
</li><li>
<p><a href="#label-Repo+structure">Repo Structure</a></p>
</li><li>
<p><a href="#label-Dependencies">Dependencies</a></p>
</li><li>
<p><a href="#label-Deployment">Deployment</a></p>
</li><li>
<p><a href="#label-Native+puppet+deployment">native Puppet deployment</a></p>
</li><li>
<p><a href="#label-Through+foreman">through Foreman</a></p>
</li><li>
<p><a href="#label-Parameters">Parameters</a></p>
</li><li>
<p><a href="#label-Mandatory+parameters">Mandatory Parameters</a></p>
</li><li>
<p><a href="#label-Optional+parameters">Optional Parameters</a></p>
</li><li>
<p><a href="#label-Selinux">SELINUX</a></p>
</li><li>
<p><a href="#label-Known+problems">Known Problems</a></p>
</li><li>
<p><a href="#label-Support">Support</a></p>
</li><li>
<p><a href="#label-Tests">Tests</a></p>
</li><li>
<p><a
href="https://gitlab.confdroid.com/12WW1160/cd_apache/blob/master/CHANGELOG.md#changelog">Changelog</a></p>
</li><li>
<p><a href="https://confdroid.com/contact/">Contact Us</a></p>
</li><li>
<p><a href="#label-Disclaimer">Disclaimer</a></p>
<p>install required binaries and dependencies</p>
</li></ul>
<h3 id="label-Features">Features</h3>
<p>Installation * install required binaries and dependencies</p>
<p>Configuration * manage user settings (optional) * manage directory
structure (optional) * manage configuration files (optional): * file
system permissions * selinux context * manage firewall settings (optional)
* manage nagios monitoring (optional) Maintenance * manage the service</p>
<h4 id="label-vHosts">vHosts</h4>
<p>As stated in the ynopsis, this module was written particularly for usage as
base module. <code>Apache httpd</code> has a great number of usae cases
where it actually is not used directly as full blown webser, but instead as
&#39;sub-service&#39;. Examples here would be</p>
<p>Configuration</p>
<ul><li>
<p>frontend proxy for other applications to avoid having to put the port
<p>manage user settings (optional)</p>
</li><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>
@@ -149,88 +136,64 @@ 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
create a define for vhosts, i.e. using the example parameters, and simply
create a define for vHosts, i.e. using the example parameters, and simply
add <code>cd_apache</code> as requirement (i.e. require cd_apache) so it
gets installed automatically.</p>
<h3 id="label-Repo+Structure">Repo Structure</h3>
<p>Repostructure as been moved to REPOSTRUCTURE.md</p>
<h3 id="label-Dependencies">Dependencies</h3>
<p>All dependencies must be included in the catalogue.</p>
<ul><li>
<p><a
href="https://gitlab.confdroid.com/12WW1160/cd_resources">cd_resources</a></p>
href="https://sourcecode.confdroid.com/12WW1160/cd_resources">cd_resources</a></p>
</li></ul>
<h3 id="label-Deployment">Deployment</h3>
<h5 id="label-native+Puppet+deployment">native Puppet deployment</h5>
<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_puppetdb
}</code></pre>
<h4 id="label-through+Foreman-3A">through Foreman:</h4>
<ul><li>
<p>through Foreman:</p>
</li></ul>
<p>In order to apply parameters through Foreman,
<strong>cd_apache::params</strong> must be added to the host or hostgroup
<strong>cd_apache::params</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>
<h3 id="label-Parameters">Parameters</h3>
<h2 id="label-Parameters">Parameters</h2>
<p>The following parameters are editable via params.pp or through ENC
(<strong>recommended</strong>). Values changed will take immediate effect
at next puppet run. Services will be restarted where neccessary.</p>
<p>The parameters are documented via puppet strings and <a
href="/docs/index.html">listed here</a>. Simply open in web browser.</p>
<h4 id="label-Mandatory+Parameters">Mandatory Parameters</h4>
<h4 id="label-Optional+Parameters">Optional Parameters</h4>
<ul><li>
<p><code>$ae_manage_user</code> : Whether or not to manage the user settings.
Important when accessing shared resources accross nodes. Defaults to
<code>false</code>.</p>
</li><li>
<p><code>$ae_manage_cfg</code> : Whether or not to manage the apache
configuration. Defaults to <code>false</code> as this module is meant to be
used through profiles or roles or other modules.</p>
</li><li>
<p><code>$ae_manage_dirs</code> : Whether or not to manage the directory
structure. Defaults to <code>true</code>.</p>
</li><li>
<p><code>$ae_allow_user_dirs</code> : Whether or not to allow presenting
content from end user home directories. Defaults to <code>false</code>.</p>
</li></ul>
<h3 id="label-SELINUX">SELINUX</h3>
<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>
<h3 id="label-Known+Problems">Known Problems</h3>
<h3 id="label-Support">Support</h3>
<h2 id="label-Support">Support</h2>
<ul><li>
<p>OS: CentOS 7</p>
</li><li>
<p>Puppet 5</p>
</li></ul>
<h3 id="label-Tests">Tests</h3>
<h2 id="label-Tests">Tests</h2>
<ul><li>
<p>Puppet Lint</p>
</li><li>
<p>excluded tests:</p>
<ul><li>
<p><code>--no-class_inherits_from_params_class-check</code>:relavant only to
<p><code>--no-class_inherits_from_params_class-check</code>:relevant only to
non-supported outdated puppet versions</p>
</li><li>
<p><code>--no-variable_scope-check</code>: not applicable as we are inheriting
@@ -251,13 +214,19 @@ block</code>, not per class.</p>
<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>Markdown-lint</p>
</li><li>
<p>Spellcheck</p>
</li><li>
<p>Sonar Quality Gate</p>
</li></ul>
<h3 id="label-Contact+Us">Contact Us</h3>
<h2 id="label-Contact+Us">Contact Us</h2>
<p><a href="https://confdroid.com/contact/">contact Us</a></p>
<h3 id="label-Disclaimer">Disclaimer</h3>
<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

View File

@@ -58,11 +58,14 @@
</div>
<div id="content"><div id='filecontents'>
<p>|Repo Name| version | Build Status| |—|—|—|—| |<code>cd_apache</code>|
1.1.2.8 | <a href="https://pipelines.confdroid.com/job/cd_apache/"><img
<h1 id="label-README">README</h1>
<p><a href="https://pipelines.confdroid.com/job/cd_apache/"><img
src="https://pipelines.confdroid.com/buildStatus/icon?job=cd_apache"></a>|</p>
<h3 id="label-Synopsis">Synopsis</h3>
<p>[[<em>TOC</em>]]</p>
<h2 id="label-Synopsis">Synopsis</h2>
<p><code>Apache httpd</code> is a very powerful and widely used web server.</p>
@@ -71,69 +74,53 @@ 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>
<h3 id="label-WARNING">WARNING</h3>
<h2 id="label-WARNING">WARNING</h2>
<p><code>**__!!! 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 previuos configurations outside the
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!!! __**</code></p>
<h3 id="label-Table+of+Contents">Table of Contents</h3>
<h2 id="label-Features">Features</h2>
<p>Installation</p>
<ul><li>
<p><a href="#label-Features">Features</a></p>
</li><li>
<p><a href="#label-Repo+structure">Repo Structure</a></p>
</li><li>
<p><a href="#label-Dependencies">Dependencies</a></p>
</li><li>
<p><a href="#label-Deployment">Deployment</a></p>
</li><li>
<p><a href="#label-Native+puppet+deployment">native Puppet deployment</a></p>
</li><li>
<p><a href="#label-Through+foreman">through Foreman</a></p>
</li><li>
<p><a href="#label-Parameters">Parameters</a></p>
</li><li>
<p><a href="#label-Mandatory+parameters">Mandatory Parameters</a></p>
</li><li>
<p><a href="#label-Optional+parameters">Optional Parameters</a></p>
</li><li>
<p><a href="#label-Selinux">SELINUX</a></p>
</li><li>
<p><a href="#label-Known+problems">Known Problems</a></p>
</li><li>
<p><a href="#label-Support">Support</a></p>
</li><li>
<p><a href="#label-Tests">Tests</a></p>
</li><li>
<p><a
href="https://gitlab.confdroid.com/12WW1160/cd_apache/blob/master/CHANGELOG.md#changelog">Changelog</a></p>
</li><li>
<p><a href="https://confdroid.com/contact/">Contact Us</a></p>
</li><li>
<p><a href="#label-Disclaimer">Disclaimer</a></p>
<p>install required binaries and dependencies</p>
</li></ul>
<h3 id="label-Features">Features</h3>
<p>Installation * install required binaries and dependencies</p>
<p>Configuration * manage user settings (optional) * manage directory
structure (optional) * manage configuration files (optional): * file
system permissions * selinux context * manage firewall settings (optional)
* manage nagios monitoring (optional) Maintenance * manage the service</p>
<h4 id="label-vHosts">vHosts</h4>
<p>As stated in the ynopsis, this module was written particularly for usage as
base module. <code>Apache httpd</code> has a great number of usae cases
where it actually is not used directly as full blown webser, but instead as
&#39;sub-service&#39;. Examples here would be</p>
<p>Configuration</p>
<ul><li>
<p>frontend proxy for other applications to avoid having to put the port
<p>manage user settings (optional)</p>
</li><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>
@@ -149,88 +136,64 @@ 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
create a define for vhosts, i.e. using the example parameters, and simply
create a define for vHosts, i.e. using the example parameters, and simply
add <code>cd_apache</code> as requirement (i.e. require cd_apache) so it
gets installed automatically.</p>
<h3 id="label-Repo+Structure">Repo Structure</h3>
<p>Repostructure as been moved to REPOSTRUCTURE.md</p>
<h3 id="label-Dependencies">Dependencies</h3>
<p>All dependencies must be included in the catalogue.</p>
<ul><li>
<p><a
href="https://gitlab.confdroid.com/12WW1160/cd_resources">cd_resources</a></p>
href="https://sourcecode.confdroid.com/12WW1160/cd_resources">cd_resources</a></p>
</li></ul>
<h3 id="label-Deployment">Deployment</h3>
<h5 id="label-native+Puppet+deployment">native Puppet deployment</h5>
<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_puppetdb
}</code></pre>
<h4 id="label-through+Foreman-3A">through Foreman:</h4>
<ul><li>
<p>through Foreman:</p>
</li></ul>
<p>In order to apply parameters through Foreman,
<strong>cd_apache::params</strong> must be added to the host or hostgroup
<strong>cd_apache::params</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>
<h3 id="label-Parameters">Parameters</h3>
<h2 id="label-Parameters">Parameters</h2>
<p>The following parameters are editable via params.pp or through ENC
(<strong>recommended</strong>). Values changed will take immediate effect
at next puppet run. Services will be restarted where neccessary.</p>
<p>The parameters are documented via puppet strings and <a
href="/docs/index.html">listed here</a>. Simply open in web browser.</p>
<h4 id="label-Mandatory+Parameters">Mandatory Parameters</h4>
<h4 id="label-Optional+Parameters">Optional Parameters</h4>
<ul><li>
<p><code>$ae_manage_user</code> : Whether or not to manage the user settings.
Important when accessing shared resources accross nodes. Defaults to
<code>false</code>.</p>
</li><li>
<p><code>$ae_manage_cfg</code> : Whether or not to manage the apache
configuration. Defaults to <code>false</code> as this module is meant to be
used through profiles or roles or other modules.</p>
</li><li>
<p><code>$ae_manage_dirs</code> : Whether or not to manage the directory
structure. Defaults to <code>true</code>.</p>
</li><li>
<p><code>$ae_allow_user_dirs</code> : Whether or not to allow presenting
content from end user home directories. Defaults to <code>false</code>.</p>
</li></ul>
<h3 id="label-SELINUX">SELINUX</h3>
<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>
<h3 id="label-Known+Problems">Known Problems</h3>
<h3 id="label-Support">Support</h3>
<h2 id="label-Support">Support</h2>
<ul><li>
<p>OS: CentOS 7</p>
</li><li>
<p>Puppet 5</p>
</li></ul>
<h3 id="label-Tests">Tests</h3>
<h2 id="label-Tests">Tests</h2>
<ul><li>
<p>Puppet Lint</p>
</li><li>
<p>excluded tests:</p>
<ul><li>
<p><code>--no-class_inherits_from_params_class-check</code>:relavant only to
<p><code>--no-class_inherits_from_params_class-check</code>:relevant only to
non-supported outdated puppet versions</p>
</li><li>
<p><code>--no-variable_scope-check</code>: not applicable as we are inheriting
@@ -251,13 +214,19 @@ block</code>, not per class.</p>
<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>Markdown-lint</p>
</li><li>
<p>Spellcheck</p>
</li><li>
<p>Sonar Quality Gate</p>
</li></ul>
<h3 id="label-Contact+Us">Contact Us</h3>
<h2 id="label-Contact+Us">Contact Us</h2>
<p><a href="https://confdroid.com/contact/">contact Us</a></p>
<h3 id="label-Disclaimer">Disclaimer</h3>
<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