Files
confdroid_haproxy/doc/puppet_classes/cd_haproxy_3A_3Aparams.html
2025-01-27 11:55:05 +01:00

922 lines
20 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Puppet Class: cd_haproxy::params
&mdash; Documentation by YARD 0.9.26
</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::cd_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">cd_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: cd_haproxy::params</h1>
<div class="box_info">
<dl>
<dt>Inherited by:</dt>
<dd>
<span class='object_link'><a href="cd_haproxy_3A_3Amain_3A_3Adirs.html" title="puppet_classes::cd_haproxy::main::dirs (puppet_class)">cd_haproxy::main::dirs</a></span><br/>
<span class='object_link'><a href="cd_haproxy_3A_3Amain_3A_3Auser.html" title="puppet_classes::cd_haproxy::main::user (puppet_class)">cd_haproxy::main::user</a></span><br/>
<span class='object_link'><a href="cd_haproxy_3A_3Amain_3A_3Afiles.html" title="puppet_classes::cd_haproxy::main::files (puppet_class)">cd_haproxy::main::files</a></span><br/>
<span class='object_link'><a href="cd_haproxy_3A_3Amain_3A_3Aconfig.html" title="puppet_classes::cd_haproxy::main::config (puppet_class)">cd_haproxy::main::config</a></span><br/>
<span class='object_link'><a href="cd_haproxy_3A_3Amain_3A_3Ainstall.html" title="puppet_classes::cd_haproxy::main::install (puppet_class)">cd_haproxy::main::install</a></span><br/>
<span class='object_link'><a href="cd_haproxy_3A_3Aserver_3A_3Aservice.html" title="puppet_classes::cd_haproxy::server::service (puppet_class)">cd_haproxy::server::service</a></span><br/>
<span class='object_link'><a href="cd_haproxy_3A_3Afirewall_3A_3Aiptables.html" title="puppet_classes::cd_haproxy::firewall::iptables (puppet_class)">cd_haproxy::firewall::iptables</a></span><br/>
<span class='object_link'><a href="cd_haproxy_3A_3Aserver_3A_3Aproxy_test.html" title="puppet_classes::cd_haproxy::server::proxy_test (puppet_class)">cd_haproxy::server::proxy_test</a></span><br/>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>
manifests/params.pp
</dd>
</dl>
</div>
<h2>Summary</h2>
Class holds all parameters for the cd_haproxy module and is
inherited by all classes except defines.
<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
<p>cd_haproxy::params.pp Module name: cd_haproxy Author: Arne Teuke
(arne_teuke@confdroid.com) License: This file is part of cd_haproxy.</p>
<p>cd_haproxy is used for providing automatic configuration of HA proxy.
Copyright (C) 2017 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>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>string</tt>)</span>
<em class="default">(defaults to: <tt>[&#39;haproxy&#39;]</tt>)</em>
&mdash;
<div class='inline'>
<p>specify th epackages 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. mmust 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 oder 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 haprxy 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_show_stats</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>whether we want to display the statistics page</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;http&#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&#39;s logging parameters are the same as
the global ones.</p>
</div>
</li>
<li>
<span class='name'>hy_use_httplog</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 httplogging option. Enable logging of HTTP request, session
state and timers</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 enable or disable dontlognull option. true enables, false
disables.</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>true</tt>)</em>
&mdash;
<div class='inline'>
<p>Enable or disable HTTP connection closing on the server side</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>true</tt>)</em>
&mdash;
<div class='inline'>
<p>Enable insertion of the X-Forwarded-For header to requests sent to servers.</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>Enable or disable session redistribution in case of connection failure.</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>Set the number of retries to perform on a server after a connection
failure.</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_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>Set the maximum time to wait for a connection attempt to a server to
succeed.</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>Set the maximum inactivity time on the client side.</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>Set the maximum inactivity time on the server side.</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 occured</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><a href="https://cbonte.github.io/haproxy-dconv/1.5/configuration.html" target="_parent" title="https://cbonte.github.io/haproxy-dconv/1.5/configuration.html">https://cbonte.github.io/haproxy-dconv/1.5/configuration.html</a></li>
</ul>
</div><div class="method_details_list">
<table class="source_code">
<tr>
<td>
<pre class="lines">
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
146
147
148
149
150
151
152
153
154</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 78</span>
class cd_haproxy::params (
$pkg_ensure = &#39;latest&#39;,
$reqpackages = [&#39;haproxy&#39;],
$hy_host_fqdn = undef,
# firewall
$hy_manage_fw = true,
$hy_fw_order_no = &#39;50&#39;,
# main config
$hy_http_port = &#39;80&#39;,
$hy_https_port = &#39;443&#39;,
$hy_chroot = &#39;/var/lib/haproxy&#39;,
$hy_pid = &#39;/var/run/haproxy.pid&#39;,
$hy_maxconn = &#39;4000&#39;,
$hy_show_stats = true,
$hy_stats_socket = &#39;/var/lib/haproxy/stats&#39;,
$hy_default_mode = &#39;http&#39;,
$hy_use_http_server_close = true,
$hy_use_forward_for = true,
$hy_use_redispatch = true,
$hy_max_retries = &#39;3&#39;,
$hy_timeout_http_request = &#39;10s&#39;,
$hy_timeout_queue = &#39;1m&#39;,
$hy_timeout_connect = &#39;10s&#39;,
$hy_timeout_client = &#39;1m&#39;,
$hy_timeout_server = &#39;1m&#39;,
$hy_timeout_http_keep_alive = &#39;10s&#39;,
$hy_timeout_check = &#39;10s&#39;,
# user
$hy_user_name = &#39;haproxy&#39;,
$hy_user_comment = &#39;haproxy user&#39;,
$hy_user_home = &#39;/var/lib/haproxy&#39;,
$hy_user_shell = &#39;/sbin/nologin&#39;,
# logging
$hy_log_target = &#39;127.0.0.1&#39;,
$hy_log_facility = &#39;local2&#39;,
$hy_log_default = &#39;global&#39;,
$hy_use_httplog = true,
$hy_use_dontlognull = true,
) {
# service
$hy_service = &#39;haproxy&#39;
# directories
$hy_main_dir = &#39;/etc/haproxy&#39;
$hy_errors_dir = &quot;${hy_main_dir}/errors&quot;
# files
$hy_main_config = &quot;${hy_main_dir}/haproxy.cfg&quot;
$hy_config_head_erb = &#39;cd_haproxy/haproxy_head.erb&#39;
$hy_400_file = &quot;${hy_errors_dir}/400.http&quot;
$hy_400_erb = &#39;cd_haproxy/errors/400_http.erb&#39;
$hy_403_file = &quot;${hy_errors_dir}/403.http&quot;
$hy_403_erb = &#39;cd_haproxy/errors/403_http.erb&#39;
$hy_408_file = &quot;${hy_errors_dir}/408.http&quot;
$hy_408_erb = &#39;cd_haproxy/errors/408_http.erb&#39;
$hy_500_file = &quot;${hy_errors_dir}/500.http&quot;
$hy_500_erb = &#39;cd_haproxy/errors/500_http.erb&#39;
$hy_502_file = &quot;${hy_errors_dir}/502.http&quot;
$hy_502_erb = &#39;cd_haproxy/errors/502_http.erb&#39;
$hy_503_file = &quot;${hy_errors_dir}/503.http&quot;
$hy_503_erb = &#39;cd_haproxy/errors/503_http.erb&#39;
$hy_504_file = &quot;${hy_errors_dir}/504.http&quot;
$hy_504_erb = &#39;cd_haproxy/errors/504_http.erb&#39;
# includes must be last
include cd_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>