(PA-5302) Remove puppet5 and MCollective

Puppet 5 has long been end-of-life and we no longer support it in
this module. This commit removes support and reference for Puppet 5
and MCollective, a service that was last provided in Puppet 5.

Author: mhashizume

README.md

@@ -64,9 +64,7 @@
 
 ## Overview
 
-A module for installing, running, upgrading, and managing the configuration of Puppet agents. Supports upgrading from Puppet 4 puppet-agent packages to later versions including Puppet 4, Puppet 5, and Puppet 6.
-
-Previous releases of this module, now unsupported, upgraded agents from later versions of Puppet 3 to Puppet 4.
+A module for installing, running, upgrading, and managing the configuration of Puppet agents. Supports upgrading from Puppet 6 puppet-agent packages to later versions including Puppet 7 and Puppet 8.
 
 ## Module Description
 
@@ -80,13 +78,13 @@ If a config parameter is provided, it will manage the defined agent configuratio
 
 ### What puppet_agent affects
 
-* Puppet, Facter, Hiera, and MCollective (MCollective is no longer included in Puppet 6 installs).
+* Puppet, Facter, and Hiera.
 * Puppet's SSL directory and puppet.conf.
 * Removes deprecated settings from puppet.conf.
 
 ### Setup requirements
 
-Your agents must be running a minimum version of Puppet 4. They should already be pointed at a master running Puppet Server 2.1 or greater, and thus successfully applying catalogs compiled with the Puppet 4 or newer language.
+Your agents must be running a minimum version of Puppet 6. They should already be pointed at a master running Puppet Server 6 or greater, and thus successfully applying catalogs compiled with the Puppet 6 or newer language.
 
 ### Beginning with puppet_agent
 
@@ -96,13 +94,13 @@ Install the puppet_agent module with `puppet module install puppetlabs-puppet_ag
 
 Add the class to agents you want to upgrade, specifying the desired puppet-agent version:
 
-~~~puppet
+``` puppet
 class {'::puppet_agent':
-  package_version => '1.4.0',
+  package_version => '7.23.0',
 }
-~~~
+```
 
-This will ensure the version `1.4.0` of the puppet-agent package is installed. For version `1.4.0` and later, it will also remove the deprecated `pluginsync` setting from `puppet.conf`, unless explicitly managed elsewhere.
+This will ensure the version `7.23.0` of the puppet-agent package is installed.
 
 ## Using alternate sources
 
@@ -153,16 +151,16 @@ If you are using puppetlabs-pe_repo to serve packages, but want to provide a loc
 
 ##### `arch`
 
-The architecture version you wish to install. Defaults to `$::facts['architecture']`.
+The architecture version you wish to install. Defaults to `$facts['os']['architecture']`.
 ``` puppet
   arch => 'x86_64'
 ```
 
 ##### `collection`
 
-The Puppet Collection to track, should be one of `puppet5`, `puppet6` or `puppet7`.  Puppet collections contain the latest agents included in the collection's series, so `puppet5` will pull in the most recent Puppet 5 release (for example: 5.5.10) as also will `puppet6` for Puppet 6 (for example: 6.3.0).  **This parameter is required for installations not connected to Puppet Enterprise**
+The Puppet Collection to track, should be a supported collection  (e.g. `puppet7` or `puppet8`).  Puppet collections contain the latest agents included in the collection's series, so `puppet7` will pull in the most recent Puppet 5 release (for example: 7.23.0).  **This parameter is required for installations not connected to Puppet Enterprise**
 ``` puppet
-  collection => 'puppet6'
+  collection => 'puppet7'
 ```
 
 ##### `is_pe`
@@ -185,7 +183,7 @@ and the native package providers will be used to query pre-configured repos on t
 
 The package version to upgrade to. This must be explicitly specified.
 ``` puppet
-  package_version => '5.5.10'
+  package_version => '7.23.0'
 ```
 or
 ``` puppet
