Files
confdroid_jenkins/doc/puppet_classes/jenkins_cd_3A_3Aparams.html

360 lines
7.9 KiB
HTML
Raw Normal View History

2025-10-21 17:15:29 +02:00
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Puppet Class: jenkins_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::jenkins_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 (j)</a> &raquo;
<span class='title'><span class='object_link'>Puppet Classes</span></span>
&raquo;
<span class="title">jenkins_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: jenkins_cd::params</h1>
<div class="box_info">
<dl>
<dt>Inherited by:</dt>
<dd>
<span class='object_link'><a href="jenkins_cd_3A_3Amain_3A_3Adirs.html" title="puppet_classes::jenkins_cd::main::dirs (puppet_class)">jenkins_cd::main::dirs</a></span><br/>
<span class='object_link'><a href="jenkins_cd_3A_3Amain_3A_3Afiles.html" title="puppet_classes::jenkins_cd::main::files (puppet_class)">jenkins_cd::main::files</a></span><br/>
<span class='object_link'><a href="jenkins_cd_3A_3Amain_3A_3Aconfig.html" title="puppet_classes::jenkins_cd::main::config (puppet_class)">jenkins_cd::main::config</a></span><br/>
<span class='object_link'><a href="jenkins_cd_3A_3Amain_3A_3Ainstall.html" title="puppet_classes::jenkins_cd::main::install (puppet_class)">jenkins_cd::main::install</a></span><br/>
<span class='object_link'><a href="jenkins_cd_3A_3Amain_3A_3Aservice.html" title="puppet_classes::jenkins_cd::main::service (puppet_class)">jenkins_cd::main::service</a></span><br/>
<span class='object_link'><a href="jenkins_cd_3A_3Amain_3A_3Ayumrepo.html" title="puppet_classes::jenkins_cd::main::yumrepo (puppet_class)">jenkins_cd::main::yumrepo</a></span><br/>
<span class='object_link'><a href="jenkins_cd_3A_3Afirewall_3A_3Aiptables.html" title="puppet_classes::jenkins_cd::firewall::iptables (puppet_class)">jenkins_cd::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 jenkins_cd module.
<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
<p>jenkins_cd::params.pp Module name: jenkins_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>Array</tt>)</span>
<em class="default">(defaults to: <tt>[&#39;jenkins&#39;,&#39;fontconfig&#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 packages to install</p>
</div>
</li>
<li>
<span class='name'>js_host_fqdn</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;jenkins.example.net&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>fqdn of the host where Jenkins should run</p>
</div>
</li>
<li>
<span class='name'>js_enable_fw</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to enable firewall control</p>
</div>
</li>
<li>
<span class='name'>js_fw_rule</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;50&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the prefix for the firewall rule order</p>
</div>
</li>
<li>
<span class='name'>js_jenkins_port</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;8080&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the port to open for Jenkins</p>
</div>
</li>
<li>
<span class='name'>js_source_net</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;0.0.0.0/0&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the source range to open</p>
</div>
</li>
<li>
<span class='name'>js_use_sudo</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to add Jenkins to sudoers list</p>
</div>
</li>
</ul>
</div><div class="method_details_list">
<table class="source_code">
<tr>
<td>
<pre class="lines">
14
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
44
45
46
47
48
49
50
51</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 14</span>
class jenkins_cd::params (
Array $reqpackages = [&#39;jenkins&#39;,&#39;fontconfig&#39;],
String $pkg_ensure = &#39;latest&#39;,
# server fqdn
String $js_host_fqdn = &#39;jenkins.example.net&#39;,
# firewall
Boolean $js_enable_fw = true,
String $js_fw_rule = &#39;50&#39;,
String $js_jenkins_port = &#39;8080&#39;,
String $js_source_net = &#39;0.0.0.0/0&#39;,
# user
Boolean $js_use_sudo = false,
) {
# 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;]
# yum repo
$js_base_url = &#39;https://pkg.jenkins.io/redhat-stable/&#39;
$js_key_url = &quot;${js_base_url}/jenkins.io-2023.key&quot;
$js_key_code = &#39;gpg-pubkey-ef5975ca-6421ce2b&#39;
$js_sudoers_file = &#39;/etc/sudoers.d/jenkins_sudo&#39;
$js_sudoers_erb = &#39;jenkins_cd/sudoers.erb&#39;
# Service
$js_service = &#39;jenkins&#39;
# includes must be last
include jenkins_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>