foreman_rh_cloud 3.0.14 → 3.0.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b0882515e038d95959e1926b002f3caebb0b38ed0bd05951208d33cea7748ae
-  data.tar.gz: 29d8594297d6c4ed6936d568c7c7a8547186ab7390d03b81448cc5c563f5031d
+  metadata.gz: 72303b7bc3f1bc2deb3972acde6131cdbe4d1760381d1eb8cdaa5704e3189481
+  data.tar.gz: 725efab879cee6224007359547068820882319d078089760cac43a8c763df754
 SHA512:
-  metadata.gz: 71d58183a48ca30f148138bb036ba0cd7bea80dd1ce087b13605e884b763035b674207f91c359f193d658211f2e742f54b2f7e4fadac3f7bc723eb10dbd85f6e
-  data.tar.gz: ef3740403be8ab6cc6bb2848666833b424b41cabbc7fac78b06af573db3e59cfed40b01dad2deb88d3bfcba6b8ef86a5c7fe16f8dc48d6b68e821d8f5f2c3ddf
+  metadata.gz: 28d7e810476e8202a62aa7381e8d3ef86cec5f2f6a7bc9580d5a116a543275183201ad573e848f30a65253bee2f20e7b0385f0cc6f0ab90637cfb03398557188
+  data.tar.gz: 52560a0917aecaed1c9897c593769c19b7dde9348c1b0450cd32fb4998d5c63e4232d671a1b767e33e6dcec960b3f4647bc23d56a80f15c1f18930db8b772409

data/README.md

@@ -19,10 +19,23 @@ In UI: Configure -> Inventory Upload -> Restart
 
 From command-line:
 
+    # generate and upload report for all organizations
+    /usr/sbin/foreman-rake rh_cloud_inventory:report:generate_upload
+
+    # generate and upload report for specific organization
+    export organization_id=1
+    /usr/sbin/foreman-rake rh_cloud_inventory:report:generate_upload
+
+    # generate report for specific organization (don't upload)
     export organization_id=1
     export target=/var/lib/foreman/red_hat_inventory/generated_reports/
     /usr/sbin/foreman-rake rh_cloud_inventory:report:generate
 
+    # upload previously generated report (needs to be named 'report_for_#{organization_id}.tar.gz')
+    export organization_id=1
+    export target=/var/lib/foreman/red_hat_inventory/generated_reports/
+    /usr/sbin/foreman-rake rh_cloud_inventory:report:upload
+
 #### Fetch hosts remediation data
 
 In UI: Configure -> Insights -> Sync now

data/app/controllers/concerns/insights_cloud/candlepin_cache.rb

@@ -0,0 +1,28 @@
+module InsightsCloud
+  module CandlepinCache
+    extend ActiveSupport::Concern
+
+    def upstream_owner(org)
+      # We use a cache because owner_details is a call to Candlepin
+      Rails.cache.fetch("rh_cloud_upstream_owner_#{org.id}", expires_in: 1.minute) do
+        org.owner_details['upstreamConsumer']
+      end
+    end
+
+    def cp_owner_id(org)
+      owner = upstream_owner(org)
+      owner['uuid'] if owner
+    end
+
+    def candlepin_id_cert(org)
+      owner = upstream_owner(org)
+      return unless owner
+      id_cert = {
+        cert: owner.dig('idCert', 'cert'),
+        key: owner.dig('idCert', 'key'),
+      }
+      return unless id_cert.values.all?
+      id_cert
+    end
+  end
+end

data/app/controllers/concerns/insights_cloud/client_authentication.rb

@@ -0,0 +1,23 @@
+module InsightsCloud
+  module ClientAuthentication
+    extend ActiveSupport::Concern
+
+    include ::Katello::Authentication::ClientAuthentication
+
+    def authorize
+      client_authorized? || super
+    end
+
+    def client_authorized?
+      authenticate_client && valid_machine_user?
+    end
+
+    def valid_machine_user?
+      subscribed_host_by_uuid(User.current.uuid).present?
+    end
+
+    def subscribed_host_by_uuid(uuid)
+      @host = Host.unscoped.joins(:subscription_facet).where(:katello_subscription_facets => {:uuid => uuid }).first
+    end
+  end
+end

data/app/controllers/foreman_inventory_upload/accounts_controller.rb

@@ -10,23 +10,19 @@ 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],
-        excludePackages: Setting[:exclude_installed_packages],
         accounts: accounts,
