foreman_rh_cloud 3.0.19 → 3.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43110585639a77e33c9c4fb1fce44855b6fb4c9793db3fc624a01b567c09e400
-  data.tar.gz: '00285b699105835e629127cc96801082ece7ff41c9a93d82fcb7e7a6b2662c65'
+  metadata.gz: 408212bb105f87e7d683c1c288f2b7d4b0c0c307a1b7e71c98433a15b8540ea5
+  data.tar.gz: 3fde56133d829bc2d77e2ce82dd09bf9a2f68482c761ae8527db93d62f47baba
 SHA512:
-  metadata.gz: aa89cca9fb72a26453a44cba2120c51ab3f47f67ec40ca8e539a1dfaeddae73687bd909e3f3880cd3eed94c7c5d4b509bb55e2450f5bf4e55a8db2f73ceaabe9
-  data.tar.gz: 33d4200395db6f2f9a0e2dbd8b27d8c55ff66d7da87efa9c9c39663468f0dd9c43c8949b0ce09b2158875d053375e39d03e4550b821732df4d49fb52f5872cb3
+  metadata.gz: 00c0437d4448aac1a2126fc7d4229983891520d82fe326edf1cb0b11b3498ddf995ebe3a7d35a9a6801e91d5577f5d7089e30026c458048c65bdc2d47749e538
+  data.tar.gz: f113f8f3e98a12fdc123890708795a7c89533f3af16808d2f6175948502be1991f4e652a635ec01638c4300890cb1f06ff89b5a1b63775421d85b918ebc23bca

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/api/v2/rh_cloud/inventory_controller.rb

@@ -0,0 +1,50 @@
+module Api
+  module V2
+    module RhCloud
+      class InventoryController < ::Api::V2::BaseController
+        include ::Api::Version2
+        include InventoryUpload::ReportActions
+        include InventoryUpload::TaskActions
+
+        api :GET, "/organizations/:organization_id/rh_cloud/report", N_("Download latest report")
+        def download_file
+          filename, file = report_file(params[:organization_id])
+
+          send_file file, disposition: 'attachment', filename: filename
+        rescue InventoryUpload::ReportActions::ReportMissingError => error
+          render json: { message: error.message }, status: :not_found
+        end
+
+        api :POST, "/organizations/:organization_id/rh_cloud/report", N_("Start report generation")
+        def generate_report
+          organization_id = params[:organization_id]
+
+          start_report_generation(organization_id)
+
+          render json: {
+            action_status: 'success',
+          }, status: :ok
+        end
+
+        api :POST, "/organizations/:organization_id/rh_cloud/inventory_sync", N_("Start inventory synchronization")
+        def sync_inventory_status
+          selected_org = Organization.find(params[:organization_id])
+
+          task = start_inventory_sync(selected_org)
+
+          render json: {
+            task: task,
+          }, status: :ok
+        rescue InventoryUpload::TaskActions::NothingToSyncError => error
+          render json: { message: error.message }, status: :bad_request
+        end
+
+        api :POST, "rh_cloud/enable_connector", N_("Enable cloud connector")
+        def enable_cloud_connector
+          cloud_connector = ForemanRhCloud::CloudConnector.new
+          render json: cloud_connector.install.to_json
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/inventory_upload/report_actions.rb

@@ -0,0 +1,26 @@
+module InventoryUpload
+  module ReportActions
+    extend ActiveSupport::Concern
+
+    class ReportMissingError < Foreman::Exception
+      MESSAGE = N_("The report file %{filename} doesn't exist")
+
+      def initialize(**params)
+        super(self.class::MESSAGE % params, params)
+      end
+    end
+
+    def start_report_generation(organization_id)
+      ForemanInventoryUpload::Async::GenerateReportJob.perform_later(ForemanInventoryUpload.generated_reports_folder, organization_id)
+    end
+
+    def report_file(organization_id)
+      filename = ForemanInventoryUpload.facts_archive_name(organization_id)
+      files = Dir["{#{ForemanInventoryUpload.uploads_file_path(filename)},#{ForemanInventoryUpload.done_file_path(filename)}}"]
+
+      raise ReportMissingError.new(filename: filename) if files.empty?
+
+      [filename, files.first]
+    end
+  end
+end

data/app/controllers/concerns/inventory_upload/task_actions.rb

@@ -0,0 +1,25 @@
+module InventoryUpload
+  module TaskActions
+    extend ActiveSupport::Concern
+
+    class NothingToSyncError < Foreman::Exception
+      MESSAGE = N_('Nothing to sync, there are no hosts with subscription for this organization.')
+
+      def initialize(**params)
+        super(self.class::MESSAGE, params)
+      end
+    end
+
+    def start_inventory_sync(selected_org)
+      subscribed_hosts = ForemanInventoryUpload::Generators::Queries.for_slice(
+        Host.unscoped.where(organization: selected_org)
+      )
+
+      if subscribed_hosts.empty?
+        raise NothingToSyncError
+      end
+
+      ForemanTasks.async_task(InventorySync::Async::InventoryFullSync, selected_org)
+    end
+  end
+end

