foreman_maintain 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9cf2de71b1fd3ab00b7305e517b1529428af64ef
-  data.tar.gz: 5fe408d0a49b4e196c27d81cf9e732fd994358a2
+SHA256:
+  metadata.gz: a4e65df7ebef0968a8e42c0d8bcc643b46dfb2855dd2d7c89124004370b63e15
+  data.tar.gz: 6f18c7e5ed3415ecf1bfe1e75bc13bb437aab40a95d06493e531a5d500d99d95
 SHA512:
-  metadata.gz: 2588c117972fcc18c28fd503b945a9f00313906df3ac225af45ccb0a973e406d31bddd191d84937e3778718fae7e9a45cb7c2b57c812815a65f8922d29b0519b
-  data.tar.gz: 8973ea5b1105d668c3e493cb49e68c95e01bccb298f6fa7c2fa702dd629b781d460aca39a72a8a20d5e6e68e8c92adb6dd3e2678e960f1d976d9d23fcfd6708c
+  metadata.gz: c51b1f7d04a9df33f4c5b0e82c3df17f51162942eee4a4df61a2fe8930f8118d03b35c0f21de56a208662dee0b259e980a9552785d3f83bb6fd60f7422f5e943
+  data.tar.gz: 81e2b0db0d04283cc4ec49b778dc7fdb783ef0b462f826230713fa77a2c6425f54f93283706f4c24886d9d0c4e195dc39f403b0707e83ff5a7df673788b89c54

data/definitions/checks/pulpcore/db_up.rb

@@ -0,0 +1,29 @@
+module Checks
+  module Pulpcore
+    class DBUp < ForemanMaintain::Check
+      metadata do
+        description 'Make sure Pulpcore DB is up'
+        label :pulpcore_db_up
+        for_feature :pulpcore_database
+      end
+
+      def run
+        status = false
+        with_spinner('Checking connection to the Pulpcore DB') do
+          status = feature(:pulpcore_database).ping
+        end
+        assert(status, 'Pulpcore DB is not responding. ' \
+          'It needs to be up and running to perform the following steps',
+               :next_steps => next_steps)
+      end
+
+      def next_steps
+        if feature(:pulpcore_database).local?
+          [Procedures::Service::Start.new(:only => 'postgresql')]
+        else
+          [] # there is nothing we can do for remote db
+        end
+      end
+    end
+  end
+end

data/definitions/features/foreman_database.rb

@@ -16,9 +16,11 @@ class Features::ForemanDatabase < ForemanMaintain::Feature
   end
 
   def config_files
-    [
-      '/var/lib/pgsql/data/postgresql.conf'
-    ]
+    if check_min_version('foreman', '2.0')
+      ['/var/opt/rh/rh-postgresql12/lib/pgsql/data/postgresql.conf']
+    else
+      ['/var/lib/pgsql/data/postgresql.conf']
+    end
   end
 
   def services

data/definitions/features/foreman_tasks.rb

@@ -162,8 +162,13 @@ class Features::ForemanTasks < ForemanMaintain::Feature
   def export_csv(sql, file_name, state)
     dir = prepare_for_backup(state)
     filepath = "#{dir}/#{file_name}"
-    execute("echo \"COPY (#{sql}) TO STDOUT WITH CSV;\" \
-      | su - postgres -c '/usr/bin/psql -d foreman' | bzip2 -9 > #{filepath}.bz2")
+    csv_output = feature(:foreman_database).query_csv(sql)
+    File.open(filepath, 'w') do |f|
+      f.write(csv_output)
+      f.close
+    end
+    execute("bzip2 #{filepath} -c -9 > #{filepath}.bz2")
+    FileUtils.rm_rf(filepath)
   end
 
   def old_tasks_condition(state = "'stopped', 'paused'")

data/definitions/features/instance.rb

@@ -37,7 +37,9 @@ class Features::Instance < ForemanMaintain::Feature
   end
 
   def postgresql_local?
-    database_local?(:candlepin_database) || database_local?(:foreman_database)
+    database_local?(:candlepin_database) ||
+      database_local?(:foreman_database) ||
+      database_local?(:pulpcore_database)
   end
 
   def foreman_proxy_with_content?
@@ -65,7 +67,7 @@ class Features::Instance < ForemanMaintain::Feature
   end
 
   def pulp
-    feature(:pulp2) || feature(:pulp3)
+    feature(:pulp2) || feature(:pulpcore)
   end
 
   private