@@ -221,14 +219,14 @@ Unix/MacOS
 
 Windows
 ``` puppet
-  source => 'C:/packages/puppet-agent-6.0.0-x64.msi'
+  source => 'C:/packages/puppet-agent-7.23.0-x64.msi'
 ```
 
 ##### `absolute_source`
 
 Absolute ("fully qualified") source path from which you wish to download the latest version of Puppet. No path structure or package name is assumed: the fully qualified path to the package itself must be provided.
 ``` puppet
-  absolute_source => 'C:/packages/puppet-agent-6.0.0-x64.msi'
+  absolute_source => 'C:/packages/puppet-agent-7.23.0-x64.msi'
 ```
 
 ##### `yum_source`

acceptance/helpers.rb

@@ -376,7 +376,7 @@ def remove_installed_agent(host)
             manifest_lines << "yumrepo { 'pc_repo': ensure => absent, notify => Package['puppet-agent'] }"
           end
 
-          manifest_lines << "file { ['/etc/puppet', '/etc/puppetlabs', '/etc/mcollective']: ensure => absent, force => true, backup => false }"
+          manifest_lines << "file { ['/etc/puppet', '/etc/puppetlabs']: ensure => absent, force => true, backup => false }"
 
           manifest_lines << if %r{^(osx|sles|solaris)}.match?(host['platform'])
                               # The macOS pkgdmg, SLES zypper, and Solaris sun providers don't support 'purged':

files/install_puppet.ps1