data/app/controllers/foreman_inventory_upload/reports_controller.rb

@@ -2,6 +2,8 @@
 
 module ForemanInventoryUpload
   class ReportsController < ::ApplicationController
+    include InventoryUpload::ReportActions
+
     def last
       label = ForemanInventoryUpload::Async::GenerateReportJob.output_label(params[:organization_id])
       output = ForemanInventoryUpload::Async::ProgressOutput.get(label)&.full_output
@@ -20,7 +22,7 @@ module ForemanInventoryUpload
     def generate
       organization_id = params[:organization_id]
 
-      ForemanInventoryUpload::Async::GenerateReportJob.perform_later(ForemanInventoryUpload.generated_reports_folder, organization_id)
+      start_report_generation(organization_id)
 
       render json: {
         action_status: 'success',

data/app/controllers/foreman_inventory_upload/tasks_controller.rb

@@ -1,25 +1,17 @@
 module ForemanInventoryUpload
   class TasksController < ::ApplicationController
+    include InventoryUpload::TaskActions
+
     def create
       selected_org = Organization.current
-      subscribed_hosts_ids = Set.new(
-        ForemanInventoryUpload::Generators::Queries.for_slice(
-          Host.unscoped.where(organization: selected_org)
-        ).pluck(:id)
-      )
 
-      if subscribed_hosts_ids.empty?
-        return render json: {
-          message: N_('Nothing to sync, there are no hosts with subscription for this organization.'),
-        }, status: :method_not_allowed
-      else
-        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
+      task = start_inventory_sync(selected_org)
 
       render json: {
         task: task,
       }, status: :ok
+    rescue InventoryUpload::TaskActions::NothingToSyncError => error
+      render json: { message: error.message }, status: :internal_server_error
     end
 
     def show

data/app/controllers/foreman_inventory_upload/uploads_controller.rb

@@ -1,5 +1,7 @@
 module ForemanInventoryUpload
   class UploadsController < ::ApplicationController
+    include InventoryUpload::ReportActions
+
     def last
       label = ForemanInventoryUpload::Async::UploadReportJob.output_label(params[:organization_id])
       output = ForemanInventoryUpload::Async::ProgressOutput.get(label)&.full_output
@@ -10,11 +12,9 @@ module ForemanInventoryUpload
     end
 
     def download_file
-      filename = ForemanInventoryUpload.facts_archive_name(params[:organization_id])
-      files = Dir["{#{ForemanInventoryUpload.uploads_file_path(filename)},#{ForemanInventoryUpload.done_file_path(filename)}}"]
+      filename, file = report_file(params[:organization_id])
 
-      return send_file files.first, disposition: 'attachment', filename: filename unless files.empty?
-      raise ::Foreman::Exception.new("The report file doesn't exist")
+      send_file file, disposition: 'attachment', filename: filename
     end
 
     def enable_cloud_connector

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

@@ -5,32 +5,34 @@ module InsightsCloud::Api
     include ::InsightsCloud::ClientAuthentication
     include ::InsightsCloud::CandlepinCache
 
+    before_action :set_admin_user, only: [:forward_request]
     before_action :cert_uuid, :ensure_org, :ensure_branch_id, :only => [:forward_request, :branch_info]
     before_action :ensure_telemetry_enabled_for_consumer, :only => [:forward_request]
 
     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 +71,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

@@ -3,12 +3,13 @@ module InsightsCloud
     include Foreman::Controller::AutoCompleteSearch
 
     def index
-      hits = resource_base_search_and_page.where(host: Host.authorized).preload(:host, :rule)
+      hits = resource_base_search_and_page.preload(:host, :rule)
 
       render json: {
         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 = resource_base.with_playbook.search_for(params[:query])
+      else
+        hits = resource_base_search_and_page.with_playbook.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,35 @@ 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
+
+    def resource_base
+      super.where(host: Host.authorized)
+    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/helpers/foreman_insights_host_helper.rb

@@ -0,0 +1,19 @@
+module ForemanInsightsHostHelper
+  def insights_host_overview_buttons(host)
+    search_condition = "hostname=#{host.fqdn}"
+    [
+      {
+        button: link_to_if_authorized(
+          _("Recommendations"),
+          hash_for_foreman_rh_cloud_insights_cloud_path(
+            search: search_condition,
+            select_all: true
+          ),
+          title: _("Host Insights recommendations"),
+          class: 'btn btn-default'
+        ),
+        priority: 1000,
+      },
+    ]
+  end
+end

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