@@ -143,6 +145,7 @@ class Features::Instance < ForemanMaintain::Feature
       'candlepin' => %w[candlepin candlepin_database],
       'pulp_auth' => %w[pulp2 mongo],
       'pulp' => %w[pulp2 mongo],
+      'pulpcore' => %w[pulpcore pulpcore_database],
       'foreman_tasks' => %w[foreman_tasks]
     }
   end

data/definitions/features/{pulp3.rb → pulpcore.rb}

@@ -1,8 +1,8 @@
 require 'foreman_maintain/utils/service/systemd'
 
-class Features::Pulp3 < ForemanMaintain::Feature
+class Features::Pulpcore < ForemanMaintain::Feature
   metadata do
-    label :pulp3
+    label :pulpcore
 
     confine do
       ForemanMaintain::Utils::Service::Systemd.new('pulpcore-api', 0).exist?
@@ -11,12 +11,18 @@ class Features::Pulp3 < ForemanMaintain::Feature
 
   def services
     [
+      system_service('rh-redis5-redis', 5),
       system_service('pulpcore-api', 10),
       system_service('pulpcore-content', 10),
       system_service('pulpcore-resource-manager', 10),
       system_service('pulpcore-worker@*', 20, :all => true, :skip_enablement => true),
-      system_service('rh-redis5-redis', 30),
       system_service('httpd', 30)
     ]
   end
+
+  def config_files
+    [
+      '/etc/pulp/settings.py'
+    ]
+  end
 end

data/definitions/features/pulpcore_database.rb