+        CloudConnectorStatus: ForemanInventoryUpload::UploadsSettingsController.cloud_connector_status,
       }, status: :ok
     end
 

data/app/controllers/foreman_inventory_upload/uploads_controller.rb

@@ -14,62 +14,12 @@ module ForemanInventoryUpload
       files = Dir["{#{ForemanInventoryUpload.uploads_file_path(filename)},#{ForemanInventoryUpload.done_file_path(filename)}}"]
 
       return send_file files.first, disposition: 'attachment', filename: filename unless files.empty?
-      throw_flash_error "File doesn't exist"
+      raise ::Foreman::Exception.new("The report file doesn't exist")
     end
 
-    def throw_flash_error(message)
-      process_error(
-        :redirect => foreman_inventory_upload_index_path,
-        :error_msg => message
-      )
-    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],
-      }
+    def enable_cloud_connector
+      cloud_connector = ForemanRhCloud::CloudConnector.new
+      render json: cloud_connector.install.to_json
     end
   end
 end

data/app/controllers/foreman_inventory_upload/uploads_settings_controller.rb

@@ -0,0 +1,26 @@
+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?,
+      }, 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
+  end
+end

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

@@ -0,0 +1,73 @@
+module InsightsCloud::Api
+  class MachineTelemetriesController < ::Api::V2::BaseController
+    layout false
+
+    include ::InsightsCloud::ClientAuthentication
+    include ::InsightsCloud::CandlepinCache
+
+    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]
+
+    # 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)
+
+      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]
+      end
+
+      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
+    end
+
+    def branch_info
+      render :json => ForemanRhCloud::BranchInfo.new.generate(@uuid, @host, @branch_id, request.host).to_json
+    end
+
+    def assign_header(res, cloud_res, header, transform)
+      header_content = cloud_res.headers[header]
+      return unless header_content
+      new_header = transform ? header.to_s.tr('_', '-') : header.to_s
+      res.headers[new_header] = header_content
+    end
+
+    private
+
+    def ensure_telemetry_enabled_for_consumer
+      render_message 'Telemetry is not enabled for your organization', :status => 403 unless telemetry_config
+    end
+
+    def telemetry_config
+      ::RedhatAccess::TelemetryConfiguration.find_or_create_by(:organization_id => @organization.id) do |conf|
+        conf.enable_telemetry = true
+      end
+    end
+
+    def cert_uuid
+      @uuid ||= User.current.login
+    end
+
+    def ensure_org
+      @organization = @host.organization
+      return render_message 'Organization not found or invalid', :status => 400 unless @organization
+    end
+
+    def ensure_branch_id
+      @branch_id = cp_owner_id(@organization)
+      return render_message "Branch ID not found for organization #{@organization.title}", :status => 400 unless @branch_id
+    end
+  end
+end

data/app/controllers/insights_cloud/hits_controller.rb

@@ -1,6 +1,18 @@
 module InsightsCloud
   class HitsController < ::ApplicationController
+    include Foreman::Controller::AutoCompleteSearch
+
     def index
+      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,
+      }, status: :ok
+    end
+
+    def show
       host = Host.where(id: host_id_param).first
 
       render json: {
@@ -8,6 +20,18 @@ module InsightsCloud
       }, status: :ok
     end
 
+    def model_of_controller
+      ::InsightsHit
+    end
+
+    def resource_class
+      ::InsightsHit
+    end
+
+    def controller_permission
+      :insights_hits
+    end
+
     private
 
     def host_id_param

data/app/controllers/insights_cloud/settings_controller.rb

@@ -9,6 +9,14 @@ module InsightsCloud
       render_setting(:insightsSyncEnabled, :allow_auto_insights_sync)
     end
 
+    def save_token_and_sync
+      token = Setting::RhCloud.find_by_name("rh_cloud_token")
+      token.value = params.require(:value)
+      token.save!
+      InsightsCloud::Async::InsightsFullSync.perform_now
+      redirect_to(:controller => "hits", :action => 'index')
+    end
+
     private
 
     def render_setting(node_name, setting)

data/app/controllers/insights_cloud/tasks_controller.rb

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

data/app/models/insights_hit.rb

@@ -1,6 +1,25 @@
 class InsightsHit < ApplicationRecord
-  has_one :host
+  include ::Authorizable
+  belongs_to :host
   # since the facet is one-to-one association with a host, we can connect
   # through host_id column on both this model and facet.
   belongs_to :insights_facet, foreign_key: 'host_id', primary_key: 'host_id', counter_cache: :hits_count
