2018-04-24 17:07:21 +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_haproxy::params
|
|
|
|
|
|
2018-12-07 15:09:55 +01:00
|
|
|
— Documentation by YARD 0.9.16
|
2018-04-24 17:07:21 +02:00
|
|
|
|
|
|
|
|
</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_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">
|
|
|
|
|
|
2018-12-07 15:09:55 +01:00
|
|
|
<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>
|
2018-04-24 17:07:21 +02:00
|
|
|
|
2018-12-07 15:09:55 +01:00
|
|
|
<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
|
2018-04-24 17:07:21 +02:00
|
|
|
version.</p>
|
|
|
|
|
|
2018-12-07 15:09:55 +01:00
|
|
|
<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
|
2018-04-24 17:07:21 +02:00
|
|
|
for more details.</p>
|
|
|
|
|
|
2018-12-07 15:09:55 +01:00
|
|
|
<p>You should have received a copy of the GNU General Public License along
|
2018-04-24 17:07:21 +02:00
|
|
|
with this program. If not, see <a
|
|
|
|
|
href="http://www.gnu.org/licenses">www.gnu.org/licenses</a>/.</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2018-12-07 15:09:55 +01:00
|
|
|
|
|
|
|
|
|
2018-04-24 17:07:21 +02:00
|
|
|
<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
|
2018-12-07 15:09:55 +01:00
|
|
|
type</a> to choose, i.e. <code>latest</code> or <code>present</code>.</p>
|
2018-04-24 17:07:21 +02:00
|
|
|
</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'>
|
2018-12-07 15:09:55 +01:00
|
|
|
<p>the fqdn of the ha proxy host. mmust be fqdn, not cname. specify multiple
|
2018-04-24 17:07:21 +02:00
|
|
|
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'>
|
2018-12-07 15:09:55 +01:00
|
|
|
<p>the rule number to control the oder of the firewall rules.</p>
|
2018-04-24 17:07:21 +02:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
<span class='name'>hy_proxy_mode</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<em class="default">(defaults to: <tt>'http'</tt>)</em>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
—
|
|
|
|
|
<div class='inline'>
|
2018-12-07 15:09:55 +01:00
|
|
|
<p>which mode the ha proxy should work in. Valid oprtions are
|
2018-04-24 17:07:21 +02:00
|
|
|
<code>http</code> and <code>tcp</code>.</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
<span class='name'>hy_fe_port</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<em class="default">(defaults to: <tt>''</tt>)</em>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
—
|
|
|
|
|
<div class='inline'>
|
2018-12-07 15:09:55 +01:00
|
|
|
<p>the frontend port to list to. opens in firewall, if enabled, and is used in
|
|
|
|
|
configuration templates. only active if <code>hy_proxy_mode</code> is set
|
2018-04-24 17:07:21 +02:00
|
|
|
to <code>tcp</code>.</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
<span class='name'>hy_be_port</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<em class="default">(defaults to: <tt>''</tt>)</em>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
—
|
|
|
|
|
<div class='inline'>
|
2018-12-07 15:09:55 +01:00
|
|
|
<p>the backend port to send traffic through. only active if
|
2018-04-24 17:07:21 +02:00
|
|
|
<code>hy_proxy_mode</code> is set to <code>tcp</code>.</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div><div class="method_details_list">
|
|
|
|
|
<table class="source_code">
|
|
|
|
|
<tr>
|
|
|
|
|
<td>
|
|
|
|
|
<pre class="lines">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
40
|
|
|
|
|
41
|
|
|
|
|
42
|
|
|
|
|
43
|
|
|
|
|
44
|
|
|
|
|
45
|
|
|
|
|
46
|
|
|
|
|
47
|
|
|
|
|
48
|
|
|
|
|
49
|
|
|
|
|
50
|
|
|
|
|
51
|
|
|
|
|
52
|
|
|
|
|
53
|
|
|
|
|
54
|
|
|
|
|
55
|
|
|
|
|
56
|
|
|
|
|
57
|
|
|
|
|
58
|
|
|
|
|
59
|
|
|
|
|
60
|
|
|
|
|
61
|
|
|
|
|
62
|
|
|
|
|
63
|
|
|
|
|
64
|
|
|
|
|
65
|
|
|
|
|
66
|
|
|
|
|
67
|
|
|
|
|
68</pre>
|
|
|
|
|
</td>
|
|
|
|
|
<td>
|
|
|
|
|
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 40</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_proxy_mode = 'http',
|
|
|
|
|
$hy_fe_port = '',
|
|
|
|
|
$hy_be_port = '',
|
|
|
|
|
|
|
|
|
|
) {
|
|
|
|
|
|
|
|
|
|
# service
|
|
|
|
|
$hy_service = 'haproxy'
|
|
|
|
|
|
|
|
|
|
# installation section
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# 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>
|
