358 lines
7.7 KiB
HTML
358 lines
7.7 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
|
<title>
|
||
|
|
Puppet Class: alloy_cd::params
|
||
|
|
|
||
|
|
— 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::alloy_cd::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 (a)</a> »
|
||
|
|
<span class='title'><span class='object_link'>Puppet Classes</span></span>
|
||
|
|
»
|
||
|
|
<span class="title">alloy_cd::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: alloy_cd::params</h1>
|
||
|
|
<div class="box_info">
|
||
|
|
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt>Inherited by:</dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
<span class='object_link'><a href="alloy_cd_3A_3Amain_3A_3Adirs.html" title="puppet_classes::alloy_cd::main::dirs (puppet_class)">alloy_cd::main::dirs</a></span><br/>
|
||
|
|
|
||
|
|
<span class='object_link'><a href="alloy_cd_3A_3Amain_3A_3Afiles.html" title="puppet_classes::alloy_cd::main::files (puppet_class)">alloy_cd::main::files</a></span><br/>
|
||
|
|
|
||
|
|
<span class='object_link'><a href="alloy_cd_3A_3Amain_3A_3Aconfig.html" title="puppet_classes::alloy_cd::main::config (puppet_class)">alloy_cd::main::config</a></span><br/>
|
||
|
|
|
||
|
|
<span class='object_link'><a href="alloy_cd_3A_3Amain_3A_3Ainstall.html" title="puppet_classes::alloy_cd::main::install (puppet_class)">alloy_cd::main::install</a></span><br/>
|
||
|
|
|
||
|
|
<span class='object_link'><a href="alloy_cd_3A_3Amain_3A_3Aservice.html" title="puppet_classes::alloy_cd::main::service (puppet_class)">alloy_cd::main::service</a></span><br/>
|
||
|
|
|
||
|
|
<span class='object_link'><a href="alloy_cd_3A_3Amain_3A_3Ayumrepo.html" title="puppet_classes::alloy_cd::main::yumrepo (puppet_class)">alloy_cd::main::yumrepo</a></span><br/>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt>Defined in:</dt>
|
||
|
|
<dd>
|
||
|
|
manifests/params.pp
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h2>Summary</h2>
|
||
|
|
Class contains all parameters for the alloy_cd module.
|
||
|
|
|
||
|
|
<h2>Overview</h2>
|
||
|
|
<div class="docstring">
|
||
|
|
<div class="discussion">
|
||
|
|
|
||
|
|
<p>alloy_cd::params.pp Module name: alloy_cd 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'>reqpackages</span>
|
||
|
|
|
||
|
|
|
||
|
|
<span class='type'>(<tt>String</tt>)</span>
|
||
|
|
|
||
|
|
|
||
|
|
<em class="default">(defaults to: <tt>'alloy'</tt>)</em>
|
||
|
|
|
||
|
|
|
||
|
|
—
|
||
|
|
<div class='inline'>
|
||
|
|
<p>which packages to install</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<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>'latest' or 'present'</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class='name'>ay_loki_url</span>
|
||
|
|
|
||
|
|
|
||
|
|
<span class='type'>(<tt>String</tt>)</span>
|
||
|
|
|
||
|
|
|
||
|
|
<em class="default">(defaults to: <tt>'https://loki.example.net/loki/api/v1/push'</tt>)</em>
|
||
|
|
|
||
|
|
|
||
|
|
—
|
||
|
|
<div class='inline'>
|
||
|
|
<p>the url where alloy will send logs to.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class='name'>ay_loki_username</span>
|
||
|
|
|
||
|
|
|
||
|
|
<span class='type'>(<tt>String</tt>)</span>
|
||
|
|
|
||
|
|
|
||
|
|
<em class="default">(defaults to: <tt>'loki_user'</tt>)</em>
|
||
|
|
|
||
|
|
|
||
|
|
—
|
||
|
|
<div class='inline'>
|
||
|
|
<p>the username to logon to loki</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class='name'>ay_loki_userpass</span>
|
||
|
|
|
||
|
|
|
||
|
|
<span class='type'>(<tt>String</tt>)</span>
|
||
|
|
|
||
|
|
|
||
|
|
<em class="default">(defaults to: <tt>'loki_pass'</tt>)</em>
|
||
|
|
|
||
|
|
|
||
|
|
—
|
||
|
|
<div class='inline'>
|
||
|
|
<p>the password to logon to loki</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class='name'>ay_manage_loki</span>
|
||
|
|
|
||
|
|
|
||
|
|
<span class='type'>(<tt>String</tt>)</span>
|
||
|
|
|
||
|
|
|
||
|
|
<em class="default">(defaults to: <tt>true</tt>)</em>
|
||
|
|
|
||
|
|
|
||
|
|
—
|
||
|
|
<div class='inline'>
|
||
|
|
<p>whether to manage log forwarding to loki</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class='name'>ay_manage_prom</span>
|
||
|
|
|
||
|
|
|
||
|
|
<span class='type'>(<tt>Boolean</tt>)</span>
|
||
|
|
|
||
|
|
|
||
|
|
<em class="default">(defaults to: <tt>true</tt>)</em>
|
||
|
|
|
||
|
|
|
||
|
|
—
|
||
|
|
<div class='inline'>
|
||
|
|
<p>whether to manage metric forwarding</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class='name'>ay_prom_url</span>
|
||
|
|
|
||
|
|
|
||
|
|
<span class='type'>(<tt>String</tt>)</span>
|
||
|
|
|
||
|
|
|
||
|
|
<em class="default">(defaults to: <tt>'https://prometheus.example.net/api/v1/write'</tt>)</em>
|
||
|
|
|
||
|
|
|
||
|
|
—
|
||
|
|
<div class='inline'>
|
||
|
|
<p>the url where alloy will send metrics</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class='name'>ay_log_targets</span>
|
||
|
|
|
||
|
|
|
||
|
|
<span class='type'>(<tt>Array</tt>)</span>
|
||
|
|
|
||
|
|
|
||
|
|
<em class="default">(defaults to: <tt>['/var/log/messages','/var/log/secure',]</tt>)</em>
|
||
|
|
|
||
|
|
|
||
|
|
—
|
||
|
|
<div class='inline'>
|
||
|
|
<p>the logging targets</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div><div class="method_details_list">
|
||
|
|
<table class="source_code">
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<pre class="lines">
|
||
|
|
|
||
|
|
|
||
|
|
15
|
||
|
|
16
|
||
|
|
17
|
||
|
|
18
|
||
|
|
19
|
||
|
|
20
|
||
|
|
21
|
||
|
|
22
|
||
|
|
23
|
||
|
|
24
|
||
|
|
25
|
||
|
|
26
|
||
|
|
27
|
||
|
|
28
|
||
|
|
29
|
||
|
|
30
|
||
|
|
31
|
||
|
|
32
|
||
|
|
33
|
||
|
|
34
|
||
|
|
35
|
||
|
|
36
|
||
|
|
37
|
||
|
|
38
|
||
|
|
39
|
||
|
|
40
|
||
|
|
41
|
||
|
|
42
|
||
|
|
43</pre>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 15</span>
|
||
|
|
|
||
|
|
class alloy_cd::params (
|
||
|
|
|
||
|
|
String $reqpackages = 'alloy',
|
||
|
|
String $pkg_ensure = 'latest',
|
||
|
|
|
||
|
|
# loki
|
||
|
|
String $ay_manage_loki = true,
|
||
|
|
String $ay_loki_url = 'https://loki.example.net/loki/api/v1/push',
|
||
|
|
String $ay_loki_username = 'loki_user',
|
||
|
|
String $ay_loki_userpass = 'loki_pass',
|
||
|
|
Array $ay_log_targets = ['/var/log/messages','/var/log/secure',],
|
||
|
|
|
||
|
|
# prometheus
|
||
|
|
Boolean $ay_manage_prom = true,
|
||
|
|
String $ay_prom_url = 'https://prometheus.example.net/api/v1/write',
|
||
|
|
|
||
|
|
) {
|
||
|
|
# service
|
||
|
|
$ay_service = 'alloy'
|
||
|
|
|
||
|
|
# dirs
|
||
|
|
$ay_main_dir = '/etc/alloy'
|
||
|
|
|
||
|
|
# files
|
||
|
|
$ay_main_file = "${ay_main_dir}/config.alloy"
|
||
|
|
|
||
|
|
# includes must be last
|
||
|
|
include alloy_cd::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>
|