+
+  has_one :rule, class_name: 'InsightsRule', foreign_key: 'rule_id', primary_key: 'rule_id'
+
+  scope :with_playbook, -> { joins(:rule) }
+
+  scoped_search on: :title, complete_value: true
+  scoped_search on: :total_risk, complete_value: true
+  scoped_search on: :rule_id, complete_value: true, only_explicit: true
+  scoped_search relation: :host, on: :name, rename: :hostname, complete_value: true
+  scoped_search on: :rule_id, rename: :with_playbook, only_explicit: true, complete_value: false, ext_method: :find_with_playbook
+
+  def self.find_with_playbook(key, operator, value)
+    { joins: :rule }
+  end
+
+  def has_playbook?
+    !rule.nil?
+  end
 end

data/app/models/insights_resolution.rb

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

data/app/models/insights_rule.rb

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

data/app/models/setting/rh_cloud.rb

@@ -1,14 +1,26 @@
 class Setting::RhCloud < Setting
+  ::Setting::BLANK_ATTRS.concat %w{rh_cloud_token}
+
+  def self.load_defaults
+    return false unless table_exists?
+    transaction do
+      # If the user had auto_upload default setting, we will not surprise him, and force the value to false
+      # for new users, the default will be set to true and the value will remain nil
+      Setting.where(name: 'allow_auto_inventory_upload', value: nil).where("settings.default LIKE '%false%'").update_all(value: "--- false\n...")
+      super
+    end
+  end
+
   def self.default_settings
     return unless ActiveRecord::Base.connection.table_exists?('settings')
-    return unless super
     [
-      set('allow_auto_inventory_upload', N_('Allow automatic upload of the host inventory to the Red Hat cloud'), false),
-      set('allow_auto_insights_sync', N_('Allow recommendations synchronization from Red Hat cloud'), false),
-      set('obfuscate_inventory_hostnames', N_('Obfuscate host names sent to Red Hat cloud'), false),
-      set('obfuscate_inventory_ips', N_('Obfuscate ip addresses sent to Red Hat cloud'), false),
-      set('rh_cloud_token', N_('Authentication token to Red Hat cloud services. Used to authenticate requests to cloud APIs'), 'DEFAULT', N_('Red Hat Cloud token'), nil, encrypted: true),
-      set('exclude_installed_packages', N_('Exclude installed packages from Red Hat cloud inventory report'), false),
+      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('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('include_parameter_tags', N_('Should import include parameter tags from Foreman?'), false, N_('Include parameters in insights-client reports')),
     ]
   end
 

data/app/overrides/layouts/base/styles.html.erb.deface

@@ -0,0 +1,2 @@
+<!-- insert_top 'head' -->
+<%= css_tags_for([:foreman_rh_cloud]).first %>

data/app/services/foreman_rh_cloud/branch_info.rb

@@ -0,0 +1,46 @@
+module ForemanRhCloud
+  class BranchInfo
+    def generate(uuid, host, branch_id, request_hostname)
+      {
+        :remote_leaf => uuid,
+        :remote_branch => branch_id,
+        :display_name => host.organization.name,
+        :hostname => request_hostname,
+        :product => {
+          :type => core_app_name,
+          :major_version => core_app_version.major,
+          :minor_version => core_app_version.minor,
+        },
+        :organization_id => host.organization.id,
+        :satellite_instance_id => Foreman.instance_id,
+        :labels => host_labels(host),
+      }
+    end
+
+    def core_app_name
+      'Foreman'
+    end
+
+    def core_app_version
+      Foreman::Version.new
+    end
+
+    def new_label(key, value, namespace)
+      {
+        :namespace => namespace,
+        :key => key,
+        :value => value,
+      }
+    end
+
+    def labels_from_items(items, label_namespace, label_lamb, label_value_method = :to_s)
+      items.map { |item| new_label(label_lamb.call(item), item.public_send(label_value_method), label_namespace) }
+    end
+
+    def host_labels(host)
+      tags_generator = ForemanInventoryUpload::Generators::Tags.new(host)
+      tags_generator.generate.map { |key, value| new_label(key, value, ForemanInventoryUpload::Generators::Slice::SATELLITE_NAMESPACE) } +
+        tags_generator.generate_parameters.map { |key, value| new_label(key, value, ForemanInventoryUpload::Generators::Slice::SATELLITE_PARAMS_NAMESPACE) }
+    end
+  end
+end