foreman_rh_cloud 3.0.17 → 3.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de4c573e51011ac6fd99707859fa86d659454b7f30183494ab5e240e773bec0a
-  data.tar.gz: f0510f09adf430834e01b9732a9cf6faedff0b18471e7b90fbca8a47fe867a13
+  metadata.gz: f19ab6e45bf75f915a43c8db5e829f77fe6e5e7b62998d42fe4207ce37dcc062
+  data.tar.gz: c2bf184dcdfaefe41c1d13116ede5236c381c1f0bc8e71353d2875eee9cb289e
 SHA512:
-  metadata.gz: a5ef31993d25982136027082f9fb3d382133378627afd0f5da6eeb5eb24a971aa36cdb7f8995347b017ab438124219113e6b326a52f1821e0ccbdb0a6e402f52
-  data.tar.gz: e5da37635a059fadc6e6c62464aec98f75e803fddb1f8b1ca9b23ad27e42cffdb006bdd4ae5e59d10317d8599f6629ff8f4e08065a15947aff7f93133ec49e8a
+  metadata.gz: 7f2e16294caeae0098b8b8367082d75af4a706f74022dba22c040d9f545b4c99ca3c31be0d3db568c2a2dfc3de5509590a9602b026caad6ea0fb1b53a3ccc9f2
+  data.tar.gz: 9cc8d2349b5879d84bb9d2e95157c3eaafbff04823ea6704889b2678dc9a6a1f8fe300f09d28eef47c62cbbeccd94d96b0bbd7518969f8edbdbfb338a2fff1c7

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/accounts_controller.rb

@@ -10,36 +10,24 @@ module ForemanInventoryUpload
           upload_report_status = status_for(id, ForemanInventoryUpload::Async::UploadReportJob)
 
           [
-            id,
+            label,
             {
               generate_report_status: generate_report_status,
               upload_report_status: upload_report_status,
-              label: label,
+              id: id,
             },
           ]
         end
       ]
 
       render json: {
-        autoUploadEnabled: Setting[:allow_auto_inventory_upload],
-        hostObfuscationEnabled: Setting[:obfuscate_inventory_hostnames],
-        ipsObfuscationEnabled: Setting[:obfuscate_inventory_ips],
-        cloudToken: !Setting[:rh_cloud_token].empty?,
-        excludePackages: Setting[:exclude_installed_packages],
         accounts: accounts,
-        CloudConnectorStatus: cloud_connector_status,
+        CloudConnectorStatus: ForemanInventoryUpload::UploadsSettingsController.cloud_connector_status,
       }, status: :ok
     end
 
     private
 
-    def cloud_connector_status
-      cloud_connector = ForemanRhCloud::CloudConnector.new
-      job = cloud_connector&.latest_job
-      return nil unless job
-      { id: job.id, task: ForemanTasks::Task.where(:id => job.task_id).first }
-    end
-
     def status_for(label, job_class)
       label = job_class.output_label(label)
       ForemanInventoryUpload::Async::ProgressOutput.get(label)&.status

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

@@ -21,53 +21,5 @@ module ForemanInventoryUpload
       cloud_connector = ForemanRhCloud::CloudConnector.new
       render json: cloud_connector.install.to_json
     end
-
-    def auto_upload
-      Setting[:allow_auto_inventory_upload] = auto_upload_params
-      render_setting(:autoUploadEnabled, :allow_auto_inventory_upload)
-    end
-
-    def show_auto_upload
-      render_setting(:autoUploadEnabled, :allow_auto_inventory_upload)
-    end
-
-    def auto_upload_params
-      ActiveModel::Type::Boolean.new.cast(params.require(:value))
-    end
-
-    def host_obfuscation
-      Setting[:obfuscate_inventory_hostnames] = host_obfuscation_params
-      render_setting(:hostObfuscationEnabled, :obfuscate_inventory_hostnames)
-    end
-
-    def host_obfuscation_params
-      ActiveModel::Type::Boolean.new.cast(params.require(:value))
-    end
-
-    def installed_packages_inclusion
-      Setting[:exclude_installed_packages] = host_obfuscation_params
-      render_setting(:excludePackages, :exclude_installed_packages)
-    end
-
-    def installed_packages_inclusion_params
-      ActiveModel::Type::Boolean.new.cast(params.require(:value))
-    end
-
-    def ips_obfuscation
-      Setting[:obfuscate_inventory_ips] = ips_obfuscation_params
-      render_setting(:ipsObfuscationEnabled, :obfuscate_inventory_ips)
-    end
-
-    def ips_obfuscation_params
-      ActiveModel::Type::Boolean.new.cast(params.require(:value))
-    end
-
-    private
-
-    def render_setting(node_name, setting)
-      render json: {
-        node_name => Setting[setting],
-      }
-    end
   end
 end

data/app/controllers/foreman_inventory_upload/uploads_settings_controller.rb

@@ -0,0 +1,34 @@
+module ForemanInventoryUpload
+  class UploadsSettingsController < ::ApplicationController
+    def index
+      render json: {
+        autoUploadEnabled: Setting[:allow_auto_inventory_upload],
+        hostObfuscationEnabled: Setting[:obfuscate_inventory_hostnames],
+        ipsObfuscationEnabled: Setting[:obfuscate_inventory_ips],
+        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
+
+    def set_advanced_setting
+      Setting[params.require(:setting)] = ActiveModel::Type::Boolean.new.cast(params.require(:value))
+      index
+    end
+
+    def self.cloud_connector_status
+      cloud_connector = ForemanRhCloud::CloudConnector.new
+      job = cloud_connector&.latest_job
+      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

@@ -3,12 +3,13 @@ module InsightsCloud
     include Foreman::Controller::AutoCompleteSearch
 
     def index
-      hits = resource_base_search_and_page.preload(:host, :rule)
+      hits = resource_base_search_and_page.where(host: Host.authorized).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 = 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