foreman_rh_cloud 3.0.19 → 3.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43110585639a77e33c9c4fb1fce44855b6fb4c9793db3fc624a01b567c09e400
-  data.tar.gz: '00285b699105835e629127cc96801082ece7ff41c9a93d82fcb7e7a6b2662c65'
+  metadata.gz: 1a6bf66d7fd1c5302e88b9cd6f28f36c36d9ba8ecfcba3f32e4076c5ba856a05
+  data.tar.gz: d9d67e5ec55ac92e3101544c9e2d7f8f3d8e40112927c70efc23ddb117e8f96b
 SHA512:
-  metadata.gz: aa89cca9fb72a26453a44cba2120c51ab3f47f67ec40ca8e539a1dfaeddae73687bd909e3f3880cd3eed94c7c5d4b509bb55e2450f5bf4e55a8db2f73ceaabe9
-  data.tar.gz: 33d4200395db6f2f9a0e2dbd8b27d8c55ff66d7da87efa9c9c39663468f0dd9c43c8949b0ce09b2158875d053375e39d03e4550b821732df4d49fb52f5872cb3
+  metadata.gz: c241a52fe6d3f028777c0c70cea3cc68a2008cf2392d4dd9608b5332614638dce68baade016fddd46985ddcf6cddfa9638d28a86c6f645147ed52a304063a4a4
+  data.tar.gz: f32f203c82ddc7d4964155ac0afcfa18fc6cd6501df8a9bff9197e6fc03590cd5c71720fb8c512c64c920b503ed01d7a6118f2633e64f36f5a05ffd222af4197

data/README.md

@@ -52,7 +52,7 @@ From command-line:
 
     # all organizations
     /usr/sbin/foreman-rake rh_cloud_insights:sync
-    
+
     # specific organization with id 1
     export organization_id=1
     /usr/sbin/foreman-rake rh_cloud_insights:sync
@@ -61,6 +61,22 @@ From command-line:
 
 *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/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/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/remediations_retriever.rb

@@ -0,0 +1,78 @@
+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
+      RestClient::Request.execute(
+        method: :post,
+        url: InsightsCloud.playbook_url,
+        verify_ssl: ForemanRhCloud.verify_ssl_method,
+        proxy: ForemanRhCloud.transformed_http_proxy_string(logger: logger),
+        headers: {
+          content_type: :json,
+          Authorization: "Bearer #{rh_credentials}",
+        },
+        payload: playbook_request.to_json
+      )
+    end
+  end
+end

data/app/services/foreman_rh_cloud/template_renderer_helper.rb

@@ -0,0 +1,22 @@
+module ForemanRhCloud
+  # Macro to fetch remediation playbook from cloud.redhat.com
+  module TemplateRendererHelper
+    extend ActiveSupport::Concern
+    extend ApipieDSL::Module
+
+    apipie :class, 'Macros related to Red Hat cloud interface' do
+      name 'RHCloud'
+      sections only: %w[all jobs]
+    end
+
+    apipie :method, 'Returns a playbook generated from Red Hat cloud recommendations' do
+      required :hit_remediation_pairs, String, desc: 'JSON-encoded array of hashes in the form of [{hit_id: 1, remediation_id: 2}, ...]'
+      returns String, desc: 'Playbook generated for the specific recommendations and hosts'
+    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.create_playbook
+    end
+  end
+end

data/app/views/job_templates/rh_cloud_remediations.erb

@@ -0,0 +1,14 @@
+<%#
+kind: job_template
+name: Run remediations based on Insights recommendations
+job_category: Red Hat Insights
+description_format: 'Insights remediations for selected issues'
+feature: rh_cloud_remediate_hosts
+template_inputs:
+- name: hit_remediation_pairs
+  description: Pairs of issues and selected remediation
+  input_type: user
+  required: true
+provider_type: Ansible
+%>
+<%= remediations_playbook(input('hit_remediation_pairs')) %>

data/config/routes.rb

@@ -19,6 +19,7 @@ Rails.application.routes.draw do
     resources :hits, except: %i[show] do
       collection do
         get 'auto_complete_search'
+        get 'resolutions', to: 'hits#resolutions'
       end
     end
     match 'hits/:host_id', to: 'hits#show', via: :get

data/db/migrate/20210404000001_change_resolutions.foreman_rh_cloud.rb

@@ -0,0 +1,10 @@
+class ChangeResolutions < ActiveRecord::Migration[5.2]
+  def change
+    remove_column :insights_resolutions, :system_type, :integer
+    remove_column :insights_resolutions, :has_playbook, :boolean
+    rename_column :insights_resolutions, :resolution, :description
+    add_column :insights_resolutions, :needs_reboot, :boolean
+    add_column :insights_resolutions, :resolution_risk, :integer
+    add_column :insights_resolutions, :resolution_type, :string
+  end
+end

data/db/seeds.d/50_job_templates.rb

@@ -0,0 +1,14 @@
+organizations = Organization.unscoped.all
+locations = Location.unscoped.all
+User.as_anonymous_admin do
+  JobTemplate.without_auditing do
+    Dir[File.join("#{ForemanRhCloud::Engine.root}/app/views/job_templates/**/*.erb")].each do |template|
+      template = JobTemplate.import_raw!(File.read(template),
+      :default => true,
+      :lock => true,
+      :update => true)
+      template.organizations = organizations if template.present?
+      template.locations = locations if template.present?
+    end
+  end
+end

data/lib/foreman_rh_cloud/engine.rb

