Parameter for setting final state of agents

Provides a parameter in plans peadm::install and
peadm::subplans::configure which can be used to set the final state of
the puppet agent which runs on infrastructure nodes. Allows for stopped
or running states only.

Author: ody

plans/install.pp

@@ -21,6 +21,9 @@
 #   The parameter should be set to a valid set of connection settings as
 #   documented for the PE RBAC /ds endpoint. See:
 #   https://puppet.com/docs/pe/latest/rbac_api_v1_directory.html#put_ds-request_format
+# @param final_agent_state
+#   Configures the state the puppet agent should be in on infrastructure nodes
+#   after PE is configured successfully.
 #
 plan peadm::install (
   # Standard
@@ -56,10 +59,11 @@
   Optional[String]                  $license_key_content = undef,
 
   # Other
-  Optional[String]                  $stagingdir             = undef,
-  Enum[direct,bolthost]             $download_mode          = 'bolthost',
-  Boolean                           $permit_unsafe_versions = false,
-  String                            $token_lifetime         = '1y',
+  Optional[String]           $stagingdir             = undef,
+  Enum['running', 'stopped'] $final_agent_state      = 'running',
+  Enum['direct', 'bolthost'] $download_mode          = 'bolthost',
+  Boolean                    $permit_unsafe_versions = false,
+  String                     $token_lifetime         = '1y',
 ) {
   peadm::assert_supported_bolt_version()
 
@@ -121,6 +125,7 @@
 
     # Other
     stagingdir                       => $stagingdir,
+    final_agent_state                => $final_agent_state,
   )
 
   # Return a string banner reporting on what was done

plans/subplans/configure.pp

@@ -16,6 +16,9 @@
 # @param ldap_config
 #   This hash contains the options necessary for configuring the LDAP
 #   connection on the main server.
+# @param final_agent_state
+#   Configures the state the puppet agent should be in on infrastructure nodes
+#   after PE is configured successfully.
 #
 plan peadm::subplans::configure (
   # Standard
@@ -30,15 +33,16 @@
   Optional[Peadm::SingleTargetSpec] $replica_postgresql_host = undef,
 
   # Common Configuration
-  String                       $compiler_pool_address = $primary_host.peadm::certname(),
+  String                       $compiler_pool_address            = $primary_host.peadm::certname(),
   Optional[String]             $internal_compiler_a_pool_address = undef,
   Optional[String]             $internal_compiler_b_pool_address = undef,
-  Optional[String]             $token_file = undef,
-  Optional[String]             $deploy_environment = undef,
-  Optional[Peadm::Ldap_config] $ldap_config = undef,
+  Optional[String]             $token_file                       = undef,
+  Optional[String]             $deploy_environment               = undef,
+  Optional[Peadm::Ldap_config] $ldap_config                      = undef,
 
   # Other
-  String           $stagingdir = '/tmp',
+  String           $stagingdir                   = '/tmp',
+  Enum['running', 'stopped'] $final_agent_state  = 'running'
 ) {
   # TODO: get and validate PE version
 
@@ -147,7 +151,11 @@
   }
 
   # Ensure Puppet agent service is running now that configuration is complete
-  run_command('systemctl start puppet', peadm::flatten_compact([
+  $systemctl_state = $final_agent_state ? {
+    'running' => 'start',
+    'stopped' => 'stop'
+  }
+  run_command("systemctl ${systemctl_state} puppet", peadm::flatten_compact([
     $primary_target,
     $replica_target,
     $primary_postgresql_target,