foreman_maintain 1.10.3 → 1.12.0

data/definitions/procedures/restore/iop_advisor_dump.rb

@@ -0,0 +1,27 @@
+module Procedures::Restore
+  class IopAdvisorDump < ForemanMaintain::Procedure
+    metadata do
+      description 'Restore IoP Advisor dump from backup'
+      param :backup_dir,
+        'Path to backup directory',
+        :required => true
+      preparation_steps { Checks::IopAdvisor::DBUp.new }
+      confine do
+        feature(:iop_advisor_database)
+      end
+    end
+
+    def run
+      backup = ForemanMaintain::Utils::Backup.new(@backup_dir)
+
+      with_spinner('Restoring IoP Advisor dump') do |_spinner|
+        if backup.file_map[:candlepin_dump][:present]
+          local = feature(:iop_advisor_database).local?
+          feature(:iop_advisor_database).restore_dump(
+            backup.file_map[:iop_advisor_dump][:path], local
+          )
+        end
+      end
+    end
+  end
+end

data/definitions/procedures/restore/iop_inventory_dump.rb

@@ -0,0 +1,27 @@
+module Procedures::Restore
+  class IopInventoryDump < ForemanMaintain::Procedure
+    metadata do
+      description 'Restore IoP Inventory dump from backup'
+      param :backup_dir,
+        'Path to backup directory',
+        :required => true
+      preparation_steps { Checks::IopInventory::DBUp.new }
+      confine do
+        feature(:iop_inventory_database)
+      end
+    end
+
+    def run
+      backup = ForemanMaintain::Utils::Backup.new(@backup_dir)
+
+      with_spinner('Restoring IoP Inventory dump') do |_spinner|
+        if backup.file_map[:candlepin_dump][:present]
+          local = feature(:iop_inventory_database).local?
+          feature(:iop_inventory_database).restore_dump(
+            backup.file_map[:iop_inventory_dump][:path], local
+          )
+        end
+      end
+    end
+  end
+end

data/definitions/procedures/restore/iop_remediations_dump.rb

@@ -0,0 +1,27 @@
+module Procedures::Restore
+  class IopRemediationsDump < ForemanMaintain::Procedure
+    metadata do
+      description 'Restore IoP Remediations dump from backup'
+      param :backup_dir,
+        'Path to backup directory',
+        :required => true
+      preparation_steps { Checks::IopRemediations::DBUp.new }
+      confine do
+        feature(:iop_remediations_database)
+      end
+    end
+
+    def run
+      backup = ForemanMaintain::Utils::Backup.new(@backup_dir)
+
+      with_spinner('Restoring IoP Remediations dump') do |_spinner|
+        if backup.file_map[:candlepin_dump][:present]
+          local = feature(:iop_remediations_database).local?
+          feature(:iop_remediations_database).restore_dump(
+            backup.file_map[:iop_remediations_dump][:path], local
+          )
+        end
+      end
+    end
+  end
+end

data/definitions/procedures/restore/iop_vmaas_dump.rb

@@ -0,0 +1,25 @@
+module Procedures::Restore
+  class IopVmaasDump < ForemanMaintain::Procedure
+    metadata do
+      description 'Restore IoP Vmaas dump from backup'
+      param :backup_dir,
+        'Path to backup directory',
+        :required => true
+      preparation_steps { Checks::IopVmaas::DBUp.new }
+      confine do
+        feature(:iop_vmaas_database)
+      end
+    end
+
+    def run
+      backup = ForemanMaintain::Utils::Backup.new(@backup_dir)
+
+      with_spinner('Restoring IoP Vmaas dump') do |_spinner|
+        if backup.file_map[:candlepin_dump][:present]
+          local = feature(:iop_vmaas_database).local?
+          feature(:iop_vmaas_database).restore_dump(backup.file_map[:iop_vmaas_dump][:path], local)
+        end
+      end
+    end
+  end
+end

