foreman_maintain 1.10.3 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd92aa45510fd828c1ff73193cffba5fba7f161842992465023d0028c0a2e80b
-  data.tar.gz: '011833c73f3200e6858dd572fbc1b2eaebaea64c803ebf60720dd516770cdae8'
+  metadata.gz: dfa2280e285e63ea4e7b6269dc6761598c17034fc9febfde0aca731b19a684c3
+  data.tar.gz: b83257b1cefd0ed6e6ad12205442b1817a2b2395b315b08f59a34c8b09833517
 SHA512:
-  metadata.gz: 011a42195a870265ce392f72c05f6e65a085491879850f59ccf137acdbb39c9963b0929d842b3e8fcb116ea8dd03c70cc296bdc252f7da2101281235923d99ca
-  data.tar.gz: 62f0782ce86392e56f9a49eb7ba6b076d817b812c0b19d1587e3a14cd359dd871367e486d68145771dcc9aec38fc7d6c38cc8c504700fb7ab6101b406e514112
+  metadata.gz: da581d87a81c7b38ab139245323e2ad3f9958fff5094c27b00ef28ff7e519741f18bb909388c660208ce2531ddc14bb39c7873deeacc1502d11185417f4bb321
+  data.tar.gz: 143cd40662be08087e1da5f2cb29c40dbe24bbecd19ea292c6c34394b218606aeb024ddd2757d7fbbbb0edfc5d1220b92dcde0596bd011be6e8ec2cc47274a3c

data/definitions/checks/container/podman_login.rb

@@ -0,0 +1,30 @@
+module Checks::Container
+  class PodmanLogin < ForemanMaintain::Check
+    metadata do
+      for_feature :satellite
+      confine do
+        feature(:satellite)&.connected? && feature(:containers)
+      end
+      description 'Check whether podman is logged in to registry'
+      tags :pre_upgrade
+    end
+
+    def run
+      login_status, _output = execute_with_status('podman login --get-login registry.redhat.io')
+      assert(
+        login_status == 0,
+        failure_message
+      )
+    end
+
+    private
+
+    def failure_message
+      <<~MSG
+        You are using containers from registry.redhat.io,
+        but your system is not logged in to the registry, or the login expired.
+        Please login to registry.redhat.io.
+      MSG
+    end
+  end
+end

data/definitions/checks/iop_advisor/db_up.rb