@@ -256,8 +256,7 @@ function Script:Reset-PuppetServices {
 $ErrorActionPreference = "Stop"
 $service_names=@(
   "puppet",
-  "pxp-agent",
-  "mcollective"
+  "pxp-agent"
 )
 try {
   $state_dir = (puppet.bat config print statedir --environment production)

lib/facter/mco_config.rb

@@ -67,9 +67,3 @@
     Puppet.settings['client_datadir']
   end
 end
-
-Facter.add('mco_confdir') do
-  setcode do
-    File.expand_path(File.join(Puppet.settings['confdir'], '../../mcollective/etc'))
-  end
-end

lib/facter/settings.rb

@@ -26,7 +26,7 @@
 #   The package version to upgrade to. Explicitly specify the version to upgrade to,
 #   or set to 'auto' to specify the version of the compiling master.
 # [service_names]
-#   An array of services to start, normally `puppet` and `mcollective`.
+#   An array of services to start, normally `puppet`.
 #   None will be started if the array is empty.
 # [source]
 #   **INCLUDED FOR COMPATIBILITY WITH MODULE VERSIONS 1.0/2.0. PREFER USE OF "absolute_source",

manifests/init.pp

@@ -16,12 +16,8 @@
     # The following are expected to be available in the solaris_install.sh.erb template:
     $adminfile = '/opt/puppetlabs/packages/solaris-noask'
     $sourcefile = "/opt/puppetlabs/packages/${_unzipped_package_name}"
-    # Starting with puppet6 and up collections we no longer carry the mcollective service
-    if $::puppet_agent::collection != 'PC1' and $::puppet_agent::collection != 'puppet5' {
-      $service_names = delete($::puppet_agent::service_names, 'mcollective')
-    } else {
-      $service_names = $::puppet_agent::service_names
-    }
+
+    $service_names = $::puppet_agent::service_names
 
     # Puppet prior to 5.0 would not use a separate process contract when forking from the Puppet
     # service. That resulted in service-initiated upgrades failing because trying to remove or

manifests/install/solaris.pp

@@ -9,9 +9,7 @@
     # Solaris 11 is a special case; it uses a custom script.
     $service_names = []
   } else {
-    # Mcollective will be removed from this list in the service manifest if
-    # the puppet version is >= 6.0.0
-    $service_names = ['puppet', 'mcollective']
+    $service_names = ['puppet']
   }
   if $facts['os']['family'] == 'windows' {
     $local_puppet_dir = windows_native_path("${::puppet_agent_appdata}/Puppetlabs")

manifests/params.pp

@@ -6,12 +6,7 @@
 class puppet_agent::service {
   assert_private()
 
-  # Starting with puppet6 and up collections we no longer carry the mcollective service
-  if versioncmp("${::clientversion}", '6.0.0') >= 0 {
-    $_service_names = delete($::puppet_agent::service_names, 'mcollective')
-  } else {
-    $_service_names = $::puppet_agent::service_names
-  }
+  $_service_names = $::puppet_agent::service_names
 
   if $facts['os']['name'] == 'Solaris' and $facts['os']['release']['major'] == '10' and versioncmp("${::clientversion}", '5.0.0') < 0 {
     # Skip managing service, upgrade script will handle it.

manifests/service.pp

@@ -27,23 +27,12 @@ class { 'puppet_agent': package_version => '5.5.21', collection => 'puppet5' }
     end
 
     if %r{windows}i.match?(default['platform'])
-      # MODULES-4244: MCollective not started after upgrade
-      describe service('mcollective') do
-        it { is_expected.not_to be_enabled }
-        it { is_expected.not_to be_running }
-      end
-
       describe service('puppet') do
         # PUPPET_AGENT_STARTUP_MODE=Manual
         it { is_expected.not_to be_enabled }
         it { is_expected.not_to be_running }
       end
     else
-      describe service('mcollective') do
-        it { is_expected.to be_enabled }
-        it { is_expected.to be_running }
-      end
-
       describe service('puppet') do
         it { is_expected.to be_enabled }
         it { is_expected.to be_running }
@@ -127,68 +116,9 @@ class { 'puppet_agent': service_names => [] }
     describe service('puppet') do
       it { is_expected.not_to be_running }
     end
-
-    describe service('mcollective') do
-      it { is_expected.not_to be_running }
-    end
   end
 
   unless %r{windows}i.match?(default['platform'])
-    # MODULES-4244: MCollective not started after upgrade
-    context 'with mcollective configured' do
-      before(:all) do
-        setup_puppet_on default, mcollective: true, agent: true
-        manifest = 'class { "puppet_agent": package_version => "5.5.21", collection => "puppet5", service_names => ["mcollective"] }'
-        pp = "file { '#{master.puppet['codedir']}/environments/production/manifests/site.pp': ensure => file, content => '#{manifest}' }"
-        apply_manifest_on(master, pp, catch_failures: true)
-      end
-      after(:all) do
-        pp = "file { '#{master.puppet['codedir']}/environments/production/manifests/site.pp': ensure => absent }"
-        apply_manifest_on(master, pp, catch_failures: true)
-        teardown_puppet_on default
-      end
-      # rubocop:disable RepeatedExample
-
-      it 'mco should be running' do
-        on default, 'mco ping' do
-          hostname = default.hostname.split('.', 2).first
-          assert_match(%r{^#{hostname}[.\w]*\s+time=}, stdout)
-        end
-      end
-      # rubocop:enable RepeatedExample
-
-      it 'works idempotently with no errors' do
-        pp = <<-EOS
-      class { 'puppet_agent':  collection => "puppet5", service_names => ["mcollective"] }
-        EOS
-
-        # Run it twice and test for idempotency
-        apply_manifest(pp, catch_failures: true)
-        wait_for_finish_on default
-        configure_agent_on default
-        apply_manifest(pp, catch_changes: true)
-        wait_for_finish_on default
-      end
-
-      describe package(package_name(default)) do
-        it { is_expected.to be_installed }
-      end
-
-      describe service('mcollective') do
-        it { is_expected.to be_enabled }
-        it { is_expected.to be_running }
-      end
-
-      # rubocop:disable RepeatedExample
-      it 'has mcollective correctly configured' do
-        on default, 'mco ping' do
-          hostname = default.hostname.split('.', 2).first
-          assert_match(%r{^#{hostname}[.\w]*\s+time=}, stdout)
-        end
-      end
-      # rubocop:enable RepeatedExample
-    end
-
     unless %r{solaris-10|aix|osx|windows}i.match?(default['platform'])
       context 'on platforms managed with the package resource' do
         before(:all) { setup_puppet_on default }