data/definitions/procedures/restore/iop_vulnerability_dump.rb

@@ -0,0 +1,27 @@
+module Procedures::Restore
+  class IopVulnerabilityDump < ForemanMaintain::Procedure
+    metadata do
+      description 'Restore IoP Vulnerability dump from backup'
+      param :backup_dir,
+        'Path to backup directory',
+        :required => true
+      preparation_steps { Checks::IopVulnerability::DBUp.new }
+      confine do
+        feature(:iop_vulnerability_database)
+      end
+    end
+
+    def run
+      backup = ForemanMaintain::Utils::Backup.new(@backup_dir)
+
+      with_spinner('Restoring IoP Vulnerability dump') do |_spinner|
+        if backup.file_map[:candlepin_dump][:present]
+          local = feature(:iop_vulnerability_database).local?
+          feature(:iop_vulnerability_database).restore_dump(
+            backup.file_map[:iop_vulnerability_dump][:path], local
+          )
+        end
+      end
+    end
+  end
+end

data/definitions/reports/advisor_on_prem_remediations.rb

@@ -0,0 +1,33 @@
+module Reports
+  class AdvisorOnPremRemediations < ForemanMaintain::Report
+    metadata do
+      description 'Report number of remediations based on advisor rules from advisor on premise'
+    end
+
+    def run
+      data_field('advisor_on_prem_remediations_enabled') { advisor_on_prem_remediations_enabled }
+      data_field('advisor_on_prem_remediations_count') { advisor_on_prem_remediations_count }
+    end
+
+    def advisor_on_prem_remediations_enabled
+      if @iop_enabled.nil?
+        @iop_enabled = feature(:installer)&.answers&.dig(
+          'foreman::plugin::rh_cloud', 'enable_iop_advisor_engine'
+        ) || false
+      end
+      @iop_enabled
+    end
+
+    def advisor_on_prem_remediations_count
+      if advisor_on_prem_remediations_enabled
+        return sql_count('
+          job_invocations AS jobs
+          INNER JOIN remote_execution_features AS rexf ON jobs.remote_execution_feature_id = rexf.id
+          INNER JOIN template_invocations AS tinv ON jobs.id = tinv.job_invocation_id
+          WHERE rexf.label = \'rh_cloud_remediate_hosts\'
+          AND tinv.host_id IS NOT NULL
+        ')
+      end
+    end
+  end
+end

data/definitions/reports/alternate_content_sources.rb

@@ -0,0 +1,46 @@
+module Checks
+  module Report
+    class AlternateContentSources < ForemanMaintain::Report
+      metadata do
+        description 'Facts about ACSs'
+        confine do
+          feature(:katello)
+        end
+      end
+
+      def run
+        data_field('custom_alternate_content_sources_count') { custom_alternate_content_sources }
+        data_field('simplified_alternate_content_sources_count') do
+          simplified_alternate_content_sources
+        end
+        data_field('rhui_alternate_content_sources_count') { rhui_alternate_content_sources }
+        data_field('yum_alternate_content_sources_count') { yum_alternate_content_sources }
+        data_field('file_alternate_content_sources_count') { file_alternate_content_sources }
+      end
+
+      def custom_alternate_content_sources
+        sql_count(
+          "katello_alternate_content_sources WHERE alternate_content_source_type = 'custom'"
+        )
+      end
+
+      def simplified_alternate_content_sources
+        sql_count(
+          "katello_alternate_content_sources WHERE alternate_content_source_type = 'simplified'"
+        )
+      end
+
+      def rhui_alternate_content_sources
+        sql_count("katello_alternate_content_sources WHERE alternate_content_source_type = 'rhui'")
+      end
+
+      def yum_alternate_content_sources
+        sql_count("katello_alternate_content_sources WHERE content_type = 'yum'")
+      end
+
+      def file_alternate_content_sources
+        sql_count("katello_alternate_content_sources WHERE content_type = 'file'")
+      end
+    end
+  end
+end

data/definitions/reports/content.rb

@@ -0,0 +1,54 @@
+module Checks
+  module Report
+    class Content < ForemanMaintain::Report
+      metadata do
+        description 'Facts about Katello content'
+        confine do
+          feature(:katello)
+        end
+      end
+
+      def run
+        data_field('custom_library_yum_repositories_count') { custom_library_yum_repositories }
+        data_field('redhat_library_yum_repositories_count') { redhat_library_yum_repositories }
+        data_field('library_debian_repositories_count') { library_repositories('deb') }
+        data_field('library_container_repositories_count') { library_repositories('docker') }
+        data_field('library_file_repositories_count') { library_repositories('file') }
+        data_field('library_python_repositories_count') { library_repositories('python') }
+        data_field('library_ansible_collection_repositories_count') do
+          library_repositories('ansible_collection')
+        end
+        data_field('library_ostree_repositories_count') { library_repositories('ostree') }
+      end
+
+      def custom_library_yum_repositories
+        query_snippet =
+          <<-SQL
+            "katello_root_repositories"
+              WHERE "katello_root_repositories"."id" NOT IN
+              (SELECT "katello_root_repositories"."id" FROM "katello_root_repositories" INNER JOIN "katello_products"
+                ON "katello_products"."id" = "katello_root_repositories"."product_id" INNER JOIN "katello_providers"
+                ON "katello_providers"."id" = "katello_products"."provider_id" WHERE "katello_providers"."provider_type" = 'Red Hat')
+              AND "katello_root_repositories"."content_type" = 'yum'
+          SQL
+        sql_count(query_snippet)
+      end
+
+      def redhat_library_yum_repositories
+        query_snippet =
+          <<-SQL
+            "katello_root_repositories"
+              INNER JOIN "katello_products" ON "katello_products"."id" = "katello_root_repositories"."product_id"
+              INNER JOIN "katello_providers" ON "katello_providers"."id" = "katello_products"."provider_id"
+                WHERE "katello_providers"."provider_type" = 'Red Hat'
+              AND "katello_root_repositories"."content_type" = 'yum'
+          SQL
+        sql_count(query_snippet)
+      end
+
+      def library_repositories(content_type)
+        sql_count("katello_root_repositories WHERE content_type = '#{content_type}'")
+      end
+    end
+  end
+end

data/definitions/reports/image_mode_hosts.rb

@@ -0,0 +1,50 @@
+module Reports
+  class ImageModeHosts < ForemanMaintain::Report
+    metadata do
+      description 'Report metrics related to use of image mode'
+      confine do
+        feature(:katello)
+      end
+    end
+
+    def run
+      merge_data('image_mode_hosts_by_os_count') { image_mode_hosts_by_os_count }
+      data['remote_execution_transient_package_actions_count'] = transient_actions_count
+    end
+
+    # OS usage on image mode hosts
+    def image_mode_hosts_by_os_count
+      query(
+        <<-SQL
+          select max(operatingsystems.name) as os_name, count(*) as hosts_count
+          from hosts inner join operatingsystems on operatingsystem_id = operatingsystems.id inner join katello_content_facets on hosts.id = katello_content_facets.host_id
+          where bootc_booted_digest is not null
+          group by operatingsystems.name
+        SQL
+      ).
+        to_h { |row| [row['os_name'], row['hosts_count'].to_i] }
+    end
+
+    def transient_actions_count
+      cte = <<~CTE
+        WITH bootc_hosts AS (
+          SELECT hosts.id FROM hosts
+          INNER JOIN katello_content_facets AS kcf ON hosts.id = kcf.host_id
+          WHERE kcf.bootc_booted_digest IS NOT NULL
+        )
+      CTE
+
+      sql = <<~SQL
+        job_invocations AS ji
+          INNER JOIN remote_execution_features AS ref ON ji.remote_execution_feature_id = ref.id
+          INNER JOIN template_invocations AS ti ON ji.id = ti.job_invocation_id
+          INNER JOIN bootc_hosts ON bootc_hosts.id = ti.host_id
+          WHERE ref.label LIKE 'katello_package%'
+             OR ref.label LIKE 'katello_errata%'
+             OR ref.label LIKE 'katello_group%'
+      SQL
+
+      sql_count(sql, cte: cte)
+    end
+  end
+end

data/definitions/reports/inventory.rb

@@ -7,9 +7,11 @@ module Reports
     def run
       merge_data('hosts_by_type_count') { hosts_by_type_count }
       merge_data('hosts_by_os_count') { hosts_by_os_count }
+      merge_data('hosts_by_family_count') { hosts_by_family_count }
       merge_data('facts_by_type') { facts_by_type }
       merge_data('audits') { audits }
       merge_data('parameters_count') { parameters }
+      hosts_running_rhel_ai
     end
 
     # Hosts
@@ -24,12 +26,23 @@ module Reports
         <<-SQL
             select max(operatingsystems.name) as os_name, count(*) as hosts_count
             from hosts inner join operatingsystems on operatingsystem_id = operatingsystems.id
-            group by operatingsystem_id
+            group by operatingsystems.name
         SQL
       ).
         to_h { |row| [row['os_name'], row['hosts_count'].to_i] }
     end
 
