confdroid/confdroid_haproxy
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity
Files
1467a2d6a325f425e4eeb42dfe1e01c1e4ebabe5
confdroid_haproxy/doc/puppet_classes/confdroid_haproxy_3A_3Aparams.html

1097 lines
24 KiB
HTML
Raw Normal View History

Recommit for updates in build 2
2026-09-05 11:48:55 +02:00
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Puppet Class: confdroid_haproxy::params
&mdash; 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 = "puppet_classes::confdroid_haproxy::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">confdroid_haproxy::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: confdroid_haproxy::params</h1>
<div class="box_info">
<dl>
<dt>Inherited by:</dt>
<dd>
<span class='object_link'><a href="confdroid_haproxy_3A_3Amain_3A_3Adirs.html" title="puppet_classes::confdroid_haproxy::main::dirs (puppet_class)">confdroid_haproxy::main::dirs</a></span><br/>
<span class='object_link'><a href="confdroid_haproxy_3A_3Amain_3A_3Auser.html" title="puppet_classes::confdroid_haproxy::main::user (puppet_class)">confdroid_haproxy::main::user</a></span><br/>
<span class='object_link'><a href="confdroid_haproxy_3A_3Amain_3A_3Afiles.html" title="puppet_classes::confdroid_haproxy::main::files (puppet_class)">confdroid_haproxy::main::files</a></span><br/>
<span class='object_link'><a href="confdroid_haproxy_3A_3Amain_3A_3Aconfig.html" title="puppet_classes::confdroid_haproxy::main::config (puppet_class)">confdroid_haproxy::main::config</a></span><br/>
<span class='object_link'><a href="confdroid_haproxy_3A_3Amain_3A_3Ainstall.html" title="puppet_classes::confdroid_haproxy::main::install (puppet_class)">confdroid_haproxy::main::install</a></span><br/>
<span class='object_link'><a href="confdroid_haproxy_3A_3Aserver_3A_3Aservice.html" title="puppet_classes::confdroid_haproxy::server::service (puppet_class)">confdroid_haproxy::server::service</a></span><br/>
<span class='object_link'><a href="confdroid_haproxy_3A_3Afirewall_3A_3Aiptables.html" title="puppet_classes::confdroid_haproxy::firewall::iptables (puppet_class)">confdroid_haproxy::firewall::iptables</a></span><br/>
<span class='object_link'><a href="confdroid_haproxy_3A_3Amonitoring_3A_3Afail2ban.html" title="puppet_classes::confdroid_haproxy::monitoring::fail2ban (puppet_class)">confdroid_haproxy::monitoring::fail2ban</a></span><br/>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>
manifests/params.pp
</dd>
</dl>
</div>
<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
<p>confdroid_haproxy::params.pp Module name: confdroid_haproxy Author: Arne Teuke (arne_teuke@confdroid.com)</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>which <a href="https://confdroid.com/2017/05/puppet-type-package/">package type</a> to choose, i.e. <code>latest</code> or <code>present</code>.</p>
</div>
</li>
<li>
<span class='name'>reqpackages</span>
<span class='type'>(<tt>Array</tt>)</span>
<em class="default">(defaults to: <tt>[&#39;haproxy&#39;,&#39;httpd-tools&#39;]</tt>)</em>
&mdash;
<div class='inline'>
<p>specify the packages to be installed</p>
</div>
</li>
<li>
<span class='name'>hy_host_fqdn</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>undef</tt>)</em>
&mdash;
<div class='inline'>
<p>the fqdn of the ha proxy host. must be fqdn, not cname. specify multiple fqdns via array.</p>
</div>
</li>
<li>
<span class='name'>hy_manage_fw</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to manage the firewall.</p>
</div>
</li>
<li>
<span class='name'>hy_fw_order_no</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;50&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the rule number to control the order of the firewall rules.</p>
</div>
</li>
<li>
<span class='name'>hy_http_port</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;80&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the http port. used in firewall settings</p>
</div>
</li>
<li>
<span class='name'>hy_https_port</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;443&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the https port. used in firewall settings</p>
</div>
</li>
<li>
<span class='name'>hy_user_name</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;haproxy&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the name of the haproxy service user.</p>
</div>
</li>
<li>
<span class='name'>hy_user_comment</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;haproxy user&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the comment of the haproxy user, shows up in emails sent from haproxy.</p>
</div>
</li>
<li>
<span class='name'>hy_user_home</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/var/lib/haproxy&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the home directory for the haproxy user.</p>
</div>
</li>
<li>
<span class='name'>hy_user_shell</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/sbin/nologin&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the shell for the haproxy user.</p>
</div>
</li>
<li>
<span class='name'>hy_log_target</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;127.0.0.1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Where to send the logs for this haproxy. Currently only local logging / rsyslog forwarding supported.</p>
</div>
</li>
<li>
<span class='name'>hy_log_facility</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;local2&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>which logging facility to use.</p>
</div>
</li>
<li>
<span class='name'>hy_chroot</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/var/lib/haproxy&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>where the chroot should be</p>
</div>
</li>
<li>
<span class='name'>hy_pid</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/var/run/haproxy.pid&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the pid file to use.</p>
</div>
</li>
<li>
<span class='name'>hy_maxconn</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;4000&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>how many connections should we max allow.</p>
</div>
</li>
<li>
<span class='name'>hy_stats_socket</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/var/lib/haproxy/stats&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>name and path of the stats socket</p>
</div>
</li>
<li>
<span class='name'>hy_default_mode</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;tcp&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>which mode to use in the defaults block</p>
</div>
</li>
<li>
<span class='name'>hy_log_default</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;global&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>should be used when the instance’s logging parameters are the same as the global ones.</p>
</div>
</li>
<li>
<span class='name'>hy_timeout_http_request</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;10s&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Set the maximum allowed time to wait for a complete HTTP request.</p>
</div>
</li>
<li>
<span class='name'>hy_timeout_queue</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1m&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Set the maximum time to wait in the queue for a connection slot to be free.</p>
</div>
</li>
<li>
<span class='name'>hy_timeout_http_keep_alive</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;10s&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>set the timeout value for keeping https connections alive</p>
</div>
</li>
<li>
<span class='name'>hy_timeout_check</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;10s&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>set the timeout value for how long to check if the timeout has occurred</p>
</div>
</li>
<li>
<span class='name'>hy_manage_fail2ban</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to integrate fail2ban</p>
</div>
</li>
<li>
<span class='name'>hy_use_http_server_close</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to use this in global mode</p>
</div>
</li>
<li>
<span class='name'>hy_use_forward_for</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to use this in global mode</p>
</div>
</li>
<li>
<span class='name'>hy_use_redispatch</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to use this in global mode</p>
</div>
</li>
<li>
<span class='name'>hy_max_retries</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;3&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>max retries value</p>
</div>
</li>
<li>
<span class='name'>hy_timeout_connect</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;10s&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>timeout for connections</p>
</div>
</li>
<li>
<span class='name'>hy_timeout_client</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1m&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>timeout for client connections</p>
</div>
</li>
<li>
<span class='name'>hy_timeout_server</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1m&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>timeout for server response</p>
</div>
</li>
<li>
<span class='name'>hy_hard_stop</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to use hard stop for service restart</p>
</div>
</li>
<li>
<span class='name'>hy_hard_stop_value</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;60s&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>which value to use for hard stop</p>
</div>
</li>
<li>
<span class='name'>hy_stats_auth</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;admin:password&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>credentials to use for stats authentication</p>
</div>
</li>
<li>
<span class='name'>hy_log_local0</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;127.0.0.1:514 local0&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>settings for logging to local0</p>
</div>
</li>
<li>
<span class='name'>hy_log_local1</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;127.0.0.1:514 local1 notice&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>settings for logging to local1</p>
</div>
</li>
<li>
<span class='name'>hy_use_tcplog</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to use tcplog as default</p>
</div>
</li>
<li>
<span class='name'>hy_use_httplog</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to use httplog as default</p>
</div>
</li>
<li>
<span class='name'>hy_use_dontlognull</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to use dontlognull as default</p>
</div>
</li>
<li>
<span class='name'>hy_be_userlist</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;####&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>backend userlist comment</p>
</div>
</li>
<li>
<span class='name'>hy_manage_be_users</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to manage backend users</p>
Recommit for updates in build 4
2026-09-05 12:54:02 +02:00
</div>
</li>
<li>
<span class='name'>hy_selinux_allow_stats</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to allow stats in selinux</p>
Recommit for updates in build 5
2026-09-05 12:59:46 +02:00
</div>
</li>
<li>
<span class='name'>hy_stats_port</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;8404&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the port to use for stats. used in firewall settings</p>
Recommit for updates in build 2
2026-09-05 11:48:55 +02:00
</div>
</li>
</ul>
</div><div class="method_details_list">
<table class="source_code">
<tr>
<td>
<pre class="lines">
Recommit for updates in build 7
2026-09-05 13:09:34 +02:00
59
Recommit for updates in build 2
2026-09-05 11:48:55 +02:00
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
Recommit for updates in build 4
2026-09-05 12:54:02 +02:00
146
147
148
149
Recommit for updates in build 7
2026-09-05 13:09:34 +02:00
150</pre>
Recommit for updates in build 2
2026-09-05 11:48:55 +02:00
</td>
<td>
Recommit for updates in build 7
2026-09-05 13:09:34 +02:00
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 59</span>
Recommit for updates in build 2
2026-09-05 11:48:55 +02:00
class confdroid_haproxy::params (
String $pkg_ensure = &#39;latest&#39;,
Array $reqpackages = [&#39;haproxy&#39;,&#39;httpd-tools&#39;],
String $hy_host_fqdn = undef,
# firewall
Boolean $hy_manage_fw = true,
String $hy_fw_order_no = &#39;50&#39;,
# fail2ban
Boolean $hy_manage_fail2ban = false,
Recommit for updates in build 4
2026-09-05 12:54:02 +02:00
# selinux
Boolean $hy_selinux_allow_stats = false,
Recommit for updates in build 2
2026-09-05 11:48:55 +02:00
# main config
String $hy_http_port = &#39;80&#39;,
String $hy_https_port = &#39;443&#39;,
Recommit for updates in build 5
2026-09-05 12:59:46 +02:00
String $hy_stats_port = &#39;8404&#39;,
Recommit for updates in build 2
2026-09-05 11:48:55 +02:00
String $hy_chroot = &#39;/var/lib/haproxy&#39;,
String $hy_pid = &#39;/var/run/haproxy.pid&#39;,
String $hy_maxconn = &#39;4000&#39;,
String $hy_stats_socket = &#39;/var/lib/haproxy/stats&#39;,
String $hy_default_mode = &#39;tcp&#39;,
Boolean $hy_use_http_server_close = false,
Boolean $hy_use_forward_for = false,
Boolean $hy_use_redispatch = true,
String $hy_max_retries = &#39;3&#39;,
String $hy_timeout_http_request = &#39;10s&#39;,
String $hy_timeout_queue = &#39;1m&#39;,
String $hy_timeout_connect = &#39;10s&#39;,
String $hy_timeout_client = &#39;1m&#39;,
String $hy_timeout_server = &#39;1m&#39;,
String $hy_timeout_http_keep_alive = &#39;10s&#39;,
String $hy_timeout_check = &#39;10s&#39;,
Boolean $hy_hard_stop = true,
String $hy_hard_stop_value = &#39;60s&#39;,
String $hy_stats_auth = &#39;admin:password&#39;,
# user
String $hy_user_name = &#39;haproxy&#39;,
String $hy_user_comment = &#39;haproxy user&#39;,
String $hy_user_home = &#39;/var/lib/haproxy&#39;,
String $hy_user_shell = &#39;/sbin/nologin&#39;,
# logging
String $hy_log_local0 = &#39;127.0.0.1:514 local0&#39;,
String $hy_log_local1 = &#39;127.0.0.1:514 local1 notice&#39;,
String $hy_log_target = &#39;127.0.0.1&#39;,
String $hy_log_facility = &#39;local2&#39;,
String $hy_log_default = &#39;global&#39;,
Boolean $hy_use_tcplog = true,
Boolean $hy_use_httplog = false,
Boolean $hy_use_dontlognull = true,
Boolean $hy_manage_be_users = false,
String $hy_be_userlist = &#39;####&#39;,
) {
$fqdn = $facts[&#39;networking&#39;][&#39;fqdn&#39;]
# service
$hy_service = &#39;haproxy&#39;
# directories
$hy_main_dir = &#39;/etc/haproxy&#39;
$hy_errors_dir = &quot;${hy_main_dir}/errors&quot;
$hy_certs_dir = &quot;${hy_main_dir}/certs&quot;
# files
$hy_main_config = &quot;${hy_main_dir}/haproxy.cfg&quot;
$hy_config_head_erb = &#39;confdroid_haproxy/haproxy_head.erb&#39;
$hy_config_tail_erb = &#39;confdroid_haproxy/haproxy_tail.erb&#39;
$hy_400_file = &quot;${hy_errors_dir}/400.http&quot;
$hy_400_erb = &#39;confdroid_haproxy/errors/400_http.erb&#39;
$hy_403_file = &quot;${hy_errors_dir}/403.http&quot;
$hy_403_erb = &#39;confdroid_haproxy/errors/403_http.erb&#39;
$hy_408_file = &quot;${hy_errors_dir}/408.http&quot;
$hy_408_erb = &#39;confdroid_haproxy/errors/408_http.erb&#39;
$hy_500_file = &quot;${hy_errors_dir}/500.http&quot;
$hy_500_erb = &#39;confdroid_haproxy/errors/500_http.erb&#39;
$hy_502_file = &quot;${hy_errors_dir}/502.http&quot;
$hy_502_erb = &#39;confdroid_haproxy/errors/502_http.erb&#39;
$hy_503_file = &quot;${hy_errors_dir}/503.http&quot;
$hy_503_erb = &#39;confdroid_haproxy/errors/503_http.erb&#39;
$hy_504_file = &quot;${hy_errors_dir}/504.http&quot;
$hy_504_erb = &#39;confdroid_haproxy/errors/504_http.erb&#39;
# includes must be last
include confdroid_haproxy::main::config
}</pre>
</td>
</tr>
</table>
</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>
Reference in New Issue Copy Permalink