Fixes #32891 - Add feature to enable new tasking system and enable it by default

manifests/init.pp

@@ -132,6 +132,11 @@
 #   available, likely results in performance degradation due to I/O blocking and is not recommended in most cases. Modifying this parameter should
 #   be done incrementally with benchmarking at each step to determine an optimal value for your deployment.
 #
+# @param use_rq_tasking_system
+#   Use the older RQ workers tasking system instead of the newer PostgreSQL tasking system introduced in Pulpcore 3.14.
+#   Any benchmarking you did to optimize worker_count or other tasking related parameters will no longer be accurate after changing the tasking system.
+#   Do not modify this setting unless you understand the implications for performance and stability.
+#
 # @param service_enable
 #   Enable/disable Pulp services at boot.
 #
@@ -203,6 +208,7 @@
   Pulpcore::ChecksumTypes $allowed_content_checksums = ['sha224', 'sha256', 'sha384', 'sha512'],
   String[1] $remote_user_environ_name = 'HTTP_REMOTE_USER',
   Integer[0] $worker_count = min(8, $facts['processors']['count']),
+  Boolean $use_rq_tasking_system = false,
   Boolean $service_enable = true,
   Boolean $service_ensure = true,
   Integer[0] $content_service_worker_count = (2*min(8, $facts['processors']['count']) + 1),

manifests/service.pp

@@ -18,10 +18,18 @@
     service_content => template('pulpcore/pulpcore-content.service.erb'),
   }
 