+    def hosts_by_family_count
+      query(
+        <<-SQL
+            select max(operatingsystems.type) as os_family, count(*) as hosts_count
+            from hosts inner join operatingsystems on operatingsystem_id = operatingsystems.id
+            group by operatingsystems.type
+        SQL
+      ).
+        to_h { |row| [row['os_family'], row['hosts_count'].to_i] }
+    end
+
     # Facts usage
     def facts_by_type
       query(
@@ -80,5 +93,16 @@ module Reports
         max_created_at: row['max_created_at'],
       }
     end
+
+    def hosts_running_rhel_ai
+      query = <<~SQL
+        hosts
+        INNER JOIN katello_subscription_facets AS ksf ON hosts.id = ksf.host_id
+        INNER JOIN katello_subscription_facet_installed_products AS ksfip ON ksfip.subscription_facet_id = ksf.id
+        INNER JOIN katello_installed_products AS kip ON ksfip.installed_product_id = kip.id
+        WHERE kip.name = 'Red Hat Enterprise Linux AI'
+      SQL
+      data_field('rhel_ai_workload_host_count') { sql_count(query) }
+    end
   end
 end

data/definitions/reports/networking.rb

@@ -0,0 +1,78 @@
+require 'socket'
+
+module Reports
+  class Networking < ForemanMaintain::Report
+    metadata do
+      description 'Report information about networking'
+    end
+
+    def run
+      subnet_counts_by_type
+      hosts_by_address_family
+      interfaces_by_address_family
+      preference_settings
+    end
+
+    private
+
+    # How many ipv4 subnets are defined in Foreman?
+    # How many ipv6 subnets are defined in Foreman?
+    def subnet_counts_by_type
+      %w[Ipv4 Ipv6].each do |type|
+        data_field("subnet_#{type.downcase}_count") do
+          sql_count("subnets where type = 'Subnet::#{type}'")
+        end
+      end
+    end
+
+    # How many hosts in Foreman have an interface with an ipv4 address but no ipv6 address?
+    # How many hosts in Foreman have an interface with no ipv4 address but an ipv6 address?
+    # How many hosts in Foreman have an interface with both ipv4 and ipv6 addresses?
+    def hosts_by_address_family
+      { 'ipv4only': 'nics.ip IS NOT NULL AND nics.ip6 IS NULL',
+        'ipv6only': 'nics.ip IS NULL AND nics.ip6 IS NOT NULL',
+        'dualstack': 'nics.ip IS NOT NULL AND nics.ip6 IS NOT NULL' }.each do |kind, condition|
+        query = <<~SQL
+          hosts
+          WHERE id IN (SELECT host_id FROM nics WHERE #{condition})
+        SQL
+        data_field("hosts_with_#{kind}_interface_count") { sql_count(query) }
+      end
+    end
+
+    # How many of Foreman's interfaces:
+    # - only have a non-loopback, non-multicast ipv4 address?
+    # - only have a non-loopback, non-multicast, non-link-local ipv6 address?
+    # - have a non-loopback, non-multicast ipv4 address
+    #   as well as a non-loopback, non-multicast, non-link-local ipv6 address?
+    def interfaces_by_address_family
+      by_name = Socket.getifaddrs.group_by(&:name).transform_values { |addrs| addrs.map(&:addr) }
+      with_ipv4, without_ipv4 = by_name.partition { |_name, addrs| relevant_ipv4?(addrs) }
+      dualstack, ipv4_only = with_ipv4.partition { |_name, addrs| relevant_ipv6?(addrs) }
+      ipv6_only = without_ipv4.select { |_name, addrs| relevant_ipv6?(addrs) }
+
+      data_field("foreman_interfaces_ipv4only_count") { ipv4_only.count }
+      data_field("foreman_interfaces_ipv6only_count") { ipv6_only.count }
+      data_field("foreman_interfaces_dualstack_count") { dualstack.count }
+    end
+
+    def relevant_ipv4?(addrs)
+      addrs.any? { |addr| addr.ipv4? && !(addr.ipv4_loopback? || addr.ipv4_multicast?) }
+    end
+
+    def relevant_ipv6?(addrs)
+      addrs.any? do |addr|
+        addr.ipv6? && !(addr.ipv6_loopback? || addr.ipv6_multicast? || addr.ipv6_linklocal?)
+      end
+    end
+
+    def preference_settings
+      %w[remote_execution_connect_by_ip_prefer_ipv6 discovery_prefer_ipv6].each do |setting|
+        data_field("setting_#{setting}") do
+          value = sql_setting(setting)
+          value.nil? ? false : YAML.safe_load(value)
+        end
+      end
+    end
+  end
+end

data/definitions/reports/platform.rb

@@ -57,7 +57,7 @@ module Reports
 
     def settings_fields
       data_field('modified_settings') do
-        query("select name from settings").
+        query("select name from settings WHERE value IS NOT NULL").
           map { |setting_line| setting_line['name'] }.
           join(',')
       end

data/definitions/scenarios/backup.rb

@@ -46,6 +46,11 @@ module ForemanMaintain::Scenarios
         Procedures::Backup::Pulp => :backup_dir,
         Procedures::Backup::Online::CandlepinDB => :backup_dir,
         Procedures::Backup::Online::ForemanDB => :backup_dir,
+        Procedures::Backup::Online::IopAdvisorDB => :backup_dir,
+        Procedures::Backup::Online::IopInventoryDB => :backup_dir,
+        Procedures::Backup::Online::IopRemediationsDB => :backup_dir,
+        Procedures::Backup::Online::IopVmaasDB => :backup_dir,
+        Procedures::Backup::Online::IopVulnerabilityDB => :backup_dir,
         Procedures::Backup::Online::PulpcoreDB => :backup_dir)
       context.map(:preserve_dir,
         Procedures::Backup::PrepareDirectory => :preserve_dir)
