confdroid/puppet_cd
3
0
Fork 0
Code Wiki Activity
Files
2a743f7286b399fde2b2e815462bf4d01c2bac65
puppet_cd/doc/puppet_classes/puppet_cd_3A_3Aparams.html

649 lines
14 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Puppet Class: puppet_cd::params
&mdash; 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::puppet_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 (p)</a> &raquo;
<span class='title'><span class='object_link'>Puppet Classes</span></span>
&raquo;
<span class="title">puppet_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: puppet_cd::params</h1>
<div class="box_info">
<dl>
<dt>Inherited by:</dt>
<dd>
<span class='object_link'><a href="puppet_cd_3A_3Amain_3A_3Adirs.html" title="puppet_classes::puppet_cd::main::dirs (puppet_class)">puppet_cd::main::dirs</a></span><br/>
<span class='object_link'><a href="puppet_cd_3A_3Amain_3A_3Auser.html" title="puppet_classes::puppet_cd::main::user (puppet_class)">puppet_cd::main::user</a></span><br/>
<span class='object_link'><a href="puppet_cd_3A_3Amain_3A_3Afiles.html" title="puppet_classes::puppet_cd::main::files (puppet_class)">puppet_cd::main::files</a></span><br/>
<span class='object_link'><a href="puppet_cd_3A_3Amain_3A_3Aconfig.html" title="puppet_classes::puppet_cd::main::config (puppet_class)">puppet_cd::main::config</a></span><br/>
<span class='object_link'><a href="puppet_cd_3A_3Amain_3A_3Ainstall.html" title="puppet_classes::puppet_cd::main::install (puppet_class)">puppet_cd::main::install</a></span><br/>
<span class='object_link'><a href="puppet_cd_3A_3Amain_3A_3Ayumrepo.html" title="puppet_classes::puppet_cd::main::yumrepo (puppet_class)">puppet_cd::main::yumrepo</a></span><br/>
<span class='object_link'><a href="puppet_cd_3A_3Aserver_3A_3Aservice.html" title="puppet_classes::puppet_cd::server::service (puppet_class)">puppet_cd::server::service</a></span><br/>
<span class='object_link'><a href="puppet_cd_3A_3Afirewall_3A_3Aiptables.html" title="puppet_classes::puppet_cd::firewall::iptables (puppet_class)">puppet_cd::firewall::iptables</a></span><br/>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>
manifests/params.pp
</dd>
</dl>
</div>
<h2>Summary</h2>
Class manages parameters for the puppet_cd module.
<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
<p>puppet_cd::params.pp Module name: puppet_cd Author: Arne Teuke
(arne_teuke@confdroid) settings are applied. any other fqdn # will be
considered a puppet agent.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>pt_manage_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 manage firewall settings</p>
</div>
</li>
<li>
<span class='name'>pt_pm_fqdn</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;puppetmaster.example.net&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the fqdn for the puppetmaster and master</p>
</div>
</li>
<li>
<span class='name'>pt_db_fqdn</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;puppetdb.example.net&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the fqdn for the puppetdb host.</p>
</div>
</li>
<li>
<span class='name'>pt_package_url</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;https://yum.puppet.com/puppet8-release-el-9.noarch.rpm&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the url for fetching the repo rpm</p>
</div>
</li>
<li>
<span class='name'>pt_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>valid: “present”, “latest”, “v1.2.3”</p>
</div>
</li>
<li>
<span class='name'>pt_agent_pkg</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;puppet-agent&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the packages for agents to install</p>
</div>
</li>
<li>
<span class='name'>pt_server_pkg</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;puppetserver&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the server packages to install</p>
</div>
</li>
<li>
<span class='name'>pt_db_pkg</span>
<span class='type'>(<tt>Array</tt>)</span>
<em class="default">(defaults to: <tt>[&#39;puppetdb&#39;,&#39;puppetdb-termini&#39;]</tt>)</em>
&mdash;
<div class='inline'>
<p>the packages for puppetdb</p>
</div>
</li>
<li>
<span class='name'>pt_no_ssl_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>non-ssl port number for puppetdb</p>
</div>
</li>
<li>
<span class='name'>pt_ssl_port</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;8081&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>ssl port for puppetdb</p>
</div>
</li>
<li>
<span class='name'>pt_use_ssl_only</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to use ssl only.</p>
</div>
</li>
<li>
<span class='name'>pt_manage_user</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 the puppet user</p>
</div>
</li>
<li>
<span class='name'>pt_user</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;puppet&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the puppet user</p>
</div>
</li>
<li>
<span class='name'>pt_user_comment</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;puppetserver daemon&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the user comment</p>
</div>
</li>
<li>
<span class='name'>pt_user_home</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/opt/puppetlabs/server/data/puppetserver&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the user home</p>
</div>
</li>
<li>
<span class='name'>pt_user_shell</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/sbin/nologin&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the user shell</p>
</div>
</li>
<li>
<span class='name'>pt_manage_db_user</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 the user for puppetdb</p>
</div>
</li>
<li>
<span class='name'>pt_db_user</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;puppetdb&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the puppetdb user</p>
</div>
</li>
<li>
<span class='name'>pt_db_user_comment</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;PuppetDB daemon&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the user comment for puppetdb user</p>
</div>
</li>
<li>
<span class='name'>pt_db_user_home</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/opt/puppetlabs/server/data/puppetdb&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the user home for the puppetdb user</p>
</div>
</li>
<li>
<span class='name'>pt_db_user_shell</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/sbin/nologin&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the shell for the puppetdb user</p>
</div>
</li>
<li>
<span class='name'>pt_use_puppetdb</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to use puppetdb on host</p>
</div>
</li>
</ul>
</div><div class="method_details_list">
<table class="source_code">
<tr>
<td>
<pre class="lines">
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 29</span>
class puppet_cd::params (
Boolean $pt_manage_fw = true,
String $pt_pm_fqdn = &#39;puppetmaster.example.net&#39;,
String $pt_db_fqdn = &#39;puppetdb.example.net&#39;,
# installation
String $pt_package_url = &#39;https://yum.puppet.com/puppet8-release-el-9.noarch.rpm&#39;,
String $pt_pkg_ensure = &#39;present&#39;,
String $pt_agent_pkg = &#39;puppet-agent&#39;,
String $pt_server_pkg = &#39;puppetserver&#39;,
Array $pt_db_pkg = [&#39;puppetdb&#39;,&#39;puppetdb-termini&#39;],
# puppetdb
Boolean $pt_use_puppetdb = false,
String $pt_no_ssl_port = &#39;8080&#39;,
String $pt_ssl_port = &#39;8081&#39;,
Boolean $pt_use_ssl_only = true,
# user settings
## puppet user
Boolean $pt_manage_user = true,
String $pt_user = &#39;puppet&#39;,
String $pt_user_comment = &#39;puppetserver daemon&#39;,
String $pt_user_home = &#39;/opt/puppetlabs/server/data/puppetserver&#39;,
String $pt_user_shell = &#39;/sbin/nologin&#39;,
## puppetdb user
Boolean $pt_manage_db_user = true,
String $pt_db_user = &#39;puppetdb&#39;,
String $pt_db_user_comment = &#39;PuppetDB daemon&#39;,
String $pt_db_user_home = &#39;/opt/puppetlabs/server/data/puppetdb&#39;,
String $pt_db_user_shell = &#39;/sbin/nologin&#39;,
) {
$fqdn = $facts[&#39;networking&#39;][&#39;fqdn&#39;]
# directories
$pt_main_dir = &#39;/etc/puppetlabs&#39;
$pt_puppetdir = &quot;${pt_main_dir}/puppet&quot;
$pt_code_dir = &quot;${pt_main_dir}/code&quot;
$pt_environmentspath = &quot;${pt_code_dir}/environments&quot;
$pt_ssldir = &quot;${pt_puppetdir}/ssl&quot;
$pt_privatekeydir = &quot;${pt_ssldir}/private_keys&quot;
$pt_rundir = &#39;/var/run/puppetlabs&#39;
$pt_rundir_master = &#39;/var/run/puppetlabs/puppetserver&#39;
$pt_vardir = &#39;/opt/puppetlabs/puppet/cache&#39;
$pt_vardir_master = &#39;/opt/puppetlabs/server/data/puppetserver&#39;
# service
$pt_server_service = &#39;puppetserver&#39;
$pt_agent_service = &#39;puppet&#39;
$pt_db_service = &#39;puppetdb&#39;
#
# includes must be last
include puppet_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>
View Git Blame Copy Permalink