@@ -0,0 +1,39 @@
+class Features::PulpcoreDatabase < ForemanMaintain::Feature
+  PULPCORE_DB_CONFIG = '/etc/pulp/settings.py'.freeze
+
+  include ForemanMaintain::Concerns::BaseDatabase
+
+  metadata do
+    label :pulpcore_database
+
+    confine do
+      file_nonzero?(PULPCORE_DB_CONFIG)
+    end
+  end
+
+  def configuration
+    @configuration || load_configuration
+  end
+
+  def services
+    [
+      system_service('postgresql', 10, :component => 'pulpcore',
+                                       :db_feature => feature(:pulpcore_database))
+    ]
+  end
+
+  private
+
+  def load_configuration
+    full_config = File.read(PULPCORE_DB_CONFIG).split(/[\s,'":]/).reject(&:empty?)
+
+    @configuration = {}
+    @configuration['adapter'] = 'postgresql'
+    @configuration['host'] = full_config[full_config.index('HOST') + 1]
+    @configuration['port'] = full_config[full_config.index('PORT') + 1]
+    @configuration['database'] = full_config[full_config.index('NAME') + 1]
+    @configuration['username'] = full_config[full_config.index('USER') + 1]
+    @configuration['password'] = full_config[full_config.index('PASSWORD') + 1]
+    @configuration
+  end
+end

data/definitions/features/tar.rb

@@ -38,6 +38,7 @@ class Features::Tar < ForemanMaintain::Feature
   # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
   def tar_command(options)
     volume_size = options.fetch(:volume_size, nil)
+    absolute_names = options.fetch(:absolute_names, nil)
     validate_volume_size(volume_size) unless volume_size.nil?
 
     tar_command = ['tar']
@@ -45,6 +46,10 @@ class Features::Tar < ForemanMaintain::Feature
     tar_command << "--#{options.fetch(:command, 'create')}"
     tar_command << "--file=#{options.fetch(:archive)}"
 
+    if absolute_names
+      tar_command << '--absolute-names'
+    end
+
     if volume_size
       split_tar_script = default_split_tar_script
       tar_command << "--tape-length=#{volume_size}"

data/definitions/procedures/backup/offline/pulpcore_db.rb

@@ -0,0 +1,57 @@
+module Procedures::Backup
+  module Offline
+    class PulpcoreDB < ForemanMaintain::Procedure
+      metadata do
+        description 'Backup Pulpcore DB offline'
+        tags :backup
+        label :backup_offline_pulpcore_db
+        for_feature :pulpcore_database
+        preparation_steps { Checks::Pulpcore::DBUp.new unless feature(:pulpcore_database).local? }
+        param :backup_dir, 'Directory where to backup to', :required => true
+        param :tar_volume_size, 'Size of tar volume (indicates splitting)'
+        param :mount_dir, 'Snapshot mount directory'
+      end
+
+      def run
+        if feature(:pulpcore_database).local?
+          if File.exist?(pg_backup_file)
+            puts 'Already done'
+          else
+            local_backup
+          end
+        else
+          puts "Backup of #{pg_data_dir} is not supported for remote databases." \
+            ' Doing postgres dump instead...'
+          with_spinner('Getting Pulpcore DB dump') do
+            feature(:pulpcore_database).dump_db(File.join(@backup_dir, 'pulpcore.dump'))
+          end
+        end
+      end
+
+      private
+
+      def local_backup
+        with_spinner("Collecting data from #{pg_data_dir}") do
+          feature(:pulpcore_database).backup_local(
+            pg_backup_file,
+            :listed_incremental => File.join(@backup_dir, '.postgres.snar'),
+            :volume_size => @tar_volume_size,
+            :data_dir => pg_data_dir
+          )
+        end
+      end
+
+      def pg_backup_file
+        File.join(@backup_dir, 'pgsql_data.tar')
+      end
+
+      def pg_data_dir
+        return feature(:pulpcore_database).data_dir if @mount_dir.nil?
+        mount_point = File.join(@mount_dir, 'pgsql')
+        dir = feature(:pulpcore_database).find_base_directory(mount_point)
+        fail!("Snapshot of Pulpcore DB was not found mounted in #{mount_point}") if dir.nil?
+        dir
+      end
+    end
+  end
+end

data/definitions/procedures/backup/online/pulpcore_db.rb

@@ -0,0 +1,20 @@
+module Procedures::Backup
+  module Online
+    class PulpcoreDB < ForemanMaintain::Procedure
+      metadata do
+        description 'Backup Pulpcore database online'
+        tags :backup
+        label :backup_online_pulpcore_db
+        for_feature :pulpcore_database
+        preparation_steps { Checks::Pulpcore::DBUp.new }
+        param :backup_dir, 'Directory where to backup to', :required => true
+      end
+
+      def run
+        with_spinner('Getting Pulpcore DB dump') do
+          feature(:pulpcore_database).dump_db(File.join(@backup_dir, 'pulpcore.dump'))
+        end
+      end
+    end
+  end
+end

data/definitions/procedures/backup/snapshot/logical_volume_confirmation.rb

@@ -16,6 +16,7 @@ module Procedures::Backup
         dbs[:mongo] = 'Mongo' if db_local?(:mongo)
         dbs[:candlepin_database] = 'Candlepin' if db_local?(:candlepin_database)
         dbs[:foreman_database] = 'Foreman' if db_local?(:foreman_database)
+        dbs[:pulpcore_database] = 'Pulpcore' if db_local?(:pulpcore_database)
 
         shared_lv = dbs.inject([]) do |list, (db_label, db_name)|
           db_lv = get_lv_info(feature(db_label).data_dir)

data/definitions/procedures/backup/snapshot/mount_pulpcore_db.rb

@@ -0,0 +1,48 @@
+require 'procedures/backup/snapshot/mount_base'
+module Procedures::Backup
+  module Snapshot
+    class MountPulpcoreDB < MountBase
+      metadata do
+        description 'Create and mount snapshot of Pulpcore DB'
+        tags :backup
+        label :backup_snapshot_mount_pulpcore_db
+        for_feature :pulpcore_database
+        preparation_steps { Checks::Pulpcore::DBUp.new unless feature(:pulpcore_database).local? }
+        MountBase.common_params(self)
+        param :backup_dir, 'Directory where to backup to'
+      end
+
+      def run
+        if feature(:pulpcore_database).local?
+          snapshot
+        else
+          dump_pulpcore
+        end
+      end
+
+      private
+
+      def dump_pulpcore
+        puts 'LV snapshots are not supported for remote databases. Doing postgres dump instead... '
+        with_spinner('Getting Pulpcore DB dump') do
+          feature(:pulpcore_database).dump_db(File.join(@backup_dir, 'pulpcore.dump'))
+        end
+      end
+
+      def snapshot
+        mount_point = mount_location('pgsql')
+        FileUtils.mkdir_p(mount_point) unless File.directory?(mount_point)
+        if directory_empty?(mount_point)
+          with_spinner('Creating snapshot of Postgres') do |spinner|
+            lv_info = get_lv_info(feature(:pulpcore_database).data_dir)
+            create_lv_snapshot('pgsql-snap', @block_size, lv_info[0])
+            spinner.update("Mounting snapshot of Postgres on #{mount_point}")
+            mount_snapshot('pgsql', lv_info[1])
+          end
+        else
+          puts 'Snapshot of Postgres is already mounted'
+        end
+      end
+    end
+  end
+end

data/definitions/procedures/content/prepare.rb

@@ -2,7 +2,7 @@ module Procedures::Content
   class Prepare < ForemanMaintain::Procedure
     metadata do
       description 'Prepare content for Pulp 3'
-      for_feature :pulp3
+      for_feature :pulpcore
     end
 
     def run

data/definitions/procedures/content/switchover.rb

@@ -0,0 +1,18 @@
+module Procedures::Content
+  class Switchover < ForemanMaintain::Procedure
+    metadata do
+      description 'Switch support for certain content from Pulp 2 to Pulp 3'
+      for_feature :pulpcore
+    end
+
+    def run
+      execute!('foreman-rake katello:pulp3_migration')
+      execute!('foreman-rake katello:pulp3_post_migration_check')
+      execute!('foreman-rake katello:pulp3_content_switchover')
+      args = ['--foreman-proxy-content-proxy-pulp-isos-to-pulpcore=true',
+              '--katello-use-pulp-2-for-file=false',
+              '--katello-use-pulp-2-for-docker=false']
+      feature(:installer).run(args.join(' '))
+    end
+  end
+end

data/definitions/procedures/packages/installer_confirmation.rb

@@ -5,7 +5,7 @@ module Procedures::Packages
     end
 
     def run
-      question = "WARNING: This script runs #{feature(:installer).installer_command} " \
+      question = "\nWARNING: This script runs #{feature(:installer).installer_command} " \
         "after the yum execution \n" \
         "to ensure the #{feature(:instance).product_name} " \
         "is in a consistent state.\n" \

data/definitions/procedures/packages/update_all_confirmation.rb

@@ -0,0 +1,24 @@
+module Procedures::Packages
+  class UpdateAllConfirmation < ForemanMaintain::Procedure
+    metadata do
+      param :packages, 'List of packages to update', :array => true
+
+      description 'Confirm update all is intentional'
+    end
+
+    def run
+      if @packages.nil? || @packages.empty?
+        question = "\nWARNING: No specific packages to update were provided\n" \
+          "so we are going to update all available packages.\n" \
+          "It is recommended to update everything only as part of upgrade\n" \
+          "of the #{feature(:instance).product_name} to the next version. \n" \
+          "To Upgrade to next version use 'foreman-maintain upgrade'.\n\n" \
+          "NOTE: --assumeyes is not applicable for this check\n\n" \
+          "Do you want to proceed with update of everything regardless\n" \
+          'of the recommendations?'
+        answer = ask_decision(question, 'y(yes), q(quit)', ignore_assumeyes: true)
+        abort! unless answer == :yes
+      end
+    end
+  end
+end

data/definitions/procedures/pulpcore/migrate.rb

@@ -0,0 +1,25 @@
+module Procedures::Pulpcore
+  class Migrate < ForemanMaintain::Procedure
+    include ForemanMaintain::Concerns::SystemService
+
+    metadata do
+      description 'Migrate pulpcore db'
+      for_feature :pulpcore
+    end
+
+    def run
+      with_spinner('Migrating pulpcore') do |spinner|
+        necessary_services = feature(:pulpcore_database).services
+        pulp_services = feature(:pulpcore).services
+
+        feature(:service).handle_services(spinner, 'start', :only => necessary_services)
+        feature(:service).handle_services(spinner, 'stop', :only => pulp_services)
+
+        spinner.update('Migrating pulpcore database')
+        execute!('sudo PULP_SETTINGS=/etc/pulp/settings.py '\
+          'DJANGO_SETTINGS_MODULE=pulpcore.app.settings '\
+          'python3-django-admin migrate --noinput')
+      end
+    end
+  end
+end

data/definitions/procedures/restore/drop_databases.rb

@@ -8,7 +8,7 @@ module Procedures::Restore
             :required => true
 
       confine do
-        feature(:foreman_database) || feature(:candlepin_database)
+        feature(:foreman_database) || feature(:candlepin_database) || feature(:pulpcore_database)
       end
     end
 
@@ -19,6 +19,9 @@ module Procedures::Restore
         feature(:service).handle_services(spinner, 'start', :only => ['postgresql'])
         drop_foreman(backup, spinner)
         drop_candlepin(backup, spinner)
+        if feature(:pulpcore)
+          drop_pulpcore(backup, spinner)
+        end
       end
     end
 
@@ -35,5 +38,12 @@ module Procedures::Restore
         feature(:candlepin_database).dropdb
       end
     end
+
+    def drop_pulpcore(backup, spinner)
+      if backup.file_map[:pulpcore_dump][:present]
+        spinner.update('Dropping pulpcore database')
+        feature(:pulpcore_database).dropdb
+      end
+    end
   end
 end