579 lines
12 KiB
HTML
579 lines
12 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
|
|
|
|
— Documentation by YARD 0.9.16
|
|
|
|
</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_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> »
|
|
<span class='title'><span class='object_link'>Puppet Classes</span></span>
|
|
»
|
|
<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/>
|
|
|
|
</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>'latest'</tt>)</em>
|
|
|
|
|
|
—
|
|
<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>['haproxy']</tt>)</em>
|
|
|
|
|
|
—
|
|
<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>"proxy.${::domain}"</tt>)</em>
|
|
|
|
|
|
—
|
|
<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>
|
|
|
|
|
|
—
|
|
<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>'50'</tt>)</em>
|
|
|
|
|
|
—
|
|
<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>'80'</tt>)</em>
|
|
|
|
|
|
—
|
|
<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>'443'</tt>)</em>
|
|
|
|
|
|
—
|
|
<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>'haproxy'</tt>)</em>
|
|
|
|
|
|
—
|
|
<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>'haproxy user'</tt>)</em>
|
|
|
|
|
|
—
|
|
<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>'/var/lib/haproxy'</tt>)</em>
|
|
|
|
|
|
—
|
|
<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>'/sbin/nologin'</tt>)</em>
|
|
|
|
|
|
—
|
|
<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>'127.0.0.1'</tt>)</em>
|
|
|
|
|
|
—
|
|
<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>'local2'</tt>)</em>
|
|
|
|
|
|
—
|
|
<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>'/var/lib/haproxy'</tt>)</em>
|
|
|
|
|
|
—
|
|
<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>'/var/run/haproxy.pid'</tt>)</em>
|
|
|
|
|
|
—
|
|
<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>'4000'</tt>)</em>
|
|
|
|
|
|
—
|
|
<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>
|
|
|
|
|
|
—
|
|
<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>'/var/lib/haproxy/stats'</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>name and path of the stats socket</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
</div><div class="method_details_list">
|
|
<table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
48
|
|
49
|
|
50
|
|
51
|
|
52
|
|
53
|
|
54
|
|
55
|
|
56
|
|
57
|
|
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</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 48</span>
|
|
|
|
class cd_haproxy::params (
|
|
|
|
$pkg_ensure = 'latest',
|
|
$reqpackages = ['haproxy'],
|
|
|
|
$hy_host_fqdn = "proxy.${::domain}",
|
|
|
|
# firewall
|
|
$hy_manage_fw = true,
|
|
$hy_fw_order_no = '50',
|
|
|
|
# main config
|
|
$hy_http_port = '80',
|
|
$hy_https_port = '443',
|
|
|
|
# user
|
|
$hy_user_name = 'haproxy',
|
|
$hy_user_comment = 'haproxy user',
|
|
$hy_user_home = '/var/lib/haproxy',
|
|
$hy_user_shell = '/sbin/nologin',
|
|
|
|
# logging
|
|
$hy_log_target = '127.0.0.1',
|
|
$hy_log_facility = 'local2',
|
|
$hy_chroot = '/var/lib/haproxy',
|
|
$hy_pid = '/var/run/haproxy.pid',
|
|
$hy_maxconn = '4000',
|
|
$hy_show_stats = true,
|
|
$hy_stats_socket = '/var/lib/haproxy/stats',
|
|
|
|
) {
|
|
|
|
# service
|
|
$hy_service = 'haproxy'
|
|
|
|
# directories
|
|
$hy_main_dir = '/etc/haproxy'
|
|
|
|
# files
|
|
$hy_main_config = "${hy_main_dir}/haproxy.cfg"
|
|
$hy_config_head_erb = 'cd_haproxy/haproxy_head.erb'
|
|
|
|
|
|
# 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> |