foreman_rh_cloud 3.0.18 → 3.0.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50f4cac8e85d4aa6a6f5311e0276277ee3de729dfe29954d2fb8e907c2996e65
-  data.tar.gz: 96a40dac10cabdcf362add97a29d841a88a16d96a9cfb2a59c10eab0a64b8b5d
+  metadata.gz: d87599d8ef67eeeaa3e17e720dc990b58d4085caf7fb6491dab093c54770c8fd
+  data.tar.gz: 04b52a7412dddf8e6829d61555ec9315c7f3856fde32e976eb8c50638082a3bc
 SHA512:
-  metadata.gz: 9dee0e2da14903584e433cf39e5f21c0e6e913ee54a6c579d929dee1db8163d60990502d7404285d7df8fed49f2b2910e923d47adc529dbda0c5f9aada23174b
-  data.tar.gz: 9c468f95609d7d844ae0b0c1b8bbe697c4b43e55529a6dfc5030b74089b05c2d0fae0843e415cb98bec95dacd45c056d25b2130c8df141238059552303a62573
+  metadata.gz: 4ca381e6bcbf74d21a23ae825ebb6556be1afbe98c193fb33e58ef7fee6027142a809ed79b8cbcb3c8dce95200b0bd4528d497597a1f0411f703172ce1f9c123
+  data.tar.gz: 945faf0852d9ebce259e4da1bcebd079ef5a4fad87f503fc9ee694f4eae7e3ab36a7dc2390d54879a7da57d176aa22d8030a168d2715fe1f54a521b2258fbb37

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/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_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_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_forwarder.rb

@@ -27,6 +27,7 @@ module ForemanRhCloud
         headers: {
           params: forward_params,
           user_agent: http_user_agent(original_request),
+          content_type: original_request.media_type,
         },
       }
       base_params.merge(path_params(original_request.path, certs))

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

@@ -10,7 +10,7 @@ Rails.application.routes.draw do
 
     post 'cloud_connector', to: 'uploads#enable_cloud_connector'
 
-    resources :tasks, only: [:create]
+    resources :tasks, only: [:create, :show]
   end
 
   namespace :insights_cloud do
@@ -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/179_ui_notifications.rb

@@ -0,0 +1,11 @@
+blueprints = [
+  {
+    group: N_('Red Hat Insights'),
+    name: 'insights_satellite_hits',
+    message: N_('Satellite server has %{hits_count} recommendations by Red Hat'),
+    level: 'warning',
+  },
+]
+
+blueprints.each { |blueprint| UINotifications::Seed.new(blueprint).configure }
+

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_inventory_upload.rb

@@ -56,6 +56,15 @@ module ForemanInventoryUpload
     @upload_url ||= ENV['SATELLITE_INVENTORY_UPLOAD_URL'] || 'https://cert.cloud.redhat.com/api/ingress/v1/upload'
   end
 
+  def self.slice_size
+    @slice_size ||= (ENV['SATELLITE_INVENTORY_SLICE_SIZE'] || '1000').to_i
+  end
+
+  def self.max_org_size
+    # Set max amount of hosts per organization for automatic uploads
+    @max_org_size ||= (ENV['SATELLITE_INVENTORY_MAX_ORG_SIZE'] || 150_000).to_i
+  end
+
   def self.ensure_folder(folder)
     FileUtils.mkdir_p(folder)
     folder