Satisfy puppet-lint

Author: Phil Friderici

manifests/init.pp

@@ -2,11 +2,63 @@
 #
 # Manages puppet agent
 #
+# @param agent_sysconfig_path
+#   The absolute path to the puppet agent sysconfig file.
+#
+# @param ca_server
+#   The name of the puppet CA server.
+#
+# @param certname
+#   The certificate name for the client.
+#
+# @param config_path
+#   The absolute path to the puppet config file.
+#
+# @param cron_command
+#   Command that will be run from cron for the puppet agent.
+#
+# @param custom_settings
+#   A hash that allows you to define and set any settings in puppet.conf.
+#   For each setting use a nested hash and provide the section and the name
+#   and value of the setting.
+#
+#   Example:
+#   ```
+#   $custom_settings = {
+#     'name'  => { 'section' => 'master', 'setting' => 'codedir', 'value' => '/specific/path' },
+#     'other' => { 'section' => 'agent',  'setting' => 'server',  'value' => 'specific.server.local' },
+#   }
+#   ```
+#
+# @param env
+#   Value of environment option in puppet.conf which defaults to the
+#   environment of the current puppet run. By setting this parameter, you
+#   can specify an environment on the command line (`puppet agent -t
+#   --environment foo`) and it will not trigger a change to the puppet.conf.
+#
+# @param graph
+#   Value of the graph option in puppet.conf.
+#
+# @param run_at_boot
+#   Determine if a cron job should present that will run the puppet agent at
+#   boot time.
+#
+# @param run_every_thirty
+#   Determines if a cron job to run the puppet agent every thirty minutes
+#   should be present.
+#
+# @param run_in_noop
+#   Determines if the puppet agent should run in noop mode. This is done by
+#   appending '--noop' to the `cron_command` parameter.
+#
+# @param server
+#   The name of the puppet server.
+#
 class puppet (
-  String                                  $certname = $::fqdn,
+  String                                  $certname = $facts['networking']['fqdn'],
   Variant[Enum['true', 'false'], Boolean] $run_every_thirty = true, #lint:ignore:quoted_booleans
   Variant[Enum['true', 'false'], Boolean] $run_in_noop = true, #lint:ignore:quoted_booleans
-  String                                  $cron_command = '/opt/puppetlabs/bin/puppet agent --onetime --no-daemonize --no-usecacheonfailure --detailed-exitcodes --no-splay',
+  String                                  $cron_command = '/opt/puppetlabs/bin/puppet agent --onetime --no-daemonize --no-usecacheonfailure --detailed-exitcodes --no-splay', #lint:ignore:140chars
   Variant[Enum['true', 'false'], Boolean] $run_at_boot = true, #lint:ignore:quoted_booleans
   String                                  $config_path = '/etc/puppetlabs/puppet/puppet.conf',
   String                                  $server = 'puppet',
@@ -16,7 +68,6 @@
   String                                  $agent_sysconfig_path = '/etc/sysconfig/puppet',
   Hash                                    $custom_settings = {},
 ) {
-
   if $config_path != undef {
     validate_absolute_path($config_path)
   }
@@ -46,7 +97,7 @@
   if $run_every_thirty_bool == true {
     $cron_run_one = fqdn_rand(30)
     $cron_run_two = fqdn_rand(30) + 30
-    $cron_minute  = [ $cron_run_one, $cron_run_two]
+    $cron_minute  = [$cron_run_one, $cron_run_two]
     $cron_ensure  = 'present'
   } else {
     $cron_ensure = 'absent'
@@ -82,18 +133,18 @@
 
   $ini_defaults = {
     ensure  => 'present',
-    path    => $::puppet::config_path,
+    path    => $puppet::config_path,
     section => 'main',
     require => File['puppet_config'],
   }
 
   $ini_settings = {
-    'server'              => { setting => 'server', value => $server,},
-    'ca_server'           => { setting => 'ca_server', value => $ca_server,},
-    'certname'            => { setting => 'certname', value => $certname,},
-    'environment'         => { setting => 'environment', value => $env,},
-    'trusted_node_data'   => { setting => 'trusted_node_data', value => true,},
-    'graph'               => { setting => 'graph', value => $graph,},
+    'server'              => { setting => 'server', value => $server },
+    'ca_server'           => { setting => 'ca_server', value => $ca_server },
+    'certname'            => { setting => 'certname', value => $certname },
+    'environment'         => { setting => 'environment', value => $env },
+    'trusted_node_data'   => { setting => 'trusted_node_data', value => true },
+    'graph'               => { setting => 'graph', value => $graph },
   }
   create_resources('ini_setting', $ini_settings, $ini_defaults)
   create_resources('ini_setting', $custom_settings, $ini_defaults)

manifests/server.pp

@@ -2,39 +2,60 @@
 #
 # Manages puppetserver
 #
-class puppet::server(
+# @param autosign_entries
+#   Optional array of entries that will be autosigned.
+#
+# @param ca
+#   Determines if the system is a puppet CA (certificate authority).
+#   There should be only one CA per cluster of puppet masters.
+#
+# @param dns_alt_names
+#   Value of the dns_alt_names option in puppet.conf.
+#
+# @param enc
+#   The absolute path to an ENC. If this is set, it will be the value
+#   for the external_nodes option in puppet.conf and the node_terminus
+#   option will be set to 'exec'.
+#
+# @param memory_size
+#   The amount of memory allocated to the puppetserver. This is passed
+#   to the Xms and Xmx arguments for java. It must be a whole number
+#   followed by the unit 'm' for MB or 'g' for GB.
+#
+# @param sysconfig_path
+#   The absolute path to the puppetserver sysconfig file.
+#
+class puppet::server (
   Variant[Enum['true', 'false'], Boolean] $ca = false, #lint:ignore:quoted_booleans
   Variant[Array[String, 1], Undef]        $autosign_entries = undef,
   String                                  $sysconfig_path = '/etc/sysconfig/puppetserver',
   String                                  $memory_size = '2g', # only m and g are appropriate for unit
   Optional[String]                        $enc = undef,
   Optional[String]                        $dns_alt_names = undef,
 ) {
-
-  include ::puppet
+  include puppet
 
   if $sysconfig_path != undef {
     validate_absolute_path($sysconfig_path)
   }
 
-  validate_re($memory_size, '^\d+(m|g)$',
-    "puppet::memory_size is <${memory_size}> and must be an integer following by the unit 'm' or 'g'.")
+  validate_re($memory_size, '^\d+(m|g)$', "puppet::memory_size is <${memory_size}> and must be an integer following by the unit 'm' or 'g'.") #lint:ignore:140chars
 
   $ini_defaults = {
     ensure  => 'present',
-    path    => $::puppet::config_path,
+    path    => $puppet::config_path,
     section => 'master',
     require => File['puppet_config'],
     notify  => Service['puppetserver'],
   }
 
   $non_conditional_ini_settings = {
-    'vardir'  => { setting => 'vardir', value => '/opt/puppetlabs/server/data/puppetserver',},
-    'logdir'  => { setting => 'logdir', value => '/var/log/puppetlabs/puppetserver',},
-    'rundir'  => { setting => 'rundir', value => '/var/run/puppetlabs/puppetserver',},
-    'pidfile' => { setting => 'pidfile', value => '/var/run/puppetlabs/puppetserver/puppetserver.pid',},
-    'codedir' => { setting => 'codedir', value =>'/etc/puppetlabs/code',},
-    'ca'      => { setting => 'ca', value => $ca,},
+    'vardir'  => { setting => 'vardir', value => '/opt/puppetlabs/server/data/puppetserver' },
+    'logdir'  => { setting => 'logdir', value => '/var/log/puppetlabs/puppetserver' },
+    'rundir'  => { setting => 'rundir', value => '/var/run/puppetlabs/puppetserver' },
+    'pidfile' => { setting => 'pidfile', value => '/var/run/puppetlabs/puppetserver/puppetserver.pid' },
+    'codedir' => { setting => 'codedir', value => '/etc/puppetlabs/code' },
+    'ca'      => { setting => 'ca', value => $ca },
   }
 
   if $enc != undef {