@@ -0,0 +1,33 @@
+module Checks
+  module IopAdvisor
+    class DBUp < ForemanMaintain::Check
+      metadata do
+        description 'Make sure IoP Advisor DB is up'
+        label :iop_advisor_db_up
+        for_feature :iop_advisor
+      end
+
+      def run
+        status = false
+        if feature(:iop_advisor_database).psql_cmd_available?
+          with_spinner('Checking connection to the IoP Advisor DB') do
+            status = feature(:iop_advisor_database).ping
+          end
+          assert(status, 'IoP Advisor DB is not responding. ' \
+            'It needs to be up and running to perform the following steps',
+            :next_steps => start_pgsql)
+        else
+          feature(:iop_advisor_database).raise_psql_missing_error
+        end
+      end
+
+      def start_pgsql
+        if feature(:iop_advisor_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/checks/iop_inventory/db_up.rb

@@ -0,0 +1,33 @@
+module Checks
+  module IopInventory
+    class DBUp < ForemanMaintain::Check
+      metadata do
+        description 'Make sure IoP Inventory DB is up'
+        label :iop_inventory_db_up
+        for_feature :iop_inventory
+      end
+
+      def run
+        status = false
+        if feature(:iop_inventory_database).psql_cmd_available?
+          with_spinner('Checking connection to the IoP Inventory DB') do
+            status = feature(:iop_inventory_database).ping
+          end
+          assert(status, 'IoP Inventory DB is not responding. ' \
+            'It needs to be up and running to perform the following steps',
+            :next_steps => start_pgsql)
+        else
+          feature(:iop_inventory_database).raise_psql_missing_error
+        end
+      end
+
+      def start_pgsql
+        if feature(:iop_inventory_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/checks/iop_remediations/db_up.rb

@@ -0,0 +1,33 @@
+module Checks
+  module IopRemediations
+    class DBUp < ForemanMaintain::Check
+      metadata do
+        description 'Make sure IoP Remediations DB is up'
+        label :iop_remediations_db_up
+        for_feature :iop_remediations
+      end
+
+      def run
+        status = false
+        if feature(:iop_remediations_database).psql_cmd_available?
+          with_spinner('Checking connection to the IoP Remediations DB') do
+            status = feature(:iop_remediations_database).ping
+          end
+          assert(status, 'IoP Remediations DB is not responding. ' \
+            'It needs to be up and running to perform the following steps',
+            :next_steps => start_pgsql)
+        else
+          feature(:iop_remediations_database).raise_psql_missing_error
+        end
+      end
+
+      def start_pgsql
+        if feature(:iop_remediations_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/checks/iop_vmaas/db_up.rb

@@ -0,0 +1,33 @@
+module Checks
+  module IopVmaas
+    class DBUp < ForemanMaintain::Check
+      metadata do
+        description 'Make sure IoP Vmaas DB is up'
+        label :iop_vmaas_db_up
+        for_feature :iop_vmaas
+      end
+
+      def run
+        status = false
+        if feature(:iop_vmaas_database).psql_cmd_available?
+          with_spinner('Checking connection to the IoP Vmaas DB') do
+            status = feature(:iop_vmaas_database).ping
+          end
+          assert(status, 'IoP Vmaas DB is not responding. ' \
+            'It needs to be up and running to perform the following steps',
+            :next_steps => start_pgsql)
+        else
+          feature(:iop_vmaas_database).raise_psql_missing_error
+        end
+      end
+
+      def start_pgsql
+        if feature(:iop_vmaas_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/checks/iop_vulnerability/db_up.rb

@@ -0,0 +1,33 @@
+module Checks
+  module IopVulnerability
+    class DBUp < ForemanMaintain::Check
+      metadata do
+        description 'Make sure IoP Vulnerability DB is up'
+        label :iop_vulnerability_db_up
+        for_feature :iop_vulnerability
+      end
+
+      def run
+        status = false
+        if feature(:iop_vulnerability_database).psql_cmd_available?
+          with_spinner('Checking connection to the IoP Vulnerability DB') do
+            status = feature(:iop_vulnerability_database).ping
+          end
+          assert(status, 'IoP Vulnerability DB is not responding. ' \
+            'It needs to be up and running to perform the following steps',
+            :next_steps => start_pgsql)
+        else
+          feature(:iop_vulnerability_database).raise_psql_missing_error
+        end
+      end
+
+      def start_pgsql
+        if feature(:iop_vulnerability_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/containers.rb

@@ -0,0 +1,8 @@
+class Features::Containers < ForemanMaintain::Feature
+  metadata do
+    label :containers
+    confine do
+      Dir.exist?('/etc/containers/systemd') && !Dir.empty?('/etc/containers/systemd')
+    end
+  end
+end

data/definitions/features/iop.rb

@@ -0,0 +1,46 @@
+class Features::Iop < ForemanMaintain::Feature
+  metadata do
+    label :iop
+
+    confine do
+      File.exist?('/etc/containers/networks/iop-core-network.json') ||
+        File.exist?('/etc/containers/systemd/iop-core.network')
+    end
+  end
+
+  def config_files
+    [
+      '/var/lib/kafka',
+      '/var/lib/vmaas',
+    ]
+  end
+
+  # rubocop:disable Metrics/MethodLength
+  def services
+    [
+      system_service('iop-core-engine', 20),
+      system_service('iop-core-gateway', 20),
+      system_service('iop-core-host-inventory', 20),
+      system_service('iop-core-host-inventory-api', 20),
+      system_service('iop-core-host-inventory-migrate', 20),
+      system_service('iop-core-ingress', 20),
+      system_service('iop-core-kafka', 20),
+      system_service('iop-core-puptoo', 20),
+      system_service('iop-core-yuptoo', 20),
+      system_service('iop-service-advisor-backend-api', 20),
+      system_service('iop-service-advisor-backend-service', 20),
+      system_service('iop-service-remediations-api', 20),
+      system_service('iop-service-vmaas-reposcan', 20),
+      system_service('iop-service-vmaas-webapp-go', 20),
+      system_service('iop-service-vuln-dbupgrade', 20),
+      system_service('iop-service-vuln-evaluator-recalc', 20),
+      system_service('iop-service-vuln-evaluator-upload', 20),
+      system_service('iop-service-vuln-grouper', 20),
+      system_service('iop-service-vuln-listener', 20),
+      system_service('iop-service-vuln-manager', 20),
+      system_service('iop-service-vuln-taskomatic', 20),
+      system_service('iop-service-vuln-vmaas-sync', 20),
+    ]
+  end
+  # rubocop:enable Metrics/MethodLength
+end

data/definitions/features/iop_advisor_database.rb

@@ -0,0 +1,45 @@
+class Features::IopAdvisorDatabase < ForemanMaintain::Feature
+  include ForemanMaintain::Concerns::BaseDatabase
+
+  metadata do
+    label :iop_advisor_database
+
+    confine do
+      File.exist?('/etc/containers/networks/iop-core-network.json') ||
+        File.exist?('/etc/containers/systemd/iop-core.network')
+    end
+  end
+
+  def configuration
+    @configuration || load_configuration
+  end
+
+  def services
+    [
+      system_service('postgresql', 10, :component => 'iop',
+        :db_feature => feature(:iop_advisor_database)),
+    ]
+  end
+
+  private
+
+  def load_configuration
+    podman_command = "podman exec iop-service-advisor-api bash -c 'env |grep DB_'"
+    podman_result = execute!(podman_command, merge_stderr: false).lines.map do |l|
+      l.strip.split('=')
+    end.to_h
+
+    db_host = if podman_result['ADVISOR_DB_HOST'].start_with?('/var/run/postgresql')
+                'localhost'
+              else
+                podman_result['ADVISOR_DB_HOST']
+              end
+    @configuration = {
+      'host' => db_host,
+      'port' => podman_result['ADVISOR_DB_PORT'],
+      'database' => podman_result['ADVISOR_DB_NAME'],
+      'password' => podman_result['ADVISOR_DB_PASSWORD'],
+      'username' => podman_result['ADVISOR_DB_USER'],
+    }
+  end
+end

data/definitions/features/iop_inventory_database.rb

@@ -0,0 +1,45 @@
+class Features::IopInventoryDatabase < ForemanMaintain::Feature
+  include ForemanMaintain::Concerns::BaseDatabase
+
+  metadata do
+    label :iop_inventory_database
+
+    confine do
+      File.exist?('/etc/containers/networks/iop-core-network.json') ||
+        File.exist?('/etc/containers/systemd/iop-core.network')
+    end
+  end
+
+  def configuration
+    @configuration || load_configuration
+  end
+
+  def services
+    [
+      system_service('postgresql', 10, :component => 'iop',
+        :db_feature => feature(:iop_inventory_database)),
+    ]
+  end
+
+  private
+
+  def load_configuration
+    podman_command = "podman exec iop-core-host-inventory bash -c 'env |grep INVENTORY_DB_'"
+    podman_result = execute!(podman_command, merge_stderr: false).lines.map do |l|
+      l.strip.split('=')
+    end.to_h
+
+    db_host = if podman_result['INVENTORY_DB_HOST'].start_with?('/var/run/postgresql')
+                'localhost'
+              else
+                podman_result['INVENTORY_DB_HOST']
+              end
+    @configuration = {
+      'host' => db_host,
+      'port' => podman_result['INVENTORY_DB_PORT'],
+      'database' => podman_result['INVENTORY_DB_NAME'],
+      'password' => podman_result['INVENTORY_DB_PASS'],
+      'username' => podman_result['INVENTORY_DB_USER'],
+    }
+  end
+end

data/definitions/features/iop_remediations_database.rb

@@ -0,0 +1,45 @@
+class Features::IopRemediationsDatabase < ForemanMaintain::Feature
+  include ForemanMaintain::Concerns::BaseDatabase
+
+  metadata do
+    label :iop_remediations_database
+
+    confine do
+      File.exist?('/etc/containers/networks/iop-core-network.json') ||
+        File.exist?('/etc/containers/systemd/iop-core.network')
+    end
+  end
+
+  def configuration
+    @configuration || load_configuration
+  end
+
+  def services
+    [
+      system_service('postgresql', 10, :component => 'iop',
+        :db_feature => feature(:iop_remediations_database)),
+    ]
+  end
+
+  private
+
+  def load_configuration
+    podman_command = "podman exec iop-service-remediations-api bash -c 'env |grep DB_'"
+    podman_result = execute!(podman_command, merge_stderr: false).lines.map do |l|
+      l.strip.split('=')
+    end.to_h
+
+    db_host = if podman_result['DB_HOST'].start_with?('/var/run/postgresql')
+                'localhost'
+              else
+                podman_result['DB_HOST']
+              end
+    @configuration = {
+      'host' => db_host,
+      'port' => podman_result['DB_PORT'],
+      'database' => podman_result['DB_DATABASE'],
+      'password' => podman_result['DB_PASSWORD'],
+      'username' => podman_result['DB_USERNAME'],
+    }
+  end
+end

data/definitions/features/iop_vmaas_database.rb

@@ -0,0 +1,45 @@
+class Features::IopVmaasDatabase < ForemanMaintain::Feature
+  include ForemanMaintain::Concerns::BaseDatabase
+
+  metadata do
+    label :iop_vmaas_database
+
+    confine do
+      File.exist?('/etc/containers/networks/iop-core-network.json') ||
+        File.exist?('/etc/containers/systemd/iop-core.network')
+    end
+  end
+
+  def configuration
+    @configuration || load_configuration
+  end
+
+  def services
+    [
+      system_service('postgresql', 10, :component => 'iop',
+        :db_feature => feature(:iop_vmaas_database)),
+    ]
+  end
+
+  private
+
+  def load_configuration
+    podman_command = "podman exec iop-service-vmaas-reposcan bash -c 'env |grep POSTGRESQL_'"
+    podman_result = execute!(podman_command, merge_stderr: false).lines.map do |l|
+      l.strip.split('=')
+    end.to_h
+
+    db_host = if podman_result['POSTGRESQL_HOST'].start_with?('/var/run/postgresql')
+                'localhost'
+              else
+                podman_result['POSTGRESQL_HOST']
+              end
+    @configuration = {
+      'host' => db_host,
+      'port' => podman_result['POSTGRESQL_PORT'],
+      'database' => podman_result['POSTGRESQL_DATABASE'],
+      'password' => podman_result['POSTGRESQL_PASSWORD'],
+      'username' => podman_result['POSTGRESQL_USER'],
+    }
+  end
+end

data/definitions/features/iop_vulnerability_database.rb

@@ -0,0 +1,45 @@
+class Features::IopVulnerabilityDatabase < ForemanMaintain::Feature
+  include ForemanMaintain::Concerns::BaseDatabase
+
+  metadata do
+    label :iop_vulnerability_database
+
+    confine do
+      File.exist?('/etc/containers/networks/iop-core-network.json') ||
+        File.exist?('/etc/containers/systemd/iop-core.network')
+    end
+  end
+
+  def configuration
+    @configuration || load_configuration
+  end
+
+  def services
+    [
+      system_service('postgresql', 10, :component => 'iop',
+        :db_feature => feature(:iop_vulnerability_database)),
+    ]
+  end
+
+  private
+
+  def load_configuration
+    podman_command = "podman exec iop-service-vuln-manager bash -c 'env |grep POSTGRES_'"
+    podman_result = execute!(podman_command, merge_stderr: false).lines.map do |l|
+      l.strip.split('=')
+    end.to_h
+
+    db_host = if podman_result['POSTGRES_HOST'].start_with?('/var/run/postgresql')
+                'localhost'
+              else
+                podman_result['POSTGRES_HOST']
+              end
+    @configuration = {
+      'host' => db_host,
+      'port' => podman_result['POSTGRES_PORT'],
+      'database' => podman_result['POSTGRES_DB'],
+      'password' => podman_result['POSTGRES_PASSWORD'],
+      'username' => podman_result['POSTGRES_USER'],
+    }
+  end
+end

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

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

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

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

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

@@ -0,0 +1,21 @@
+module Procedures::Backup
+  module Online
+    class IopRemediationsDB < ForemanMaintain::Procedure
+      metadata do
+        description 'Backup IoP Remediations database'
+        tags :backup
+        label :backup_online_iop_remediations_db
+        for_feature :iop_remediations_database
+        preparation_steps { Checks::IopRemediations::DBUp.new }
+        param :backup_dir, 'Directory where to backup to', :required => true
+      end
+
+      def run
+        with_spinner('Getting IoP Remediations DB dump') do
+          feature(:iop_remediations_database).dump_db(File.join(@backup_dir,
+            'iop_remediations.dump'))
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,21 @@
+module Procedures::Backup
+  module Online
+    class IopVulnerabilityDB < ForemanMaintain::Procedure
+      metadata do
+        description 'Backup IoP Vulnerability database'
+        tags :backup
+        label :backup_online_iop_vulnerability_db
+        for_feature :iop_vulnerability_database
+        preparation_steps { Checks::IopVulnerability::DBUp.new }
+        param :backup_dir, 'Directory where to backup to', :required => true
+      end
+
+      def run
+        with_spinner('Getting IoP Vulnerability DB dump') do
+          feature(:iop_vulnerability_database).dump_db(File.join(@backup_dir,
+            'iop_vulnerability.dump'))
+        end
+      end
+    end
+  end
+end

data/definitions/procedures/restore/drop_databases.rb

@@ -8,7 +8,12 @@ module Procedures::Restore
         :required => true
 
       confine do
-        feature(:foreman_database) || feature(:candlepin_database) || feature(:pulpcore_database)
+        feature(:foreman_database) || feature(:candlepin_database) || feature(:pulpcore_database) ||
+          feature(:iop_advisor_database) ||
+          feature(:iop_inventory_database) ||
+          feature(:iop_remediations_database) ||
+          feature(:iop_vmaas_database) ||
+          feature(:iop_vulnerability_database)
       end
     end
 
@@ -20,6 +25,11 @@ module Procedures::Restore
         drop_foreman(backup, spinner)
         drop_candlepin(backup, spinner)
         drop_pulpcore(backup, spinner)
+        drop_iop_advisor(backup, spinner)
+        drop_iop_inventory(backup, spinner)
+        drop_iop_remediations(backup, spinner)
+        drop_iop_vmaas(backup, spinner)
+        drop_iop_vulnerability(backup, spinner)
       end
     end
 
@@ -43,5 +53,40 @@ module Procedures::Restore
         feature(:pulpcore_database).dropdb
       end
     end
+
+    def drop_iop_advisor(backup, spinner)
+      if backup.file_map[:iop_advisor_dump][:present]
+        spinner.update('Dropping iop_advisor database')
+        feature(:iop_advisor_database).dropdb
+      end
+    end
+
+    def drop_iop_inventory(backup, spinner)
+      if backup.file_map[:iop_inventory_dump][:present]
+        spinner.update('Dropping iop_inventory database')
+        feature(:iop_inventory_database).dropdb
+      end
+    end
+
+    def drop_iop_remediations(backup, spinner)
+      if backup.file_map[:iop_remediations_dump][:present]
+        spinner.update('Dropping iop_remediations database')
+        feature(:iop_remediations_database).dropdb
+      end
+    end
+
+    def drop_iop_vmaas(backup, spinner)
+      if backup.file_map[:iop_vmaas_dump][:present]
+        spinner.update('Dropping iop_vmaas database')
+        feature(:iop_vmaas_database).dropdb
+      end
+    end
+
+    def drop_iop_vulnerability(backup, spinner)
+      if backup.file_map[:iop_vulnerability_dump][:present]
+        spinner.update('Dropping iop_vulnerability database')
+        feature(:iop_vulnerability_database).dropdb
+      end
+    end
   end
 end