3
0
Files
puppet_cd/doc/puppet_classes/puppet_cd_3A_3Aparams.html

1864 lines
41 KiB
HTML

<!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.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::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_3Ar10k_3A_3Ainstall.html" title="puppet_classes::puppet_cd::r10k::install (puppet_class)">puppet_cd::r10k::install</a></span><br/>
<span class='object_link'><a href="puppet_cd_3A_3Ar10k_3A_3Awebhook.html" title="puppet_classes::puppet_cd::r10k::webhook (puppet_class)">puppet_cd::r10k::webhook</a></span><br/>
<span class='object_link'><a href="puppet_cd_3A_3Apuppetdb_3A_3Adirs.html" title="puppet_classes::puppet_cd::puppetdb::dirs (puppet_class)">puppet_cd::puppetdb::dirs</a></span><br/>
<span class='object_link'><a href="puppet_cd_3A_3Apuppetdb_3A_3Afiles.html" title="puppet_classes::puppet_cd::puppetdb::files (puppet_class)">puppet_cd::puppetdb::files</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_3Apuppetdb_3A_3Aservice.html" title="puppet_classes::puppet_cd::puppetdb::service (puppet_class)">puppet_cd::puppetdb::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_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_r10k_pkg</span>
<span class='type'>(<tt>Array</tt>)</span>
<em class="default">(defaults to: <tt>[&#39;ruby&#39;,&#39;ruby-devel&#39;,&#39;gcc&#39;,&#39;make&#39;,&#39;redhat-rpm-config&#39;,&#39;rpm-build&#39;]</tt>)</em>
&mdash;
<div class='inline'>
<p>the packages for r10k to install</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_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>
<li>
<span class='name'>pt_environment</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;production&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the environment</p>
</div>
</li>
<li>
<span class='name'>pt_basemodulepath</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/etc/puppetlabs/code/environments/common:/etc/puppetlabs/code/modules:/opt/puppetlabs/puppet/modules:/usr/share/puppet/modules&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the base module path</p>
</div>
</li>
<li>
<span class='name'>pt_logdir</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/var/log/puppetlabs/puppet&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the log directory</p>
</div>
</li>
<li>
<span class='name'>pt_allow_duplicate_certs</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to allow duplicated certs</p>
</div>
</li>
<li>
<span class='name'>pt_pluginfactsource</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;pluginfacts&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the plugin fact source</p>
</div>
</li>
<li>
<span class='name'>pt_pluginsource</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;plugins&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the plugin source</p>
</div>
</li>
<li>
<span class='name'>pt_runinterval</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1800&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the runinterval</p>
</div>
</li>
<li>
<span class='name'>pt_reports</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;foreman&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>where to send the run reports</p>
</div>
</li>
<li>
<span class='name'>pt_show_diff</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to show the diff</p>
</div>
</li>
<li>
<span class='name'>pt_default_schedules</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>the default run schedules</p>
</div>
</li>
<li>
<span class='name'>pt_masterport</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;8140&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the master port to listen on</p>
</div>
</li>
<li>
<span class='name'>pt_noop</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>whether noop should be executed</p>
</div>
</li>
<li>
<span class='name'>pt_pluginsync</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>whether pluginsync should be allowed</p>
</div>
</li>
<li>
<span class='name'>pt_report</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>whether reports should be created</p>
</div>
</li>
<li>
<span class='name'>pt_splay</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to enable a sleeping period before runs</p>
</div>
</li>
<li>
<span class='name'>pt_splaylimit</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1800&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the splay limit</p>
</div>
</li>
<li>
<span class='name'>pt_usecacheonfailure</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 the cache on failure</p>
</div>
</li>
<li>
<span class='name'>pt_autosign</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/etc/puppetlabs/puppet/autosign.conf&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>where to check the autosign settings</p>
</div>
</li>
<li>
<span class='name'>pt_ca</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to be a ca</p>
</div>
</li>
<li>
<span class='name'>pt_external_nodes</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/etc/puppetlabs/puppet/node.rb&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the external node settings (ENC)</p>
</div>
</li>
<li>
<span class='name'>pt_logdir_master</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/var/log/puppetlabs/puppetserver&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the log directory on the master</p>
</div>
</li>
<li>
<span class='name'>pt_node_terminus</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;exec&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Which node data plugin to use when compiling node catalogs.</p>
</div>
</li>
<li>
<span class='name'>pt_strict_variables</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>Causes an evaluation error when referencing unknown variables</p>
</div>
</li>
<li>
<span class='name'>pt_storeconfigs</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>whether store client configs.</p>
</div>
</li>
<li>
<span class='name'>pt_storeconfigs_backend</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;puppetdb&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>where to store client configs</p>
</div>
</li>
<li>
<span class='name'>pt_parser</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;current&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>which parser version to use</p>
</div>
</li>
<li>
<span class='name'>pt_cert_revocation</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to check for cert revocations</p>
</div>
</li>
<li>
<span class='name'>pt_logging_max_file_size</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;200MB&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>max file size for puppetdb logging</p>
</div>
</li>
<li>
<span class='name'>pt_logging_max_history</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;90&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>max logging history</p>
</div>
</li>
<li>
<span class='name'>pt_logging_total_size</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1GB&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>total size of logging file</p>
</div>
</li>
<li>
<span class='name'>pt_com_proc_threads</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;4&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>number of processing threads</p>
</div>
</li>
<li>
<span class='name'>pt_concurrent_writes</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;4&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>max concurrent writes</p>
</div>
</li>
<li>
<span class='name'>pt_db_subname</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;//localhost:5432/puppetdb&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the db name</p>
</div>
</li>
<li>
<span class='name'>pt_db_username</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;foobar&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the db username</p>
</div>
</li>
<li>
<span class='name'>pt_db_password</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;foobar&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the db password</p>
</div>
</li>
<li>
<span class='name'>pt_gc_interval</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;60&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>garbage collection interval (Java)</p>
</div>
</li>
<li>
<span class='name'>pt_log_slow_statements</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;10&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>number of seconds before an SQL query is considered “slow.”</p>
</div>
</li>
<li>
<span class='name'>pt_puppetdb_source_lan</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 lan for puppetdb clients</p>
</div>
</li>
<li>
<span class='name'>pt_soft_write_failure</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>allows the PuppetDB-termini to fail softly if PuppetDB is not accessible for command submission.</p>
</div>
</li>
<li>
<span class='name'>pt_no_ssl_host</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;0.0.0.0&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>ip range for non-ssl hosts</p>
</div>
</li>
<li>
<span class='name'>pt_ssl_host</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;0.0.0.0&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>ip range for SSL hosts</p>
</div>
</li>
<li>
<span class='name'>pt_ssl_key</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/etc/puppetlabs/puppetdb/ssl/private.pem&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>location of the private key</p>
</div>
</li>
<li>
<span class='name'>pt_ssl_cert</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/etc/puppetlabs/puppetdb/ssl/public.pem&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>location of the ssl cert</p>
</div>
</li>
<li>
<span class='name'>pt_ssl_ca_cert</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/etc/puppetlabs/puppetdb/ssl/ca.pem&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>location of the ssl ca cert</p>
</div>
</li>
<li>
<span class='name'>pt_log_access</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to configure log access</p>
</div>
</li>
<li>
<span class='name'>pt_access_log_config</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/etc/puppetlabs/puppetdb/request-logging.xml&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the location of the access log config</p>
</div>
</li>
<li>
<span class='name'>pt_enable_repl</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to allow puppetdb replication</p>
</div>
</li>
<li>
<span class='name'>pt_repl_port</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;8082&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the replication port</p>
</div>
</li>
<li>
<span class='name'>pt_repl_host</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;127.0.0.1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the replication host</p>
</div>
</li>
<li>
<span class='name'>pt_use_r10k</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 r10k service</p>
</div>
</li>
<li>
<span class='name'>pt_use_r10k_webhook</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 r10k webhook service</p>
</div>
</li>
<li>
<span class='name'>pt_r10k_remote</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;git@gitlab.example.net/repo.git&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the remote url for the r10k control repo</p>
</div>
</li>
<li>
<span class='name'>pt_r10k_prefix</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>the r10k prefix. defaults to false</p>
</div>
</li>
<li>
<span class='name'>pt_r10k_basedir</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/etc/puppetlabs/code/environments&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the base directory for r10k.yaml</p>
</div>
</li>
<li>
<span class='name'>pt_r10k_webhook_pkg</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;python3-pip&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the packages for the r10k webhook</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>
</ul>
</div><div class="method_details_list">
<table class="source_code">
<tr>
<td>
<pre class="lines">
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 88</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_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;],
Array $pt_r10k_pkg = [&#39;ruby&#39;,&#39;ruby-devel&#39;,&#39;gcc&#39;,&#39;make&#39;,&#39;redhat-rpm-config&#39;,&#39;rpm-build&#39;],
String $pt_r10k_webhook_pkg = &#39;python3-pip&#39;,
# 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;,
# templates
## puppet
String $pt_environment = &#39;production&#39;,
Boolean $pt_allow_duplicate_certs = false,
String $pt_basemodulepath = &#39;/etc/puppetlabs/code/environments/common:/etc/puppetlabs/code/modules:/opt/puppetlabs/puppet/modules:/usr/share/puppet/modules&#39;,
String $pt_logdir = &#39;/var/log/puppetlabs/puppet&#39;,
String $pt_pluginfactsource = &#39;pluginfacts&#39;,
String $pt_pluginsource = &#39;plugins&#39;,
String $pt_reports = &#39;foreman&#39;,
Boolean $pt_show_diff = false,
Boolean $pt_default_schedules = false,
String $pt_masterport = &#39;8140&#39;,
Boolean $pt_noop = false,
Boolean $pt_pluginsync = true,
Boolean $pt_report = true,
String $pt_runinterval = &#39;1800&#39;,
Boolean $pt_splay = false,
String $pt_splaylimit = &#39;1800&#39;,
Boolean $pt_usecacheonfailure = true,
String $pt_autosign = &#39;/etc/puppetlabs/puppet/autosign.conf&#39;,
Boolean $pt_ca = true,
String $pt_external_nodes = &#39;/etc/puppetlabs/puppet/node.rb&#39;,
String $pt_logdir_master = &#39;/var/log/puppetlabs/puppetserver&#39;,
String $pt_node_terminus = &#39;exec&#39;,
Boolean $pt_strict_variables = false,
Boolean $pt_storeconfigs = true,
String $pt_storeconfigs_backend = &#39;puppetdb&#39;,
String $pt_parser = &#39;current&#39;,
Boolean $pt_cert_revocation = true,
## puppetdb
Boolean $pt_use_puppetdb = false,
String $pt_logging_max_file_size = &#39;200MB&#39;,
String $pt_logging_max_history = &#39;90&#39;,
String $pt_logging_total_size = &#39;1GB&#39;,
String $pt_com_proc_threads = &#39;4&#39;,
String $pt_concurrent_writes = &#39;4&#39;,
String $pt_db_subname = &#39;//localhost:5432/puppetdb&#39;,
String $pt_db_username = &#39;foobar&#39;,
String $pt_db_password = &#39;foobar&#39;,
String $pt_gc_interval = &#39;60&#39;,
String $pt_log_slow_statements = &#39;10&#39;,
String $pt_no_ssl_port = &#39;8080&#39;,
String $pt_ssl_port = &#39;8081&#39;,
Boolean $pt_use_ssl_only = true,
String $pt_puppetdb_source_lan = &#39;0.0.0.0/0&#39;,
Boolean $pt_soft_write_failure = false,
String $pt_no_ssl_host = &#39;0.0.0.0&#39;,
String $pt_ssl_host = &#39;0.0.0.0&#39;,
String $pt_ssl_key = &#39;/etc/puppetlabs/puppetdb/ssl/private.pem&#39;,
String $pt_ssl_cert = &#39;/etc/puppetlabs/puppetdb/ssl/public.pem&#39;,
String $pt_ssl_ca_cert = &#39;/etc/puppetlabs/puppetdb/ssl/ca.pem&#39;,
Boolean $pt_log_access = false,
String $pt_access_log_config = &#39;/etc/puppetlabs/puppetdb/request-logging.xml&#39;,
Boolean $pt_enable_repl = false,
String $pt_repl_port = &#39;8082&#39;,
String $pt_repl_host = &#39;127.0.0.1&#39;,
# r10k
Boolean $pt_use_r10k = false,
Boolean $pt_use_r10k_webhook = false,
String $pt_r10k_remote = &#39;git@gitlab.example.net/repo.git&#39;,
Boolean $pt_r10k_prefix = false,
String $pt_r10k_basedir = &#39;/etc/puppetlabs/code/environments&#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;]
# directories
## puppet
$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;
## puppetdb
$pt_puppetdb_main = &#39;/etc/puppetlabs/puppetdb&#39;
$pt_puppetdb_conf_d = &quot;${pt_puppetdb_main}/conf.d&quot;
$pt_puppetdb_ssl = &quot;${pt_puppetdb_main}/ssl&quot;
$pt_puppetdb_log = &#39;/var/log/puppetlabs/puppetdb&#39;
$pt_puppetdb_var_dir = &#39;/opt/puppetlabs/server/data/puppetdb&#39;
## r10k
$pt_r10k_dir = &quot;${pt_main_dir}/r10k&quot;
$pt_r10k_webhook_dir = &#39;/opt/r10k-webhook&#39;
# files
## puppet
$pt_puppet_conf_file = &quot;${pt_puppetdir}/puppet.conf&quot;
$pt_puppet_conf_erb = &#39;puppet_cd/puppet.conf.erb&#39;
$pt_agent_conf_erb = &#39;puppet_cd/agent.conf.erb&#39;
$pt_hiera_config = &quot;${pt_puppetdir}/hiera.yaml&quot;
## puppetdb
$pt_bootstrap_conf = &quot;${pt_puppetdb_main}/bootstrap.cfg&quot;
$pt_bootstrap_erb = &#39;puppet_cd/puppetdb/bootstrap.cfg.erb&#39;
$pt_puppetdb_access_log = &quot;${pt_puppetdb_log}/puppetdb-access&quot;
$pt_request_logging_conf = &quot;${pt_puppetdb_main}/request-logging.xml&quot;
$pt_request_logging_erb = &#39;puppet_cd/puppetdb/request_logging.xml.erb&#39;
$pt_logback_conf = &quot;${pt_puppetdb_main}/logback.xml&quot;
$pt_logback_erb = &#39;puppet_cd/puppetdb/logback.xml.erb&#39;
$pt_puppetdb_config_ini = &quot;${pt_puppetdb_conf_d}/config.ini&quot;
$pt_puppetdb_config_erb = &#39;puppet_cd/puppetdb/config.ini.erb&#39;
$pt_puppetdb_database_ini = &quot;${pt_puppetdb_conf_d}/database.ini&quot;
$pt_puppetdb_database_erb = &#39;puppet_cd/puppetdb/database.ini.erb&#39;
$pt_puppetdb_jetty_ini = &quot;${pt_puppetdb_conf_d}/jetty.ini&quot;
$pt_puppetdb_jetty_erb = &#39;puppet_cd/puppetdb/jetty.ini.erb&#39;
$pt_puppetdb_conf_file = &quot;${pt_puppetdir}/puppetdb.conf&quot;
$pt_puppetdb_conf_erb = &#39;puppet_cd/puppetdb/puppetdb.conf.erb&#39;
$pt_puppetdb_repl_ini = &quot;${pt_puppetdb_conf_d}/repl.ini&quot;
$pt_puppetdb_repl_erb = &#39;puppet_cd/puppetdb/repl.ini.erb&#39;
## r10k
$pt_r10k_file = &quot;${pt_r10k_dir}/r10k.yaml&quot;
$pt_r10k_erb = &#39;puppet_cd/r10k/r10k.yaml.erb&#39;
$pt_r10k_webhook_file = &quot;${pt_r10k_webhook_dir}/webhook_server.py&quot;
$pt_r10k_webhook_erb = &#39;puppet_cd/r10k/webhook.py.erb&#39;
$pt_r10k_req_file = &quot;${pt_r10k_webhook_dir}/requirements.txt&quot;
$pt_r10k_req_erb = &#39;puppet_cd/r10k/requirements.txt.erb&#39;
$pt_r10k_wh_service_file = &#39;/etc/systemd/system/r10k-webhook.service&#39;
$pt_r10k_wh_service_erb = &#39;puppet_cd/r10k/r10k_webhook_service.erb&#39;
# service
$pt_server_service = &#39;puppetserver&#39;
$pt_agent_service = &#39;puppet&#39;
$pt_db_service = &#39;puppetdb&#39;
$pt_r10k_wb_service = &#39;r10k-webhook&#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>