-  systemd::unit_file { 'pulpcore-resource-manager.service':
-    content => template('pulpcore/pulpcore-resource-manager.service.erb'),
-    active  => $pulpcore::service_ensure,
-    enable  => $pulpcore::service_enable,
+  if $pulpcore::use_rq_tasking_system {
+    systemd::unit_file { 'pulpcore-resource-manager.service':
+      content => template('pulpcore/pulpcore-resource-manager.service.erb'),
+      active  => $pulpcore::service_ensure,
+      enable  => $pulpcore::service_enable,
+    }
+  } else {
+    systemd::unit_file { 'pulpcore-resource-manager.service':
+      ensure => 'absent',
+      active => false,
+      enable => false,
+    }
   }
 
   systemd::unit_file { '[email protected]':

spec/acceptance/basic_spec.rb

@@ -29,8 +29,8 @@ class { 'pulpcore':
   end
 
   describe service('pulpcore-resource-manager') do
-    it { is_expected.to be_enabled }
-    it { is_expected.to be_running }
+    it { is_expected.not_to be_enabled }
+    it { is_expected.not_to be_running }
   end
 
   describe service('pulpcore-worker@1') do
@@ -73,6 +73,17 @@ class { 'pulpcore':
     its(:body) { is_expected.to contain('artifacts_list') }
     its(:exit_status) { is_expected.to eq 0 }
   end
+
+  describe command("PULP_SETTINGS=/etc/pulp/settings.py pulpcore-manager diffsettings") do
+    its(:stdout) { is_expected.to match(/^USE_NEW_WORKER_TYPE = True/) }
+    its(:exit_status) { is_expected.to eq 0 }
+  end
+
+  describe command("DJANGO_SETTINGS_MODULE=pulpcore.app.settings PULP_SETTINGS=/etc/pulp/settings.py rq info -c pulpcore.rqconfig") do
+    its(:stdout) { is_expected.to match(/^0 workers, /) }
+    its(:stdout) { is_expected.not_to match(/^resource-manager /) }
+    its(:exit_status) { is_expected.to eq 0 }
+  end
 end
 
 describe 'reducing worker count' do
@@ -102,8 +113,8 @@ class { 'pulpcore':
   end
 
   describe service('pulpcore-resource-manager') do
-    it { is_expected.to be_enabled }
-    it { is_expected.to be_running }
+    it { is_expected.not_to be_enabled }
+    it { is_expected.not_to be_running }
   end
 
   describe service('pulpcore-worker@1') do

spec/acceptance/disable_new_tasking_system_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper_acceptance'
+
+describe 'change configuration from postgresql tasking system to rq tasking system', :order => :defined do
+  certdir = '/etc/pulpcore-certs'
+
+  context 'initial configuration with newer postgresql tasking system' do
+    it_behaves_like 'an idempotent resource' do
+      let(:manifest) do
+        <<-PUPPET
+        class { 'pulpcore':
+          worker_count          => 1,
+          use_rq_tasking_system => false,
+        }
+        PUPPET
+      end
+    end
+
+    describe service('httpd') do
+      it { is_expected.to be_enabled }
+      it { is_expected.to be_running }
+    end
+
+    describe service('pulpcore-api') do
+      it { is_expected.to be_enabled }
+      it { is_expected.to be_running }
+    end
+
+    describe service('pulpcore-content') do
+      it { is_expected.to be_enabled }
+      it { is_expected.to be_running }
+    end
+
+    describe file('/etc/systemd/system/pulpcore-resource-manager.service') do
+      it { is_expected.not_to exist }
+    end
+
+    describe service('pulpcore-resource-manager') do
+      it { is_expected.not_to be_enabled }
+      it { is_expected.not_to be_running }
+    end
+
+    describe service('pulpcore-worker@1') do
+      it { is_expected.to be_enabled }
+      it { is_expected.to be_running }
+    end
+
+    describe port(80) do
+      it { is_expected.to be_listening }
+    end
+
+    describe port(443) do
+      it { is_expected.to be_listening }
+    end
+
+    describe curl_command("https://#{host_inventory['fqdn']}/pulp/api/v3/status/", cacert: "#{certdir}/ca-cert.pem") do
+      its(:response_code) { is_expected.to eq(200) }
+      its(:exit_status) { is_expected.to eq 0 }
+    end
+
+    describe command("PULP_SETTINGS=/etc/pulp/settings.py pulpcore-manager diffsettings") do
+      its(:stdout) { is_expected.to match(/^USE_NEW_WORKER_TYPE = True/) }
+      its(:exit_status) { is_expected.to eq 0 }
+    end
+
+    describe command("DJANGO_SETTINGS_MODULE=pulpcore.app.settings PULP_SETTINGS=/etc/pulp/settings.py rq info -c pulpcore.rqconfig") do
+      its(:stdout) { is_expected.to match(/^0 workers, /) }
+      its(:stdout) { is_expected.not_to match(/^resource-manager /) }
+      its(:exit_status) { is_expected.to eq 0 }
+    end
+  end
+
+  context 'reconfigure pulpcore to use older rq worker tasking system' do
+    it_behaves_like 'an idempotent resource' do
+      let(:manifest) do
+        <<-PUPPET
+        class { 'pulpcore':
+          worker_count          => 1,
+          use_rq_tasking_system => true,
+        }
+        PUPPET
+      end
+    end
+
+    describe service('httpd') do
+      it { is_expected.to be_enabled }
+      it { is_expected.to be_running }
+    end
+
+    describe service('pulpcore-api') do
+      it { is_expected.to be_enabled }
+      it { is_expected.to be_running }
+    end
+
+    describe service('pulpcore-content') do
+      it { is_expected.to be_enabled }
+      it { is_expected.to be_running }
+    end
+
+    describe file('/etc/systemd/system/pulpcore-resource-manager.service') do
+      it { is_expected.to exist }
+    end
+
+    describe service('pulpcore-resource-manager') do
+      it { is_expected.to be_enabled }
+      it { is_expected.to be_running }
+    end
+
+    describe service('pulpcore-worker@1') do
+      it { is_expected.to be_enabled }
+      it { is_expected.to be_running }
+    end
+
+    describe port(80) do
+      it { is_expected.to be_listening }
+    end
+
+    describe port(443) do
+      it { is_expected.to be_listening }
+    end
+
+    describe curl_command("https://#{host_inventory['fqdn']}/pulp/api/v3/status/", cacert: "#{certdir}/ca-cert.pem") do
+      its(:response_code) { is_expected.to eq(200) }
+      its(:exit_status) { is_expected.to eq 0 }
+    end
+
+    describe command("PULP_SETTINGS=/etc/pulp/settings.py pulpcore-manager diffsettings") do
+      its(:stdout) { is_expected.to match(/^USE_NEW_WORKER_TYPE = False/) }
+      its(:exit_status) { is_expected.to eq 0 }
+    end
+
+    describe command("DJANGO_SETTINGS_MODULE=pulpcore.app.settings PULP_SETTINGS=/etc/pulp/settings.py rq info -c pulpcore.rqconfig") do
+      its(:stdout) { is_expected.to match(/^2 workers, /) }
+      its(:stdout) { is_expected.to match(/^resource-manager /) }
+      its(:exit_status) { is_expected.to eq 0 }
+    end
+  end
+end

spec/acceptance/enable_new_tasking_system_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper_acceptance'
+
+describe 'change configuration from rq tasking system to postgresql tasking system', :order => :defined do
+  certdir = '/etc/pulpcore-certs'
+
+  context 'initial configuration with older rq worker tasking system' do
+    it_behaves_like 'an idempotent resource' do
+      let(:manifest) do
+        <<-PUPPET
+        class { 'pulpcore':
+          worker_count          => 1,
+          use_rq_tasking_system => true,
+        }
+        PUPPET
+      end
+    end
+
+    describe service('httpd') do
+      it { is_expected.to be_enabled }
+      it { is_expected.to be_running }
+    end
+
+    describe service('pulpcore-api') do
+      it { is_expected.to be_enabled }
+      it { is_expected.to be_running }
+    end
+
+    describe service('pulpcore-content') do
+      it { is_expected.to be_enabled }
+      it { is_expected.to be_running }
+    end
+
+    describe file('/etc/systemd/system/pulpcore-resource-manager.service') do
+      it { is_expected.to exist }
+    end
+
+    describe service('pulpcore-resource-manager') do
+      it { is_expected.to be_enabled }
+      it { is_expected.to be_running }
+    end
+
+    describe service('pulpcore-worker@1') do
+      it { is_expected.to be_enabled }
+      it { is_expected.to be_running }
+    end
+
+    describe port(80) do
+      it { is_expected.to be_listening }
+    end
+
+    describe port(443) do
+      it { is_expected.to be_listening }
+    end
+
+    describe curl_command("https://#{host_inventory['fqdn']}/pulp/api/v3/status/", cacert: "#{certdir}/ca-cert.pem") do
+      its(:response_code) { is_expected.to eq(200) }
+      its(:exit_status) { is_expected.to eq 0 }
+    end
+
+    describe command("PULP_SETTINGS=/etc/pulp/settings.py pulpcore-manager diffsettings") do
+      its(:stdout) { is_expected.to match(/^USE_NEW_WORKER_TYPE = False/) }
+      its(:exit_status) { is_expected.to eq 0 }
+    end
+
+    describe command("DJANGO_SETTINGS_MODULE=pulpcore.app.settings PULP_SETTINGS=/etc/pulp/settings.py rq info -c pulpcore.rqconfig") do
+      its(:stdout) { is_expected.to match(/^2 workers, /) }
+      its(:stdout) { is_expected.to match(/^resource-manager /) }
+      its(:exit_status) { is_expected.to eq 0 }
+    end
+  end
+
+  context 'reconfigure pulpcore to use newer postgresql tasking system' do
+    it_behaves_like 'an idempotent resource' do
+      let(:manifest) do
+        <<-PUPPET
+        class { 'pulpcore':
+          worker_count          => 1,
+          use_rq_tasking_system => false,
+        }
+        PUPPET
+      end
+    end
+
+    describe service('httpd') do
+      it { is_expected.to be_enabled }
+      it { is_expected.to be_running }
+    end
+
+    describe service('pulpcore-api') do
+      it { is_expected.to be_enabled }
+      it { is_expected.to be_running }
+    end
+
+    describe service('pulpcore-content') do
+      it { is_expected.to be_enabled }
+      it { is_expected.to be_running }
+    end
+
+    describe file('/etc/systemd/system/pulpcore-resource-manager.service') do
+      it { is_expected.not_to exist }
+    end
+
+    describe service('pulpcore-resource-manager') do
+      it { is_expected.not_to be_enabled }
+      it { is_expected.not_to be_running }
+    end
+
+    describe service('pulpcore-worker@1') do
+      it { is_expected.to be_enabled }
+      it { is_expected.to be_running }
+    end
+
+    describe port(80) do
+      it { is_expected.to be_listening }
+    end
+
+    describe port(443) do
+      it { is_expected.to be_listening }
+    end
+
+    describe curl_command("https://#{host_inventory['fqdn']}/pulp/api/v3/status/", cacert: "#{certdir}/ca-cert.pem") do
+      its(:response_code) { is_expected.to eq(200) }
+      its(:exit_status) { is_expected.to eq 0 }
+    end
+
+    describe command("PULP_SETTINGS=/etc/pulp/settings.py pulpcore-manager diffsettings") do
+      its(:stdout) { is_expected.to match(/^USE_NEW_WORKER_TYPE = True/) }
+      its(:exit_status) { is_expected.to eq 0 }
+    end
+
+    describe command("DJANGO_SETTINGS_MODULE=pulpcore.app.settings PULP_SETTINGS=/etc/pulp/settings.py rq info -c pulpcore.rqconfig") do
+      its(:stdout) { is_expected.to match(/^0 workers, /) }
+      its(:stdout) { is_expected.not_to match(/^resource-manager /) }
+      its(:exit_status) { is_expected.to eq 0 }
+    end
+  end
+end

spec/acceptance/plugins_spec.rb

@@ -37,8 +37,8 @@
   end
 
   describe service('pulpcore-resource-manager') do
-    it { is_expected.to be_enabled }
-    it { is_expected.to be_running }
+    it { is_expected.not_to be_enabled }
+    it { is_expected.not_to be_running }
   end
 
   describe port(80) do

spec/acceptance/use_pulp2_content_route_spec.rb

@@ -40,8 +40,8 @@ class { 'pulpcore::plugin::rpm':
   end
 
   describe service('pulpcore-resource-manager') do
-    it { is_expected.to be_enabled }
-    it { is_expected.to be_running }
+    it { is_expected.not_to be_enabled }
+    it { is_expected.not_to be_running }
   end
 
   describe port(80) do

spec/classes/pulpcore_spec.rb

@@ -128,7 +128,7 @@
           is_expected.to contain_systemd__unit_file('pulpcore-content.socket')
           is_expected.to contain_systemd__unit_file('pulpcore-content.service')
           is_expected.to contain_file('/etc/systemd/system/pulpcore-content.socket').that_comes_before('Service[pulpcore-content.service]')
-          is_expected.to contain_systemd__unit_file('pulpcore-resource-manager.service')
+          is_expected.to contain_systemd__unit_file('pulpcore-resource-manager.service').with_ensure('absent')
           is_expected.to contain_systemd__unit_file('[email protected]')
           is_expected.to contain_service("[email protected]").with_ensure(true)
           is_expected.not_to contain_service("[email protected]")

templates/settings.py.erb

@@ -23,6 +23,8 @@ REDIS_HOST = "localhost"
 REDIS_PORT = "<%= scope['redis::port'] %>"
 REDIS_DB = <%= scope['pulpcore::redis_db'] %>
 
+USE_NEW_WORKER_TYPE = <%= scope['pulpcore::use_rq_tasking_system'] ? "False" : "True" %>
+
 MEDIA_ROOT = "<%= scope['pulpcore::media_root'] %>"
 STATIC_ROOT = "<%= scope['pulpcore::static_root'] %>"
 STATIC_URL = "<%= scope['pulpcore::static_url'] %>"