Files
confdroid_alloy/doc/puppet_classes/confdroid_alloy_3A_3Aparams.html

530 lines
12 KiB
HTML
Raw Normal View History

2026-08-01 14:32:14 +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_alloy::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_alloy::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_alloy::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_alloy::params</h1>
<div class="box_info">
<dl>
<dt>Inherited by:</dt>
<dd>
<span class='object_link'><a href="confdroid_alloy_3A_3Amain_3A_3Adirs.html" title="puppet_classes::confdroid_alloy::main::dirs (puppet_class)">confdroid_alloy::main::dirs</a></span><br/>
<span class='object_link'><a href="confdroid_alloy_3A_3Amain_3A_3Afiles.html" title="puppet_classes::confdroid_alloy::main::files (puppet_class)">confdroid_alloy::main::files</a></span><br/>
<span class='object_link'><a href="confdroid_alloy_3A_3Amain_3A_3Aconfig.html" title="puppet_classes::confdroid_alloy::main::config (puppet_class)">confdroid_alloy::main::config</a></span><br/>
<span class='object_link'><a href="confdroid_alloy_3A_3Amain_3A_3Ainstall.html" title="puppet_classes::confdroid_alloy::main::install (puppet_class)">confdroid_alloy::main::install</a></span><br/>
<span class='object_link'><a href="confdroid_alloy_3A_3Amain_3A_3Aservice.html" title="puppet_classes::confdroid_alloy::main::service (puppet_class)">confdroid_alloy::main::service</a></span><br/>
<span class='object_link'><a href="confdroid_alloy_3A_3Amain_3A_3Ayumrepo.html" title="puppet_classes::confdroid_alloy::main::yumrepo (puppet_class)">confdroid_alloy::main::yumrepo</a></span><br/>
2026-09-07 13:42:16 +02:00
<span class='object_link'><a href="confdroid_alloy_3A_3Amonitoring_3A_3Atarget.html" title="puppet_classes::confdroid_alloy::monitoring::target (puppet_class)">confdroid_alloy::monitoring::target</a></span><br/>
2026-08-01 14:32:14 +02:00
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>
manifests/params.pp
</dd>
</dl>
</div>
<h2>Summary</h2>
Class contains all parameters for the confdroid_alloy module.
<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
<p>confdroid_alloy::params.pp Module name: confdroid_alloy Author: 12ww1160 (12ww1160@confdroid.com)</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>ay_reqpackages</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;alloy&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>which packages to install</p>
</div>
</li>
<li>
<span class='name'>ay_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>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>&#39;https://loki.example.net/loki/api/v1/push&#39;</tt>)</em>
&mdash;
<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>&#39;loki_user&#39;</tt>)</em>
&mdash;
<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>&#39;loki_pass&#39;</tt>)</em>
&mdash;
<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>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<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>
&mdash;
<div class='inline'>
<p>whether to manage metric forwarding</p>
</div>
</li>
<li>
2026-09-01 11:07:24 +02:00
<span class='name'>ay_prom_url</span>
2026-08-01 14:32:14 +02:00
2026-09-01 11:07:24 +02:00
<span class='type'>(<tt>String</tt>)</span>
2026-08-01 14:32:14 +02:00
2026-09-01 11:07:24 +02:00
<em class="default">(defaults to: <tt>&#39;https://prometheus.example.net/api/v1/write&#39;</tt>)</em>
2026-08-01 14:32:14 +02:00
&mdash;
<div class='inline'>
2026-09-01 11:07:24 +02:00
<p>the url where alloy will send metrics</p>
2026-08-01 14:32:14 +02:00
</div>
</li>
<li>
2026-09-01 11:07:24 +02:00
<span class='name'>ay_log_targets</span>
2026-08-01 14:32:14 +02:00
2026-09-01 11:07:24 +02:00
<span class='type'>(<tt>Array</tt>)</span>
2026-08-01 14:32:14 +02:00
2026-09-01 11:07:24 +02:00
<em class="default">(defaults to: <tt>[&#39;/var/log/messages&#39;,&#39;/var/log/secure&#39;,]</tt>)</em>
2026-08-01 14:32:14 +02:00
&mdash;
<div class='inline'>
2026-09-01 11:07:24 +02:00
<p>the logging targets</p>
2026-08-01 14:32:14 +02:00
</div>
</li>
<li>
2026-09-01 11:07:24 +02:00
<span class='name'>ay_prom_honor_timestamps</span>
2026-08-01 14:32:14 +02:00
2026-09-01 11:07:24 +02:00
<span class='type'>(<tt>Boolean</tt>)</span>
2026-08-01 14:32:14 +02:00
2026-09-01 11:07:24 +02:00
<em class="default">(defaults to: <tt>true</tt>)</em>
2026-08-01 14:32:14 +02:00
&mdash;
<div class='inline'>
2026-09-01 11:07:24 +02:00
<p>whether to honor timestamps in prometheus metrics</p>
</div>
</li>
<li>
<span class='name'>ay_prom_track_timestamps_staleness</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to track timestamps staleness in prometheus metrics</p>
2026-09-01 11:36:07 +02:00
</div>
</li>
<li>
<span class='name'>ay_prom_max_shards</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;10&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the maximum number of shards to use for prometheus metrics</p>
</div>
</li>
<li>
<span class='name'>ay_prom_max_samples_per_send</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;2000&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the maximum number of samples to send</p>
</div>
</li>
<li>
<span class='name'>ay_prom_batch_send_deadline</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;5s&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the maximum time to wait before sending</p>
2026-09-07 13:42:16 +02:00
</div>
</li>
<li>
<span class='name'>ay_manage_nagios</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 nagios service exports</p>
</div>
</li>
<li>
<span class='name'>ay_target_service</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/etc/nagios/conf.d/alloy_service.cfg&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the target file for nagios service exports</p>
</div>
</li>
<li>
<span class='name'>ay_target_contacts</span>
<span class='type'>(<tt>Array</tt>)</span>
<em class="default">(defaults to: <tt>[&#39;nagiosadmin&#39;]</tt>)</em>
&mdash;
<div class='inline'>
<p>the contacts for nagios service exports</p>
2026-08-01 14:32:14 +02:00
</div>
</li>
</ul>
</div><div class="method_details_list">
<table class="source_code">
<tr>
<td>
<pre class="lines">
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
2026-09-01 11:07:24 +02:00
48
2026-09-01 11:36:07 +02:00
49
50
51
52
53
54
2026-09-07 13:42:16 +02:00
55
56
57
58
59
60
61
62
2026-09-07 13:48:15 +02:00
63
64
65
66</pre>
2026-08-01 14:32:14 +02:00
</td>
<td>
2026-09-07 13:42:16 +02:00
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 25</span>
2026-08-01 14:32:14 +02:00
class confdroid_alloy::params (
2026-09-01 11:07:24 +02:00
String $ay_reqpackages = &#39;alloy&#39;,
String $ay_pkg_ensure = &#39;latest&#39;,
2026-08-01 14:32:14 +02:00
# loki
2026-09-01 11:07:24 +02:00
Boolean $ay_manage_loki = true,
String $ay_loki_url = &#39;https://loki.example.net/loki/api/v1/push&#39;,
String $ay_loki_username = &#39;loki_user&#39;,
String $ay_loki_userpass = &#39;loki_pass&#39;,
Array $ay_log_targets = [&#39;/var/log/messages&#39;,&#39;/var/log/secure&#39;,],
2026-08-01 14:32:14 +02:00
# prometheus
2026-09-01 11:07:24 +02:00
Boolean $ay_manage_prom = true,
String $ay_prom_url = &#39;https://prometheus.example.net/api/v1/write&#39;,
Boolean $ay_prom_honor_timestamps = true,
Boolean $ay_prom_track_timestamps_staleness = true,
2026-09-01 11:36:07 +02:00
String $ay_prom_max_shards = &#39;10&#39;,
String $ay_prom_max_samples_per_send = &#39;2000&#39;,
String $ay_prom_batch_send_deadline = &#39;5s&#39;,
2026-08-01 14:32:14 +02:00
2026-09-07 13:42:16 +02:00
# nagios
Boolean $ay_manage_nagios = false,
String $ay_target_service = &#39;/etc/nagios/conf.d/alloy_service.cfg&#39;,
Array $ay_target_contacts = [&#39;nagiosadmin&#39;],
2026-08-01 14:32:14 +02:00
) {
2026-09-07 13:48:15 +02:00
# defaults
$fqdn = $facts[&#39;networking&#39;][&#39;fqdn&#39;]
2026-08-01 14:32:14 +02:00
# service
$ay_service = &#39;alloy&#39;
# dirs
$ay_main_dir = &#39;/etc/alloy&#39;
# files
$ay_main_file = &quot;${ay_main_dir}/config.alloy&quot;
# includes must be last
include confdroid_alloy::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>