foreman_rh_cloud 3.0.18.1 → 3.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72303b7bc3f1bc2deb3972acde6131cdbe4d1760381d1eb8cdaa5704e3189481
-  data.tar.gz: 725efab879cee6224007359547068820882319d078089760cac43a8c763df754
+  metadata.gz: 6edd44f8ce4af74d7affca479d84e6012b8a8d363bafcab2ef95fb97eaae5eac
+  data.tar.gz: 865870711b1216ea512f5bc5c304f46df1f176b568e4fbb39f6e4686efa68cfb
 SHA512:
-  metadata.gz: 28d7e810476e8202a62aa7381e8d3ef86cec5f2f6a7bc9580d5a116a543275183201ad573e848f30a65253bee2f20e7b0385f0cc6f0ab90637cfb03398557188
-  data.tar.gz: 52560a0917aecaed1c9897c593769c19b7dde9348c1b0450cd32fb4998d5c63e4232d671a1b767e33e6dcec960b3f4647bc23d56a80f15c1f18930db8b772409
+  metadata.gz: c0f841e299dd1304590bef74ade8c7b10c9f5392ce7bf164f99243c4cf9d1c68d0061dbb83281bc84123539edca21fdbbcd3bbf1f82e3234a0afd6437cca1c0d
+  data.tar.gz: ea5d3651236539899e42085000c4f0aa2401229aff79ef22afaee9eef5c277af38054b0e347fc17d6f119267b1b17410d610b6144883b6b19ec1bdf3ac568d98

data/README.md

@@ -42,7 +42,7 @@ In UI: Configure -> Insights -> Sync now
 
 From command-line:
 
-    /usr/sbin/foreman-rake rh_cloud_inventory:sync
+    /usr/sbin/foreman-rake rh_cloud_insights:sync
 
 #### Synchronize inventory status
 
@@ -51,16 +51,32 @@ In UI: Configure -> Inventory Upload -> Sync inventory status
 From command-line:
 
     # all organizations
-    /usr/sbin/foreman-rake rh_cloud_insights:sync
-    
+    /usr/sbin/foreman-rake rh_cloud_inventory:sync
+
     # specific organization with id 1
     export organization_id=1
-    /usr/sbin/foreman-rake rh_cloud_insights:sync
+    /usr/sbin/foreman-rake rh_cloud_inventory:sync
 
 ## TODO
 
 *Todo list here*
 
+## Design
+
+### Endpoints
+
+| purpose                       | url    | ENV setting for the **bold** part
+| ------------------------------| -------| -----------
+| Inventory uploads             | **https://cert.cloud.redhat.com/api/ingress/v1/upload**    | SATELLITE_INVENTORY_UPLOAD_URL
+| Query inventory hosts list    | **https://cloud.redhat.com** /api/inventory/v1/hosts?tags=  | SATELLITE_RH_CLOUD_URL
+| Query insights hits           | **https://cloud.redhat.com** /api/insights/v1/export/hits/  | SATELLITE_RH_CLOUD_URL
+| Query insights rules          | **https://cloud.redhat.com** /api/insights/v1/rule/?impacting=true&rule_status=enabled&has_playbook=true&limit=&offset=  | SATELLITE_RH_CLOUD_URL
+| Query insights resolutions    | **https://cloud.redhat.com** /api/remediations/v1/resolutions| SATELLITE_RH_CLOUD_URL
+| Forward insights-client `/static` requests    | **https://cloud.redhat.com** /api/static    | SATELLITE_RH_CLOUD_URL
+| Forward insights-client legacy `/platform` requests    | **https://cert.cloud.redhat.com** /api    | SATELLITE_CERT_RH_CLOUD_URL
+| Forward insights-client legacy `/redhat_access/r/insights` requests    | **https://cert-api.access.redhat.com** /r/insights    | SATELLITE_LEGACY_INSIGHTS_URL
+
+
 ## Contributing
 
 Fork and send a Pull Request. Thanks!
@@ -81,4 +97,3 @@ GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
-

data/app/controllers/foreman_inventory_upload/tasks_controller.rb

@@ -13,12 +13,23 @@ module ForemanInventoryUpload
           message: N_('Nothing to sync, there are no hosts with subscription for this organization.'),
         }, status: :method_not_allowed
       else
-        host_statuses = InventorySync::Async::InventoryFullSync.perform_now(selected_org)
+        task = ForemanTasks.async_task(InventorySync::Async::InventoryFullSync, selected_org)
       end
+      return render json: { message: N_('there was an issue triggering the task') }, status: :internal_server_error unless task
 
       render json: {
-        syncHosts: host_statuses[:sync],
-        disconnectHosts: host_statuses[:disconnect],
+        task: task,
+      }, status: :ok
+    end
+
+    def show
+      task = ForemanTasks::Task.find_by(id: params[:id])
+      return render json: { message: N_('No task was found') }, status: :internal_server_error unless task
+
+      render json: {
+        endedAt: task.ended_at,
+        output: task.output,
+        result: task.result,
       }, status: :ok
     end
   end