@@ -48,7 +48,7 @@ module ForemanRhCloud
             :view_insights_hits,
             {
               '/foreman_rh_cloud/insights_cloud': [:index], # for bookmarks and later for showing the page
-              'insights_cloud/hits': [:index, :show, :auto_complete_search],
+              'insights_cloud/hits': [:index, :show, :auto_complete_search, :resolutions],
               'insights_cloud/settings': [:index, :show],
               'react': [:index],
             },
@@ -87,6 +87,9 @@ module ForemanRhCloud
             id: 'insights',
             onlyif: proc { |host| host.insights }
         end
+
+        extend_template_helpers ForemanRhCloud::TemplateRendererHelper
+        allowed_template_helpers :remediations_playbook
       end
 
       ::Katello::UINotifications::Subscriptions::ManifestImportSuccess.include ForemanInventoryUpload::Notifications::ManifestImportSuccessNotificationOverride if defined?(Katello)
@@ -114,5 +117,14 @@ module ForemanRhCloud
       locale_domain = 'foreman_rh_cloud'
       Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
     end
+
+    config.to_prepare do
+      RemoteExecutionFeature.register(
+        :rh_cloud_remediate_hosts,
+        N_('Apply Insights recommendations'),
+        description: N_('Run remediation playbook generated by Insights'),
+        host_action_button: false
+      )
+    end
   end
 end

data/lib/foreman_rh_cloud/version.rb

@@ -1,3 +1,3 @@
 module ForemanRhCloud
-  VERSION = '3.0.19'.freeze
+  VERSION = '3.0.20'.freeze
 end

data/lib/insights_cloud.rb

@@ -16,4 +16,16 @@ module InsightsCloud
   def self.rules_url(limit: ForemanRhCloud.query_limit, offset: 0)
     ForemanRhCloud.base_url + "/api/insights/v1/rule/?impacting=true&rule_status=enabled&has_playbook=true&limit=#{limit}&offset=#{offset}"
   end
+
+  def self.resolutions_url
+    ForemanRhCloud.base_url + '/api/remediations/v1/resolutions'
+  end
+
+  def self.playbook_url
+    ForemanRhCloud.base_url + '/api/remediations/v1/playbook'
+  end
+
+  def self.remediation_rule_id(rule_id)
+    "advisor:#{rule_id}"
+  end
 end

data/lib/insights_cloud/async/insights_full_sync.rb

@@ -2,17 +2,19 @@ require 'rest-client'
 
 module InsightsCloud
   module Async
-    class InsightsFullSync < ::ApplicationJob
+    class InsightsFullSync < ::Actions::EntryAction
       include ::ForemanRhCloud::CloudAuth
 
-      def perform
+      def plan
         # This can be turned off when we enable automatic status syncs
         # This step will query cloud inventory to retrieve inventory uuids for each host
-        ForemanTasks.sync_task(InventorySync::Async::InventoryHostsSync)
+        plan_hosts_sync
+        plan_self
+        plan_rules_sync
+      end
 
+      def run
         perform_hits_sync
-
-        InsightsRulesSync.perform_later
       end
 
       def perform_hits_sync
@@ -25,11 +27,19 @@ module InsightsCloud
       end
 
       def logger
-        Foreman::Logging.logger('background')
+        action_logger
       end
 
       private
 
+      def plan_hosts_sync
+        plan_action InventorySync::Async::InventoryHostsSync
+      end
+
+      def plan_rules_sync
+        plan_action InsightsRulesSync
+      end
+
       def query_insights_hits
         hits_response = RestClient::Request.execute(
           method: :get,

data/lib/insights_cloud/async/insights_resolutions_sync.rb

@@ -0,0 +1,69 @@
+require 'rest-client'
+
+module InsightsCloud
+  module Async
+    class InsightsResolutionsSync < ::Actions::EntryAction
+      include ::ForemanRhCloud::CloudAuth
+
+      RULE_ID_REGEX = /[^:]*:(?<id>.*)/
+
+      def run
+        InsightsResolution.transaction do
+          InsightsResolution.delete_all
+          api_response = query_insights_resolutions(relevant_rules)
+          write_resolutions(api_response)
+        end
+      end
+
+      def logger
+        action_logger
+      end
+
+      private
+
+      def query_insights_resolutions(rule_ids)
+        resolutions_response = RestClient::Request.execute(
+          method: :post,
+          url: InsightsCloud.resolutions_url,
+          verify_ssl: ForemanRhCloud.verify_ssl_method,
+          proxy: ForemanRhCloud.transformed_http_proxy_string(logger: logger),
+          headers: {
+            content_type: :json,
+            Authorization: "Bearer #{rh_credentials}",
+          },
+          payload: {
+            issues: rule_ids,
+          }.to_json
+        )
+
+        JSON.parse(resolutions_response)
+      end
+
+      def relevant_rules
+        InsightsRule.all.pluck(:rule_id).map { |id| InsightsCloud.remediation_rule_id(id) }
+      end
+
+      def to_resolution_hash(rule_id, resolution_hash)
+        {
+          rule_id: rule_id,
+          description: resolution_hash['description'],
+          resolution_type: resolution_hash['id'],
+          needs_reboot: resolution_hash['needs_reboot'],
+          resolution_risk: resolution_hash['resolution_risk'],
+        }
+      end
+
+      def write_resolutions(response)
+        all_resolutions = response.map do |rule_id, rule_details|
+          rule_details['resolutions'].map { |resolution| to_resolution_hash(to_rule_id(rule_id), resolution) }
+        end.flatten
+
+        InsightsResolution.create(all_resolutions)
+      end
+
+      def to_rule_id(resolution_rule_id)
+        RULE_ID_REGEX.match(resolution_rule_id).named_captures.fetch('id', resolution_rule_id)
+      end
+    end
+  end
+end