@@ -102,6 +107,11 @@ module ForemanMaintain::Scenarios
       add_steps_with_context(
         Procedures::Backup::Online::CandlepinDB,
         Procedures::Backup::Online::ForemanDB,
+        Procedures::Backup::Online::IopAdvisorDB,
+        Procedures::Backup::Online::IopInventoryDB,
+        Procedures::Backup::Online::IopRemediationsDB,
+        Procedures::Backup::Online::IopVmaasDB,
+        Procedures::Backup::Online::IopVulnerabilityDB,
         Procedures::Backup::Online::PulpcoreDB
       )
     end

data/definitions/scenarios/restore.rb

@@ -52,6 +52,7 @@ module ForemanMaintain::Scenarios
     end
     # rubocop:enable Metrics/MethodLength,Metrics/AbcSize
 
+    # rubocop:disable Metrics/MethodLength,Metrics/AbcSize,Metrics/CyclomaticComplexity
     def restore_sql_dumps(backup)
       if feature(:instance).postgresql_local?
         add_step(Procedures::Service::Start.new(:only => ['postgresql']))
@@ -62,6 +63,24 @@ module ForemanMaintain::Scenarios
       if backup.file_map[:foreman_dump][:present]
         add_steps_with_context(Procedures::Restore::ForemanDump)
       end
+      if backup.file_map[:iop_advisor_dump][:present]
+        add_steps_with_context(Procedures::Restore::IopAdvisorDump)
+      end
+      if backup.file_map[:iop_inventory_dump][:present]
+        add_steps_with_context(Procedures::Restore::IopInventoryDump)
+      end
+      if backup.file_map[:iop_remediations_dump][:present]
+        add_steps_with_context(Procedures::Restore::IopRemediationsDump)
+      end
+      if backup.file_map[:iop_advisor_dump][:present]
+        add_steps_with_context(Procedures::Restore::IopAdvisorDump)
+      end
+      if backup.file_map[:iop_vmaas_dump][:present]
+        add_steps_with_context(Procedures::Restore::IopVmaasDump)
+      end
+      if backup.file_map[:iop_vulnerability_dump][:present]
+        add_steps_with_context(Procedures::Restore::IopVulnerabilityDump)
+      end
       if backup.file_map[:pulpcore_dump][:present]
         add_steps_with_context(Procedures::Restore::PulpcoreDump)
       end
@@ -69,6 +88,7 @@ module ForemanMaintain::Scenarios
         add_step(Procedures::Service::Stop.new(:only => ['postgresql']))
       end
     end
+    # rubocop:enable Metrics/MethodLength,Metrics/AbcSize,Metrics/CyclomaticComplexity
 
     def set_context_mapping
       context.map(:backup_dir,
@@ -81,6 +101,11 @@ module ForemanMaintain::Scenarios
         Procedures::Restore::DropDatabases => :backup_dir,
         Procedures::Restore::CandlepinDump => :backup_dir,
         Procedures::Restore::ForemanDump => :backup_dir,
+        Procedures::Restore::IopAdvisorDump => :backup_dir,
+        Procedures::Restore::IopInventoryDump => :backup_dir,
+        Procedures::Restore::IopRemediationsDump => :backup_dir,
+        Procedures::Restore::IopVmaasDump => :backup_dir,
+        Procedures::Restore::IopVulnerabilityDump => :backup_dir,
         Procedures::Restore::PulpcoreDump => :backup_dir,
         Procedures::Restore::ExtractFiles => :backup_dir)
     end

data/definitions/scenarios/satellite_upgrade.rb

@@ -36,6 +36,7 @@ module Scenarios::Satellite
         Checks::CheckHotfixInstalled,
         Checks::CheckTmout,
         Checks::CheckUpstreamRepository,
+        Checks::Container::PodmanLogin, # if downstream, connected, containers used
         Checks::Disk::AvailableSpace,
         Checks::Disk::AvailableSpaceCandlepin, # if candlepin
         Checks::Disk::PostgresqlMountpoint,

data/definitions/scenarios/update.rb

@@ -35,6 +35,7 @@ module Scenarios::Update
         Checks::CheckTmout,
         Checks::CheckIpv6Disable,
         Checks::CheckUpstreamRepository,
+        Checks::Container::PodmanLogin, # if downstream, connected, containers used
         Checks::Disk::AvailableSpace,
         Checks::Disk::AvailableSpaceCandlepin, # if candlepin
         Checks::Foreman::ValidateExternalDbVersion, # if external database