confdroid/confdroid_apache
3
0
Fork 0
Code Issues Projects Wiki Activity
Files
ff758351baaf2af503af1948dfc304d601c54c1e
confdroid_apache/doc/puppet_classes/cd_apache_3A_3Aparams.html

535 lines
12 KiB
HTML
Raw Normal View History

recommit for updates in build 1
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>
Puppet Class: cd_apache::params
&mdash; Documentation by YARD 0.9.9
</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 = "puppet_classes::cd_apache::params";
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 (c)</a> &raquo;
<span class='title'><span class='object_link'>Puppet Classes</span></span>
&raquo;
<span class="title">cd_apache::params</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"><h1>Puppet Class: cd_apache::params</h1>
<div class="box_info">
<dl>
<dt>Inherited by:</dt>
<dd>
<span class='object_link'><a href="cd_apache_3A_3Amain_3A_3Aconfig.html" title="puppet_classes::cd_apache::main::config (puppet_class)">cd_apache::main::config</a></span><br/>
<span class='object_link'><a href="cd_apache_3A_3Aserver_3A_3Adirs.html" title="puppet_classes::cd_apache::server::dirs (puppet_class)">cd_apache::server::dirs</a></span><br/>
<span class='object_link'><a href="cd_apache_3A_3Aserver_3A_3Auser.html" title="puppet_classes::cd_apache::server::user (puppet_class)">cd_apache::server::user</a></span><br/>
<span class='object_link'><a href="cd_apache_3A_3Aserver_3A_3Afiles.html" title="puppet_classes::cd_apache::server::files (puppet_class)">cd_apache::server::files</a></span><br/>
<span class='object_link'><a href="cd_apache_3A_3Aserver_3A_3Ainstall.html" title="puppet_classes::cd_apache::server::install (puppet_class)">cd_apache::server::install</a></span><br/>
<span class='object_link'><a href="cd_apache_3A_3Aserver_3A_3Aservice.html" title="puppet_classes::cd_apache::server::service (puppet_class)">cd_apache::server::service</a></span><br/>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>
manifests/params.pp
</dd>
</dl>
</div>
<h2>Summary</h2>
This class holds all parameters for the cd_apache module, which are
inherited by all classes except defines.
<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
<p>cd_apache::params.pp
Module name: cd_apache
Author: Arne Teuke
(arne_teuke@confdroid.com)
License:
This file is part of cd_apache.</p>
<p>cd_apache is used for providing automatic configuration of
Apache
Webserver.
Copyright (C) 2014 confdroid (copyright@confdroid.com)
This
program is free software: you can redistribute it and/or modify
it under
the terms of the GNU General Public License as published by
the Free
Software Foundation, either version 3 of the License, or
(at your option)
any later version.</p>
<p>This program is distributed in the hope that it will be useful,
but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License
for more details.</p>
<p>You should have received a copy of the GNU General Public License
along
with this program. If not, see <a
href="http://www.gnu.org/licenses">www.gnu.org/licenses</a>/.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>pkg_ensure</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;latest&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Specify which
<a
href="https://confdroid.com/2017/05/puppet-type-package/">package
type</a>
to use, i.e. <code>latest</code>, <code>present</code> or
<code>absent</code>.</p>
</div>
</li>
<li>
<span class='name'>ae_manage_user</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether or not to manage details for the
httpd service user. This is
generally only required when using httpd on
a number of servers sharing
storage resources, i.e. NFS, where UID and GID
settings must be same
accross all nodes.</p>
</div>
</li>
<li>
<span class='name'>ae_user_name</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;apache&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Specify the user name for the httpd user.
only active if
<code>ae_manage_user</code> is set to true.</p>
</div>
</li>
<li>
<span class='name'>ae_user_uid</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;48&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Specify the UID for teh httpd service user.
only active if
<code>ae_manage_user</code> is set to true.</p>
</div>
</li>
<li>
<span class='name'>ae_u_comment</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;Apache&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Specify the user comment for /etc/passwd.
Shows up in email notofications
as sender informations.
only active if <code>ae_manage_user</code> is set
to true.</p>
</div>
</li>
<li>
<span class='name'>ae_u_groups</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>undef</tt>)</em>
&mdash;
<div class='inline'>
<p>Specify any secondary groups the httpd service
user shoould be in. Must not
contain teh primary group.
only active if <code>ae_manage_user</code> is
set to true.</p>
</div>
</li>
<li>
<span class='name'>ae_user_home</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/usr/share/httpd&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Specify the home of the httpd service user.
only active if
<code>ae_manage_user</code> is set to true.</p>
</div>
</li>
<li>
<span class='name'>ae_user_shell</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/bin/false&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Specify the shell for teh httpd service user,
which normally should not be
allowed to log in .
only active if <code>ae_manage_user</code> is set to
true.</p>
</div>
</li>
<li>
<span class='name'>ae_manage_cfg</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether or not to manage the httpd
configuration. httpd is very often a sub
system used by many other services,
and the required configuration depends
on the use case. If using httpd as
sub-service ( i.e. for phpmyadmin,
Nagios etc.), the main configuration
should be done on that end, not in
cd_apache. IN that case, set <code>ae_manage_cfg</code>
to
<code>false</code>.</p>
</div>
</li>
<li>
<span class='name'>ae_manage_dirs</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether or not main directories required
to run httpd should be managed.
Tyically this should be set to true.</p>
</div>
</li>
<li>
<span class='name'>ae_allow_user_dirs</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether or not to allow user directories
should be allowed to share content
through httpd. Usually this is a security
problem and as such should be
disabled.</p>
</div>
</li>
</ul>
</div><div class="method_details_list">
<table class="source_code">
<tr>
<td>
<pre class="lines">
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 58</span>
class cd_apache::params (
$pkg_ensure = &#39;latest&#39;,
$ae_manage_user = false,
$ae_user_name = &#39;apache&#39;,
$ae_user_uid = &#39;48&#39;,
$ae_u_comment = &#39;Apache&#39;,
$ae_u_groups = undef,
$ae_user_home = &#39;/usr/share/httpd&#39;,
$ae_user_shell = &#39;/bin/false&#39;,
# configuration files
$ae_manage_cfg = false,
$ae_manage_dirs = true,
$ae_allow_user_dirs = false,
) {
# installation section
$reqpackages = $::operatingsystem ? {
/(?i-mx:centos|fedora|redhat)/ =&gt; [&#39;httpd&#39;,&#39;mod_ssl&#39;],
}
# service
$ae_service = &#39;httpd&#39;
# directories
$ae_main_dir = &#39;/etc/httpd&#39;
$ae_conf_dir = &quot;${ae_main_dir}/conf&quot;
$ae_conf_d_dir = &quot;${ae_main_dir}/conf.d&quot;
$ae_conf_mods_d = &quot;${ae_main_dir}/conf.modules.d&quot;
$ae_var_logs_dir = &#39;/var/log/httpd&#39;
$ae_logs_dir = &quot;${ae_main_dir}/logs&quot;
$ae_usr_lib_dir = &#39;/usr/lib64/httpd&#39;
$ae_usr_mods_dir = &quot;${ae_usr_lib_dir}/modules&quot;
$ae_mods_dir = &quot;${ae_main_dir}/modules&quot;
$ae_run_dir = &#39;/run/httpd&#39;
$ae_run_link = &quot;${ae_main_dir}/run&quot;
$ae_share_httpd = &#39;/usr/share/httpd&#39;
$ae_cache_httpd = &#39;/var/cache/httpd&#39;
# files
$ae_conf_file = &quot;${ae_conf_dir}/httpd.conf&quot;
$ae_conf_file_erb = &#39;cd_apache/httpd_conf.erb&#39;
$ae_magic_file = &quot;${ae_conf_dir}/magic&quot;
$ae_magic_file_erb = &#39;cd_apache/magic.erb&#39;
$ae_ssl_file = &quot;${ae_conf_d_dir}/ssl.conf&quot;
$ae_ssl_file_erb = &#39;cd_apache/ssl_conf.erb&#39;
$ae_autoindex_file = &quot;${ae_conf_d_dir}/autoindex.conf&quot;
$ae_autoindex_erb = &#39;cd_apache/autoindex_conf.erb&#39;
$ae_userdir_file = &quot;${ae_conf_d_dir}/userdir.conf&quot;
$ae_userdir_erb = &#39;cd_apache/userdir_conf.erb&#39;
# includes must be last
include cd_apache::main::config
}</pre>
</td>
</tr>
</table>
</div>
</div>
<div id="footer">
Generated on Fri Jul 7 17:18:30 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.0.0).
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink