foreman_rh_cloud 5.0.30 → 5.0.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 652e5780da34877a7db2beabee9d7853df3e92d56e9336b135c2f5c10e591135
-  data.tar.gz: 41d79413f8cda24474d233512b75b301277058fec819cd0d8eb19c7ea24465b7
+  metadata.gz: bc3c3d4f7552bd3c599539ccb241473e38654c058ad4951e0e668b20d4648c67
+  data.tar.gz: 4545a0307c6eb685c2f84543530af13a25c984d605b9fcb01b1e3eb82c3618f2
 SHA512:
-  metadata.gz: 5f570c0fce387859fb5cd268452591bf7ab85033600571aa0953173ab2d906bcfc22f5f2dbba5868d88c7af86a4442a4c56b45e719c8f0c0f983a14f039a2b27
-  data.tar.gz: faa24509c2c3f8ef000c41bbbc0cddbc5352dc50998345883030b904d251cf8ee705a635caaf8ca3e9c84be38f188d529e60d5435dd506b76a7dac0a419e89db
+  metadata.gz: a147e2ceb11d2834af97ca954ea8c839bfe663a684fdac16e309ee4f003d3509f38dde84b75e3b06d837de390336541eb7b6c08259dfa9871d681a98cc717363
+  data.tar.gz: b176f027e036d865cdf31541af29fc09487407e3f8c95e83bb2c76a3989360e35939762e52de75d0a9df260eb7931ac5b0ca69fa32fe88d496896893103c2a9d

data/app/controllers/api/v2/rh_cloud/cloud_request_controller.rb

@@ -0,0 +1,83 @@
+module Api::V2::RhCloud
+  class CloudRequestController < ::Api::V2::BaseController
+    layout false
+
+    KNOWN_DIRECTIVES = {
+      'playbook-sat' => :handle_run_playbook_request,
+      'foreman_rh_cloud' => :handle_run_playbook_request,
+    }
+
+    def update
+      handler = KNOWN_DIRECTIVES[directive]
+
+      unless handler
+        render json: {
+          :message => "No valid handler is found for directive: #{directive}",
+        }, status: :bad_request
+        return
+      end
+
+      send(handler)
+
+      render json: {
+        :message => "Handled #{directive} by #{handler}",
+      }
+    end
+
+    private
+
+    def metadata
+      params['metadata']
+    end
+
+    def content
+      # the content received as base 64 of the string in double quotes
+      Base64.decode64(params['content']).tr('"', '')
+    end
+
+    def directive
+      params['directive']
+    end
+
+    def handle_run_playbook_request
+      logger.error("API token is not set, unable to fetch data from the cloud") && return if Setting[:rh_cloud_token].empty?
+      logger.error("Playbook URL is not valid: #{content}") && return unless valid_url?(content)
+      logger.error("Reporting URL is not valid: #{metadata['return_url']}") && return unless valid_url?(metadata['return_url'])
+
+      hosts = metadata['hosts'].split(',')
+      host_ids = host_ids(hosts)
+
+      logger.warn("Some hosts were not found. Looked for: #{hosts}, found ids: #{host_ids}") unless host_ids.length == hosts.length
+
+      logger.error("sat_org_id is not present in the metadata") && return unless metadata['sat_org_id']
+      org_id = metadata['sat_org_id'].to_i
+      organization = Organization.find(org_id)
+
+      composer = nil
+      Organization.as_org(organization) do
+        composer = ::JobInvocationComposer.for_feature(
+          :rh_cloud_connector_run_playbook,
+          host_ids,
+          {
+            playbook_url: content,
+            report_url: metadata['return_url'],
+            report_interval: metadata['response_interval'].to_i,
+            correlation_id: metadata['correlation_id'],
+          }
+        )
+        composer.trigger!
+      end
+
+      composer.job_invocation
+    end
+
+    def valid_url?(url)
+      parsed = URI(url)
+      ForemanRhCloud.cloud_url_validator.match(parsed.host)
+    end
+
+    def host_ids(hosts)
+      InsightsFacet.where(uuid: hosts).pluck(:host_id)
+    end
+  end
+end

data/app/controllers/foreman_inventory_upload/uploads_controller.rb

@@ -18,6 +18,13 @@ module ForemanInventoryUpload
     end
 
     def enable_cloud_connector
+      Organization.unscoped.each do |org|
+        presence = ForemanRhCloud::CloudPresence.new(org, logger)
+        presence.announce_to_sources
+      rescue StandardError => ex
+        logger.warn(ex)
+      end
+
       cloud_connector = ForemanRhCloud::CloudConnector.new
       render json: cloud_connector.install.to_json
     end

data/app/helpers/foreman_inventory_upload_host_helper.rb

@@ -5,8 +5,9 @@ module ForemanInventoryUploadHostHelper
 
   def hits_counts_cell(host)
     host_hits = hits_counts[host.id]
+    host_link = Setting['host_details_ui'] ? "#{host_details_page_path(host)}#/Insights" : "#{host_path(host)}#insights"
     tag.td class: ['hidden-xs', 'ellipsis', 'text-center'] do
-      link_to(host_hits, "#{host_path(host)}#insights") if host_hits
+      link_to(host_hits, host_link) if host_hits
     end
   end
 end

data/app/models/setting/rh_cloud.rb

@@ -1,5 +1,5 @@
 class Setting::RhCloud < Setting
-  ::Setting::BLANK_ATTRS.concat %w{rh_cloud_token}
+  ::Setting::BLANK_ATTRS.concat %w{rh_cloud_token rhc_instance_id}
 
   def self.load_defaults
     return false unless table_exists?
@@ -20,6 +20,7 @@ class Setting::RhCloud < Setting
       set('rh_cloud_token', N_('Authentication token to Red Hat cloud services. Used to authenticate requests to cloud APIs'), nil, N_('Red Hat Cloud token'), nil, encrypted: true),
       set('exclude_installed_packages', N_('Exclude installed packages from being uploaded to the Red Hat cloud'), false, N_("Exclude installed Packages")),
       set('include_parameter_tags', N_('Should import include parameter tags from Foreman?'), false, N_('Include parameters in insights-client reports')),
+      set('rhc_instance_id', N_('RHC daemon id'), nil, N_('ID of the RHC(Yggdrasil) daemon')),
     ]
   end
 

data/app/services/foreman_rh_cloud/cloud_ping_service.rb

@@ -39,6 +39,9 @@ module ForemanRhCloud
         certs = candlepin_id_cert(@org)
         return StandardError.new('certificate missing') unless certs
 
+        cert_checker = Katello::UpstreamConnectionChecker.new(@org)
+        cert_checker.assert_connection
+
         execute_cloud_request(
           method: :get,
           url: ForemanRhCloud.cert_base_url + "/api/apicast-tests/ping",
@@ -72,7 +75,7 @@ module ForemanRhCloud
               org,
               {
                 success: cert_response.is_a?(RestClient::Response),
-                error: (cert_response.is_a?(Exception) ? cert_response.inspect : nil),
+                error: (cert_response.is_a?(Exception) ? cert_response&.message || cert_response.inspect : nil),
               },
             ]
           end

data/app/services/foreman_rh_cloud/cloud_presence.rb

@@ -0,0 +1,124 @@
+module ForemanRhCloud
+  class CloudPresence
+    include InsightsCloud::CandlepinCache
+    include ForemanRhCloud::CloudRequest
+
+    attr_reader :organization, :logger
+
+    def initialize(organization, logger)
+      @organization = organization
+      @logger = logger
+    end
+
+    def announce_to_sources
+      register_rhc_instance
+    end
+
+    def satellite_source_type
+      @satellite_source_type ||= begin
+        source_type_response = JSON.parse(
+          execute_cloud_request(
+            method: :get,
+            url: source_type_url,
+            headers: {
+              content_type: :json,
+            },
+            ssl_client_cert: OpenSSL::X509::Certificate.new(certs[:cert]),
+            ssl_client_key: OpenSSL::PKey::RSA.new(certs[:key])
+          )
+        )
+
+        source_type_response['data'].first['id']
+      end
+    end
+
+    def satellite_instance_source
+      @satellite_instance_source ||= begin
+        source_response = JSON.parse(
+          execute_cloud_request(
+            method: :get,
+            url: satellite_instance_source_url,
+            headers: {
+              content_type: :json,
+            },
+            ssl_client_cert: OpenSSL::X509::Certificate.new(certs[:cert]),
+            ssl_client_key: OpenSSL::PKey::RSA.new(certs[:key])
+          )
+        )
+
+        result = source_response['data'].first
+        result&.dig('id')
+      end
+    end
+
+    def create_satellite_instance_source
+      create_response = JSON.parse(
+        execute_cloud_request(
+          method: :post,
+          url: create_satellite_instance_source_url,
+          headers: {
+            content_type: :json,
+          },
+          ssl_client_cert: OpenSSL::X509::Certificate.new(certs[:cert]),
+          ssl_client_key: OpenSSL::PKey::RSA.new(certs[:key]),
+          payload: {
+            name: "satellite: #{Foreman.instance_id} org: #{@organization.name}",
+            source_ref: Foreman.instance_id,
+            source_type_id: satellite_source_type,
+          }.to_json
+        )
+      )
+
+      @satellite_instance_source = create_response['id']
+    end
+
+    def register_rhc_instance
+      raise Foreman::Exception.new('rhc_instance_id is empty, cannot register RHC to the cloud') if Setting[:rhc_instance_id].empty?
+      source_id = satellite_instance_source || create_satellite_instance_source
+
+      create_response = JSON.parse(
+        execute_cloud_request(
+          method: :post,
+          url: create_rhc_connections_url,
+          headers: {
+            content_type: :json,
+          },
+          ssl_client_cert: OpenSSL::X509::Certificate.new(certs[:cert]),
+          ssl_client_key: OpenSSL::PKey::RSA.new(certs[:key]),
+          payload: {
+            source_id: source_id,
+            rhc_id: Setting[:rhc_instance_id],
+          }.to_json
+        )
+      )
+
+      @satellite_instance_source = create_response['id']
+    end
+
+    private
+
+    def sources_url(path)
+      "#{ForemanRhCloud.cert_base_url}/api/sources/v3.1#{path}"
+    end
+
+    def source_type_url
+      sources_url('/source_types?filter[name]=satellite')
+    end
+
+    def satellite_instance_source_url
+      sources_url("/sources?filter[source_ref]=#{Foreman.instance_id}")
+    end
+
+    def create_satellite_instance_source_url
+      sources_url('/sources')
+    end
+
+    def create_rhc_connections_url
+      sources_url('/rhc_connections')
+    end
+
+    def certs
+      @certs ||= candlepin_id_cert(@organization)
+    end
+  end
+end

data/app/services/foreman_rh_cloud/cloud_request.rb

@@ -8,7 +8,14 @@ module ForemanRhCloud
         proxy: ForemanRhCloud.transformed_http_proxy_string(logger: logger),
       }.deep_merge(params)
 
-      RestClient::Request.execute(final_params)
+      response = RestClient::Request.execute(final_params)
+
+      logger.debug("Response headers for request url #{final_params[:url]} are: #{response.headers}")
+
+      response
+    rescue RestClient::Exception => ex
+      logger.debug("Failed response with code #{ex.http_code} headers for request url #{final_params[:url]} are: #{ex.http_headers} and body: #{ex.http_body}")
+      raise ex
     end
   end
 end

data/app/services/foreman_rh_cloud/cloud_request_forwarder.rb

@@ -28,7 +28,7 @@ module ForemanRhCloud
         headers: {
           params: forward_params,
           user_agent: http_user_agent(original_request),
-          content_type: original_request.media_type,
+          content_type: original_request.media_type.presence || original_request.format.to_s,
         },
       }
       base_params.merge(path_params(original_request.path, certs))

data/app/services/foreman_rh_cloud/hit_remediations_retriever.rb

@@ -0,0 +1,67 @@
+module ForemanRhCloud
+  class HitRemediationsRetriever < RemediationsRetriever
+    def initialize(hit_remediation_pairs, logger: Logger.new(IO::NULL))
+      super(logger: logger)
+      @hit_remediation_pairs = hit_remediation_pairs
+      logger.debug("Querying playbook for #{hit_remediation_pairs}")
+    end
+
+    private
+
+    def hit_ids
+      @hit_remediation_pairs.map { |pair| pair["hit_id"] }
+    end
+
+    def remediation_ids
+      @hit_remediation_pairs.map { |pair| pair["resolution_id"] }
+    end
+
+    def hits
+      @hits ||= Hash[
+        InsightsHit.joins(:insights_facet).where(id: hit_ids).pluck(:id, 'insights_facets.uuid')
+      ]
+    end
+
+    def pairs_by_remediation_id
+      @hit_remediation_pairs.group_by { |pair| pair["resolution_id"] }
+    end
+
+    def remediations
+      @remediations ||= Hash[
+        InsightsResolution.where(id: remediation_ids).pluck(:id, :resolution_type, :rule_id).map do |id, resolution_type, rule_id|
+          [id, {resolution_type: resolution_type, rule_id: rule_id}]
+        end
+      ]
+    end
+
+    def playbook_request
+      {
+        issues: pairs_by_remediation_id.map do |remediation_id, pairs|
+          {
+            resolution: remediations[remediation_id][:resolution_type],
+            id: InsightsCloud.remediation_rule_id(remediations[remediation_id][:rule_id]),
+            systems: pairs.map do |pair|
+              hits[pair["hit_id"]]
+            end,
+          }
+        end,
+      }
+    end
+
+    def playbook_url
+      InsightsCloud.playbook_url
+    end
+
+    def headers
+      super
+    end
+
+    def payload
+      playbook_request.to_json
+    end
+
+    def method
+      :post
+    end
+  end
+end

data/app/services/foreman_rh_cloud/remediations_retriever.rb

@@ -4,11 +4,8 @@ module ForemanRhCloud
 
     attr_reader :logger
 
-    def initialize(hit_remediation_pairs, logger: Logger.new(IO::NULL))
-      @hit_remediation_pairs = hit_remediation_pairs
+    def initialize(logger: Logger.new(IO::NULL))
       @logger = logger
-
-      logger.debug("Querying playbook for #{hit_remediation_pairs}")
     end
 
     def create_playbook
@@ -26,55 +23,29 @@ module ForemanRhCloud
 
     private
 
-    def hit_ids
-      @hit_remediation_pairs.map { |pair| pair["hit_id"] }
-    end
-
-    def remediation_ids
-      @hit_remediation_pairs.map { |pair| pair["resolution_id"] }
-    end
-
-    def hits
-      @hits ||= Hash[
-        InsightsHit.joins(:insights_facet).where(id: hit_ids).pluck(:id, 'insights_facets.uuid')
-      ]
-    end
-
-    def pairs_by_remediation_id
-      @hit_remediation_pairs.group_by { |pair| pair["resolution_id"] }
+    def query_playbook
+      execute_cloud_request(
+        method: method,
+        url: playbook_url,
+        headers: headers,
+        payload: payload
+      )
     end
 
-    def remediations
-      @remediations ||= Hash[
-        InsightsResolution.where(id: remediation_ids).pluck(:id, :resolution_type, :rule_id).map do |id, resolution_type, rule_id|
-          [id, {resolution_type: resolution_type, rule_id: rule_id}]
-        end
-      ]
+    def playbook_url
     end
 
-    def playbook_request
+    def headers
       {
-        issues: pairs_by_remediation_id.map do |remediation_id, pairs|
-          {
-            resolution: remediations[remediation_id][:resolution_type],
-            id: InsightsCloud.remediation_rule_id(remediations[remediation_id][:rule_id]),
-            systems: pairs.map do |pair|
-              hits[pair["hit_id"]]
-            end,
-          }
-        end,
+        content_type: :json,
       }
     end
 
-    def query_playbook
-      execute_cloud_request(
-        method: :post,
-        url: InsightsCloud.playbook_url,
-        headers: {
-          content_type: :json,
-        },
-        payload: playbook_request.to_json
-      )
+    def payload
+    end
+
+    def method
+      :get
     end
   end
 end

data/app/services/foreman_rh_cloud/template_renderer_helper.rb

@@ -15,8 +15,20 @@ module ForemanRhCloud
     end
     def remediations_playbook(hit_remediation_pairs)
       hit_remediation_pairs = JSON.parse(hit_remediation_pairs)
-      retriever = ForemanRhCloud::RemediationsRetriever.new(hit_remediation_pairs, logger: template_logger)
+      retriever = ForemanRhCloud::HitRemediationsRetriever.new(hit_remediation_pairs, logger: template_logger)
       retriever.create_playbook
     end
+
+    apipie :method, 'Returns a Red Hat remediation playbook compiled on console.redhat.com' do
+      required :remediation_path, String, desc: ''
+      returns String, desc: 'Playbook downloaded from the cloud'
+    end
+    def download_rh_playbook(playbook_url)
+      retriever = ForemanRhCloud::UrlRemediationsRetriever.new(url: playbook_url, logger: template_logger)
+
+      cached("rh_playbook_#{playbook_url}") do
+        retriever.create_playbook
+      end
+    end
   end
 end

data/app/services/foreman_rh_cloud/url_remediations_retriever.rb

@@ -0,0 +1,37 @@
+module ForemanRhCloud
+  class UrlRemediationsRetriever < RemediationsRetriever
+    attr_reader :url, :payload, :headers
+
+    def initialize(url:, payload: '', headers: {}, logger: Logger.new(IO::NULL))
+      super(logger: logger)
+
+      @url = url
+      @payload = payload
+      @headers = headers
+    end
+
+    private
+
+    def query_playbook
+      logger.debug("Querying playbook at: #{url} with payload: #{payload} and headers: #{headers}")
+
+      super
+    end
+
+    def playbook_url
+      @url
+    end
+
+    def headers
+      super.deep_merge(@headers)
+    end
+
+    def payload
+      @payload.to_json
+    end
+
+    def method
+      :get
+    end
+  end
+end

data/app/views/job_templates/rh_cloud_download_playbook.erb

@@ -0,0 +1,26 @@
+<%#
+kind: job_template
+name: Run a playbook downloaded from RH cloud
+job_category: Red Hat Insights
+description_format: 'Playbook generated by RH Cloud'
+feature: rh_cloud_connector_run_playbook
+template_inputs:
+- name: playbook_url
+  description: URL of the playbook to run
+  input_type: user
+  required: true
+- name: report_url
+  description: URL for calling the report callback
+  input_type: user
+  required: true
+- name: correlation_id
+  description: correlation ID used to identify the original calling message
+  input_type: user
+  required: true
+- name: report_interval
+  description: Reporting interval for the task. A report will be generated every report_interval seconds.
+  input_type: user
+  required: true
+provider_type: Ansible
+%>
+<%= download_rh_playbook(input('playbook_url')) %>

data/config/routes.rb

@@ -58,6 +58,8 @@ Rails.application.routes.draw do
 
       namespace 'rh_cloud' do
         post 'enable_connector', to: 'inventory#enable_cloud_connector'
+
+        post 'cloud_request', to: 'cloud_request#update'
       end
     end
   end

data/lib/foreman_inventory_upload/generators/fact_helpers.rb

@@ -104,7 +104,9 @@ module ForemanInventoryUpload
       end
 
       def obfuscate_ip(ip, ips_dict)
-        "10.230.230.#{ips_dict.count + 1}"
+        max_obfuscated = ips_dict.values.map { |v| IPAddr.new(v).to_i }.max || IPAddr.new('10.230.230.0').to_i
+
+        IPAddr.new(max_obfuscated + 1, Socket::AF_INET).to_s
       end
 
       def bios_uuid(host)

data/lib/foreman_rh_cloud/engine.rb

@@ -76,9 +76,13 @@ module ForemanRhCloud
             },
             :resource_type => ::InsightsHit.name
           )
+          permission(
+            :dispatch_cloud_requests,
+            'api/v2/rh_cloud/cloud_request': [:update]
+          )
         end
 
-        plugin_permissions = [:view_foreman_rh_cloud, :generate_foreman_rh_cloud, :view_insights_hits]
+        plugin_permissions = [:view_foreman_rh_cloud, :generate_foreman_rh_cloud, :view_insights_hits, :dispatch_cloud_requests]
 
         role 'ForemanRhCloud', plugin_permissions, 'Role granting permissions to view the hosts inventory,
                                                     generate a report, upload it to the cloud and download it locally'
@@ -116,7 +120,7 @@ module ForemanRhCloud
         end
 
         extend_template_helpers ForemanRhCloud::TemplateRendererHelper
-        allowed_template_helpers :remediations_playbook
+        allowed_template_helpers :remediations_playbook, :download_rh_playbook
       end
 
       ::Katello::UINotifications::Subscriptions::ManifestImportSuccess.include ForemanInventoryUpload::Notifications::ManifestImportSuccessNotificationOverride if defined?(Katello)
@@ -145,6 +149,13 @@ module ForemanRhCloud
           description: N_('Run remediation playbook generated by Insights'),
           host_action_button: false
         )
+        RemoteExecutionFeature.register(
+          :rh_cloud_connector_run_playbook,
+          N_('Run RH Cloud playbook'),
+          description: N_('Run playbook genrated by Red Hat remediations app'),
+          host_action_button: false,
+          provided_inputs: ['playbook_url', 'report_url', 'correlation_id', 'report_interval']
+        )
         # skip object creation when admin user is not present, for example in test DB
         if User.unscoped.find_by_login(User::ANONYMOUS_ADMIN).present?
           ::ForemanTasks.dynflow.config.on_init(false) do |world|

data/lib/foreman_rh_cloud/version.rb

@@ -1,3 +1,3 @@
 module ForemanRhCloud
-  VERSION = '5.0.30'.freeze
+  VERSION = '5.0.33'.freeze
 end

data/lib/foreman_rh_cloud.rb

@@ -109,10 +109,20 @@ module ForemanRhCloud
   end
 
   def self.foreman_host_name
-    ENV['SATELLITE_RH_CLOUD_FOREMAN_HOST'] || ::SmartProxy.default_capsule.name
+    ENV['SATELLITE_RH_CLOUD_FOREMAN_HOST'] || marked_foreman_host&.name || ::SmartProxy.default_capsule.name
+  end
+
+  def self.marked_foreman_host
+    ::Host.unscoped.search_for('infrastructure_facet.foreman = true').first
+  rescue ScopedSearch::QueryNotSupported
+    nil
   end
 
   def self.legacy_insights_ca
     "#{ForemanRhCloud::Engine.root}/config/rh_cert-api_chain.pem"
   end
+
+  def self.cloud_url_validator
+    @cloud_url_validator ||= Regexp.new(ENV['SATELLITE_RH_CLOUD_VALIDATOR'] || 'redhat.com$')
+  end
 end