data/app/controllers/foreman_inventory_upload/uploads_settings_controller.rb

@@ -8,6 +8,7 @@ module ForemanInventoryUpload
         excludePackagesEnabled: Setting[:exclude_installed_packages],
         CloudConnectorStatus: ForemanInventoryUpload::UploadsSettingsController.cloud_connector_status,
         cloudToken: !Setting[:rh_cloud_token].empty?,
+        lastSyncTask: last_successful_inventory_sync_task,
       }, status: :ok
     end
 
@@ -22,5 +23,12 @@ module ForemanInventoryUpload
       return nil unless job
       { id: job.id, task: ForemanTasks::Task.where(:id => job.task_id).first }
     end
+
+    def last_successful_inventory_sync_task
+      task = ForemanTasks::Task.where(label: 'InventorySync::Async::InventoryFullSync', result: 'success')
+                        .reorder('ended_at desc').first
+      return nil unless task
+      { output: task.output, endedAt: task.ended_at }
+    end
   end
 end

data/app/controllers/insights_cloud/api/machine_telemetries_controller.rb

@@ -10,27 +10,28 @@ module InsightsCloud::Api
 
     skip_after_action :log_response_body, :only => [:forward_request]
     skip_before_action :check_media_type, :only => [:forward_request]
+    after_action :update_host_insights_status, only: [:forward_request]
 
     # The method that "proxies" requests over to Cloud
     def forward_request
       certs = candlepin_id_cert @organization
-      cloud_response = ::ForemanRhCloud::CloudRequestForwarder.new.forward_request(request, controller_name, @branch_id, certs)
+      @cloud_response = ::ForemanRhCloud::CloudRequestForwarder.new.forward_request(request, controller_name, @branch_id, certs)
 
-      if cloud_response.code == 401
+      if @cloud_response.code == 401
         return render json: {
           :message => 'Authentication to the Insights Service failed.',
           :headers => {},
         }, status: :bad_gateway
       end
 
-      if cloud_response.headers[:content_disposition]
-        return send_data cloud_response, disposition: cloud_response.headers[:content_disposition], type: cloud_response.headers[:content_type]
+      if @cloud_response.headers[:content_disposition]
+        return send_data @cloud_response, disposition: @cloud_response.headers[:content_disposition], type: @cloud_response.headers[:content_type]
       end
 
-      assign_header(response, cloud_response, :x_resource_count, true)
-      assign_header(response, cloud_response, :x_rh_insights_request_id, false)
+      assign_header(response, @cloud_response, :x_resource_count, true)
+      assign_header(response, @cloud_response, :x_rh_insights_request_id, false)
 
-      render json: cloud_response, status: cloud_response.code
+      render json: @cloud_response, status: @cloud_response.code
     end
 
     def branch_info
@@ -69,5 +70,14 @@ module InsightsCloud::Api
       @branch_id = cp_owner_id(@organization)
       return render_message "Branch ID not found for organization #{@organization.title}", :status => 400 unless @branch_id
     end
+
+    def update_host_insights_status
+      return unless request.path == '/redhat_access/r/insights/platform/ingress/v1/upload' ||
+                    request.path.include?('/redhat_access/r/insights/uploads/')
+
+      data = @cloud_response.code.to_s.start_with?('2')
+      host_status = @host.get_status(InsightsClientReportStatus)
+      host_status.update(reported_at: Time.now.utc, status: host_status.to_status(data: data))
+    end
   end
 end

data/app/controllers/insights_cloud/hits_controller.rb

@@ -9,6 +9,7 @@ module InsightsCloud
         hasToken: !Setting[:rh_cloud_token].empty?,
         hits: hits.map { |hit| hit.attributes.merge(hostname: hit.host&.name, has_playbook: hit.has_playbook?) },
         itemCount: hits.count,
+        isExperimentalMode: Setting[:lab_features],
       }, status: :ok
     end
 
@@ -20,6 +21,21 @@ module InsightsCloud
       }, status: :ok
     end
 
+    def resolutions
+      if remediation_all_selected_param
+        hits = InsightsHit.with_playbook.search_for(params[:query])
+      else
+        hits = resource_base_search_and_page.where(id: remediation_ids_param)
+      end
+
+      hits.preload(:host, rule: :resolutions)
+
+      render json: {
+        hits: hits.map { |hit| hit.attributes.merge(hostname: hit.host&.name, resolutions: hit.rule.resolutions.map(&:attributes), reboot: hit.rule.reboot_required) },
+        itemCount: hits.count,
+      }, status: :ok
+    end
+
     def model_of_controller
       ::InsightsHit
     end
@@ -32,10 +48,31 @@ module InsightsCloud
       :insights_hits
     end
 
+    def action_permission
+      case params[:action]
+      when 'resolutions'
+        'view'
+      else
+        super
+      end
+    end
+
     private
 
     def host_id_param
       params.require(:host_id)
     end
+
+    def remediation_request_params
+      params.permit(remediations: [:hit_id, :remediation_id]).require(:remediations)
+    end
+
+    def remediation_ids_param
+      params.require(:ids).map(&:to_i)
+    end
+
+    def remediation_all_selected_param
+      ActiveModel::Type::Boolean.new.cast(params[:isAllSelected])
+    end
   end
 end

data/app/controllers/insights_cloud/settings_controller.rb

@@ -13,7 +13,7 @@ module InsightsCloud
       token = Setting::RhCloud.find_by_name("rh_cloud_token")
       token.value = params.require(:value)
       token.save!
-      InsightsCloud::Async::InsightsFullSync.perform_now
+      ForemanTasks.sync_task(InsightsCloud::Async::InsightsFullSync)
       redirect_to(:controller => "hits", :action => 'index')
     end
 

data/app/controllers/insights_cloud/tasks_controller.rb

@@ -1,8 +1,7 @@
 module InsightsCloud
   class TasksController < ::ApplicationController
     def create
-      job = InsightsCloud::Async::InsightsFullSync.perform_later
-      task = ForemanTasks::Task.find_by(external_id: job.provider_job_id)
+      task = ForemanTasks.async_task(InsightsCloud::Async::InsightsFullSync)
 
       render json: {
         task: task,

data/app/models/insights_client_report_status.rb

@@ -0,0 +1,58 @@
+class InsightsClientReportStatus < HostStatus::Status
+  REPORT_INTERVAL = 48.hours
+
+  REPORTING             = 0 # host_registration_insights = true & getting data
+  NO_REPORT             = 1 # host_registration_insights = true & not getting data
+  NOT_MANAGED           = 2 # host_registration_insights = false
+  NOT_MANAGED_WITH_DATA = 3 # host_registration_insights = false & getting data
+
+  def self.status_name
+    N_('Insights')
+  end
+
+  def to_label(_options = {})
+    case status
+      when REPORTING
+        N_('Reporting')
+      when NO_REPORT
+        N_('Not reporting')
+      when NOT_MANAGED
+        N_('Not reporting (not set by registration)')
+      when NOT_MANAGED_WITH_DATA
+        N_('Reporting (not set by registration)')
+    end
+  end
+
+  def to_global(_options = {})
+    case status
+      when REPORTING
+        ::HostStatus::Global::OK
+      when NO_REPORT
+        ::HostStatus::Global::ERROR
+      when NOT_MANAGED
+        ::HostStatus::Global::OK
+      when NOT_MANAGED_WITH_DATA
+        ::HostStatus::Global::WARN
+    end
+  end
+
+  def to_status(data: false)
+    if insights_param
+      return REPORTING if data
+      return in_interval? ? REPORTING : NO_REPORT
+    end
+
+    data ? NOT_MANAGED_WITH_DATA : NOT_MANAGED
+  end
+
+  private
+
+  def in_interval?
+    return false unless reported_at
+    (Time.now.utc - reported_at).to_i < REPORT_INTERVAL.to_i
+  end
+
+  def insights_param
+    host.host_params_hash.dig('host_registration_insights', :value)
+  end
+end

data/app/models/insights_resolution.rb

@@ -1,3 +1,3 @@
 class InsightsResolution < ApplicationRecord
-  belongs_to :rule, class_name: 'InsightsRule', foreign_key: 'rule_id', primary_key: 'rule_id', inverse_of: :resolutions
+  belongs_to :rule, class_name: 'InsightsRule', primary_key: 'rule_id', inverse_of: :resolutions
 end

data/app/models/inventory_sync/inventory_status.rb

@@ -26,5 +26,11 @@ module InventorySync
           N_('Successfully uploaded to your RH cloud inventory')
       end
     end
+
+    def to_status(options = {})
+      # this method used to calculate status.
+      # Since the calculation is done externally we should return the previously calculated status
+      status
+    end
   end
 end

data/app/models/setting/rh_cloud.rb

@@ -14,12 +14,12 @@ class Setting::RhCloud < Setting
   def self.default_settings
     return unless ActiveRecord::Base.connection.table_exists?('settings')
     [
-      set('allow_auto_inventory_upload', N_('Allow automatic upload of the host inventory to the Red Hat cloud'), true, N_('Allow automatic inventory uploads')),
-      set('allow_auto_insights_sync', N_('Allow recommendations synchronization from Red Hat cloud'), false, N_('Allow recommendations synchronization')),
-      set('obfuscate_inventory_hostnames', N_('Obfuscate host names sent to Red Hat cloud'), false, N_('Obfuscate host names')),
-      set('obfuscate_inventory_ips', N_('Obfuscate ip addresses sent to Red Hat cloud'), false, N_('Obfuscate IPs')),
+      set('allow_auto_inventory_upload', N_('Enable automatic upload of your host inventory to the Red Hat cloud'), true, N_('Automatic inventory upload')),
+      set('allow_auto_insights_sync', N_('Enable automatic synchronization of Insights recommendations from the Red Hat cloud'), false, N_('Synchronize recommendations Automatically')),
+      set('obfuscate_inventory_hostnames', N_('Obfuscate host names sent to the Red Hat cloud'), false, N_('Obfuscate host names')),
+      set('obfuscate_inventory_ips', N_('Obfuscate ipv4 addresses sent to the Red Hat cloud'), false, N_('Obfuscate host ipv4 addresses')),
       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 Red Hat cloud inventory report'), false, N_("Don't upload installed packages")),
+      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')),
     ]
   end

data/app/services/foreman_rh_cloud/cloud_auth.rb

@@ -2,6 +2,8 @@ module ForemanRhCloud
   module CloudAuth
     extend ActiveSupport::Concern
 
+    include CloudRequest
+
     def rh_credentials
       @rh_credentials ||= query_refresh_token
     end
@@ -24,5 +26,15 @@ module ForemanRhCloud
       Foreman::Logging.exception('Unable to authenticate using rh_cloud_token setting', e)
       raise ::Foreman::WrappedException.new(e, N_('Unable to authenticate using rh_cloud_token setting'))
     end
+
+    def execute_cloud_request(params)
+      final_params = {
+        headers: {
+          Authorization: "Bearer #{rh_credentials}",
+        },
+      }.deep_merge(params)
+
+      super(final_params)
+    end
   end
 end

data/app/services/foreman_rh_cloud/cloud_connector.rb

@@ -59,7 +59,7 @@ module ForemanRhCloud
     end
 
     def foreman_host
-      ::Host.unscoped.friendly.find(::SmartProxy.default_capsule.name)
+      ForemanRhCloud.foreman_host
     end
   end
 end

data/app/services/foreman_rh_cloud/cloud_request.rb

@@ -0,0 +1,14 @@
+module ForemanRhCloud
+  module CloudRequest
+    extend ActiveSupport::Concern
+
+    def execute_cloud_request(params)
+      final_params = {
+        verify_ssl: ForemanRhCloud.verify_ssl_method,
+        proxy: ForemanRhCloud.transformed_http_proxy_string(logger: logger),
+      }.deep_merge(params)
+
+      RestClient::Request.execute(final_params)
+    end
+  end
+end

data/app/services/foreman_rh_cloud/cloud_request_forwarder.rb

@@ -2,7 +2,7 @@ require 'rest-client'
 
 module ForemanRhCloud
   class CloudRequestForwarder
-    include ::ForemanRhCloud::CloudAuth
+    include ForemanRhCloud::CloudRequest
 
     def forward_request(original_request, controller_name, branch_id, certs)
       forward_params = prepare_forward_params(original_request, branch_id)
@@ -22,7 +22,6 @@ module ForemanRhCloud
     def prepare_request_opts(original_request, forward_payload, forward_params, certs)
       base_params = {
         method: original_request.method,
-        verify_ssl: ForemanRhCloud.verify_ssl_method,
         payload: forward_payload,
         headers: {
           params: forward_params,
@@ -33,10 +32,6 @@ module ForemanRhCloud
       base_params.merge(path_params(original_request.path, certs))
     end
 
-    def execute_cloud_request(request_opts)
-      RestClient::Request.execute request_opts
-    end
-
     def prepare_forward_payload(original_request, controller_name)
       forward_payload = original_request.request_parameters[controller_name]
 

data/app/services/foreman_rh_cloud/remediations_retriever.rb

@@ -0,0 +1,75 @@
+module ForemanRhCloud
+  class RemediationsRetriever
+    include CloudAuth
+
+    attr_reader :logger
+
+    def initialize(hit_remediation_pairs, logger: Logger.new(IO::NULL))
+      @hit_remediation_pairs = hit_remediation_pairs
+      @logger = logger
+
+      logger.debug("Querying playbook for #{hit_remediation_pairs}")
+    end
+
+    def create_playbook
+      response = query_playbook
+
+      logger.debug("Got playbook response: #{response.body}")
+
+      response.body
+    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 query_playbook
+      execute_cloud_request(
+        method: :post,
+        url: InsightsCloud.playbook_url,
+        headers: {
+          content_type: :json,
+        },
+        payload: playbook_request.to_json
+      )
+    end
+  end
+end