Files
confdroid_automatic/doc/puppet_classes/automatic_cd_3A_3Aparams.html
2025-06-03 17:15:41 +02:00

400 lines
8.6 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Puppet Class: automatic_cd::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::automatic_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> &raquo;
<span class='title'><span class='object_link'>Puppet Classes</span></span>
&raquo;
<span class="title">automatic_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: automatic_cd::params</h1>
<div class="box_info">
<dl>
<dt>Inherited by:</dt>
<dd>
<span class='object_link'><a href="automatic_cd_3A_3Amain_3A_3Adirs.html" title="puppet_classes::automatic_cd::main::dirs (puppet_class)">automatic_cd::main::dirs</a></span><br/>
<span class='object_link'><a href="automatic_cd_3A_3Amain_3A_3Afiles.html" title="puppet_classes::automatic_cd::main::files (puppet_class)">automatic_cd::main::files</a></span><br/>
<span class='object_link'><a href="automatic_cd_3A_3Amain_3A_3Aconfig.html" title="puppet_classes::automatic_cd::main::config (puppet_class)">automatic_cd::main::config</a></span><br/>
<span class='object_link'><a href="automatic_cd_3A_3Amain_3A_3Ainstall.html" title="puppet_classes::automatic_cd::main::install (puppet_class)">automatic_cd::main::install</a></span><br/>
<span class='object_link'><a href="automatic_cd_3A_3Amain_3A_3Aservice.html" title="puppet_classes::automatic_cd::main::service (puppet_class)">automatic_cd::main::service</a></span><br/>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>
manifests/params.pp
</dd>
</dl>
</div>
<h2>Summary</h2>
Class manages all parameters for the automatic_cd module
<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
<p>automatic_cd::params.pp Module name: automatic_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>&#39;dnf-automatic&#39;</tt>)</em>
&mdash;
<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>&#39;latest&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>which version of packages to install</p>
</div>
</li>
<li>
<span class='name'>ac_upgrade_type</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;default&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>what upgrades to manage</p>
</div>
</li>
<li>
<span class='name'>ac_random_sleep</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;0&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>random sleep seconds</p>
</div>
</li>
<li>
<span class='name'>ac_network_online_timeout</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;60&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Maximum time until be online</p>
</div>
</li>
<li>
<span class='name'>ac_download_updates</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;yes&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to download available updates</p>
</div>
</li>
<li>
<span class='name'>ac_apply_updates</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;yes&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to apply available updates</p>
</div>
</li>
<li>
<span class='name'>ac_reboot</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;never&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>when to reboot after applied updates</p>
</div>
</li>
<li>
<span class='name'>ac_emit_via</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;email&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>how to inform about emitted updates</p>
</div>
</li>
<li>
<span class='name'>ac_email_to</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;root@example.net&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>where to send the email to</p>
</div>
</li>
<li>
<span class='name'>ac_email_host</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;localhost&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>which host to use to send the email</p>
</div>
</li>
</ul>
</div><div class="method_details_list">
<table class="source_code">
<tr>
<td>
<pre class="lines">
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
44
45
46
47
48
49</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 17</span>
class automatic_cd::params (
String $reqpackages = &#39;dnf-automatic&#39;,
String $pkg_ensure = &#39;latest&#39;,
# updates
String $ac_upgrade_type = &#39;default&#39;,
String $ac_random_sleep = &#39;0&#39;,
String $ac_network_online_timeout = &#39;60&#39;,
String $ac_download_updates = &#39;yes&#39;,
String $ac_apply_updates = &#39;yes&#39;,
String $ac_reboot = &#39;never&#39;,
String $ac_emit_via = &#39;email&#39;,
String $ac_email_to = &#39;root@example.net&#39;,
String $ac_email_host = &#39;localhost&#39;,
) {
# Facts
$fqdn = $facts[&#39;networking&#39;][&#39;fqdn&#39;]
$domain = $facts[&#39;networking&#39;][&#39;domain&#39;]
$os_name = $facts[&#39;os&#39;][&#39;name&#39;]
$os_release = $facts[&#39;os&#39;][&#39;release&#39;][&#39;major&#39;]
# Service
$ac_service = &#39;dnf-automatic.timer&#39;
# Files
$ac_main_config = &#39;/etc/dnf/automatic.conf&#39;
$ac_main_config_erb = &#39;automatic_cd/automatic.conf.erb&#39;
# includes must be last
include automatic_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>