Files
confdroid_jenkins/doc/puppet_classes/confdroid_jenkins_3A_3Aparams.html

470 lines
10 KiB
HTML
Raw Normal View History

2026-04-16 16:47:19 +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_jenkins::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_jenkins::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_jenkins::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_jenkins::params</h1>
<div class="box_info">
<dl>
<dt>Inherited by:</dt>
<dd>
<span class='object_link'><a href="confdroid_jenkins_3A_3Amain_3A_3Adirs.html" title="puppet_classes::confdroid_jenkins::main::dirs (puppet_class)">confdroid_jenkins::main::dirs</a></span><br/>
<span class='object_link'><a href="confdroid_jenkins_3A_3Amain_3A_3Afiles.html" title="puppet_classes::confdroid_jenkins::main::files (puppet_class)">confdroid_jenkins::main::files</a></span><br/>
<span class='object_link'><a href="confdroid_jenkins_3A_3Amain_3A_3Aconfig.html" title="puppet_classes::confdroid_jenkins::main::config (puppet_class)">confdroid_jenkins::main::config</a></span><br/>
<span class='object_link'><a href="confdroid_jenkins_3A_3Amain_3A_3Ainstall.html" title="puppet_classes::confdroid_jenkins::main::install (puppet_class)">confdroid_jenkins::main::install</a></span><br/>
<span class='object_link'><a href="confdroid_jenkins_3A_3Amain_3A_3Aservice.html" title="puppet_classes::confdroid_jenkins::main::service (puppet_class)">confdroid_jenkins::main::service</a></span><br/>
<span class='object_link'><a href="confdroid_jenkins_3A_3Amain_3A_3Ayumrepo.html" title="puppet_classes::confdroid_jenkins::main::yumrepo (puppet_class)">confdroid_jenkins::main::yumrepo</a></span><br/>
<span class='object_link'><a href="confdroid_jenkins_3A_3Afirewall_3A_3Aiptables.html" title="puppet_classes::confdroid_jenkins::firewall::iptables (puppet_class)">confdroid_jenkins::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 confdroid_jenkins module.
<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
<p>confdroid_jenkins::params.pp Module name: confdroid_jenkins Author: 12ww1160 (12ww1160@confdroid.com)</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>js_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'>js_pkg_ensure</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;present&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>which packages to install</p>
</div>
</li>
<li>
<span class='name'>js_gpg_check</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to enable GPG check for Jenkins packages</p>
</div>
</li>
<li>
<span class='name'>js_repo_enabled</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to enable the Jenkins repository</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_base_url</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;https://pkg.jenkins.io/rpm-stable&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the base URL for the Jenkins repository</p>
</div>
</li>
<li>
<span class='name'>js_key</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;repodata/repomd.xml.key&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the filename of the Jenkins GPG key to import</p>
</div>
</li>
<li>
<span class='name'>js_key_code</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;gpg-pubkey-14abfc68-69494683&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the code of the Jenkins GPG key to check</p>
</div>
</li>
<li>
<span class='name'>js_gpg_repo_check</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to enable GPG check for the Jenkins repository</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">
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
52
53
54
55
56
57
58</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 20</span>
class confdroid_jenkins::params (
Array $js_reqpackages = [&#39;jenkins&#39;,&#39;fontconfig&#39;],
String $js_pkg_ensure = &#39;present&#39;,
String $js_gpg_check = &#39;1&#39;,
String $js_repo_enabled = &#39;1&#39;,
String $js_gpg_repo_check = &#39;1&#39;,
String $js_base_url = &#39;https://pkg.jenkins.io/rpm-stable&#39;,
String $js_key = &#39;repodata/repomd.xml.key&#39;,
String $js_key_code = &#39;gpg-pubkey-14abfc68-69494683&#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;]
$js_sudoers_file = &#39;/etc/sudoers.d/jenkins_sudo&#39;
$js_sudoers_erb = &#39;confdroid_jenkins/sudoers.erb&#39;
# Service
$js_service = &#39;jenkins&#39;
# includes must be last
include confdroid_jenkins::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>