foreman_discovery 13.0.1 → 14.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ffdab95d6a69414a0b99ecdb838f4c9d4c2ee9f9eba3d71ba2a5bb3fe3ef3d0
-  data.tar.gz: 5e721d701c1d35f93dcec4f096b41cfcb08ea605bd46aa37a538349c61c2985d
+  metadata.gz: 49c30c64f46b94cdebd54bcc42191a28d4657b5cac08b9b85b55e033193f3e30
+  data.tar.gz: 578f6f1feecbea23a712a13e5e4ece7df31a1e1fa3ec89dc0224df9472e4999b
 SHA512:
-  metadata.gz: bac34ddb73174715645508c038e8d1951840374b8b32b0c8073f424522c0ff322645cc5dde847914cc2861f9363f8ad64aa943c9a48f04b947c37c633c48afb3
-  data.tar.gz: 37e531b52508c10f32617eae2af3beb893c9eee65698dbad324af1bb77212ca4659ab1a71b35f77b57ddaca3825f10fde2f452b6bf1e87fd6b0628616d4e00fb
+  metadata.gz: 77d0a31672abf4bb351b0296c2fe2ac418b746fddefb7f3a9e8a2f58c7dd5d90ecaddf23cf35e2884ec49e187894abae9028e35b819ca83f31925adeb4ab18eb
+  data.tar.gz: a5703c3c800bad9be03d9110dbc4ab831c849e8ba31fa2ae4667b70e4013a5e923b1c170be7b8a0fa5d55499cec8265bcd7d71740e4cae4bb375226631c49127

data/app/controllers/concerns/foreman/controller/discovered_extensions.rb

@@ -51,7 +51,9 @@ module Foreman::Controller::DiscoveredExtensions
     host.discovery_rule = rule
     # render hostname only when all other fields are set
     original_name = host.name
-    host.name = host.render_template(rule.hostname) unless rule.hostname.empty?
+    source = Foreman::Renderer::Source::String.new(name: 'Hostname template', content: rule.hostname)
+    scope = Foreman::Renderer.get_scope(host: host, source: source)
+    host.name = Foreman::Renderer.render(source, scope)
     # fallback to the original if template did not expand
     host.name = original_name if host.name.empty?
     # explicitly set all inheritable attributes from hostgroup

data/app/models/host/discovered.rb

@@ -5,7 +5,6 @@ class Host::Discovered < ::Host::Base
   has_many :audits, -> { where(:auditable_type => 'Host::Base') }, :foreign_key => :auditable_id, :class_name => 'Audited::Audit'
 
   include ScopedSearchExtensions
-  include Foreman::Renderer
   include BelongsToProxies
   include ::Hostext::OperatingSystem
 
@@ -107,7 +106,7 @@ class Host::Discovered < ::Host::Base
     # record the last time it sent facts...
     self.last_report = Time.now
     # Set the correct facts type for new foreman facts importing code.
-    facts[:_type] = :foreman_discovery if SETTINGS[:version].short > '1.16'
+    facts[:_type] = :foreman_discovery
     super(facts)
   end
 
@@ -121,93 +120,24 @@ class Host::Discovered < ::Host::Base
     super
   end
 
-  def populate_fields_from_facts(*params)
-    if SETTINGS[:version].short > '1.16'
-      parser, type, source_proxy = params
-      facts = parser.facts
-      # detect interfaces and primary interface using extensions
-      super(parser, type, source_proxy)
-    else
-      # backwards compatibility
-      facts = params[0] || self.facts_hash
-      parser = super(facts, :foreman_discovery)
-    end
+  def populate_fields_from_facts(parser, type, source_proxy)
+    facts = parser.facts
+
+    # detect interfaces and primary interface using extensions
+    super(parser, type, source_proxy)
 
     populate_discovery_fields_from_facts(facts)
     create_notification
     parser
   end
 
+  # set additional discovery attributes
   def populate_discovery_fields_from_facts(facts)
-    # set discovery search attributes first
-    self.discovery_attribute_set = DiscoveryAttributeSet.where(:host_id => id).first_or_create
-    self.discovery_attribute_set.update_attributes(import_from_facts)
-    # set additional discovery attributes
-    ::ForemanDiscovery::LldpNeighbors.eventually_make_bond(self) if Setting[:discovery_auto_bond]
-    primary_ip = self.primary_interface.ip
-    unless primary_ip.nil?
-      subnet = Subnet.subnet_for(primary_ip)
-      if subnet
-        Rails.logger.info "Detected subnet: #{subnet} with taxonomy #{subnet.organizations.collect(&:name)}/#{subnet.locations.collect(&:name)}"
-      else
-        Rails.logger.warn "Subnet could not be detected for #{primary_ip}"
-      end
-      # set subnet
-      self.primary_interface.subnet = subnet
-      # set location and organization
-      if SETTINGS[:locations_enabled]
-        self.location = Location.find_by_title(facts["foreman_location"] || facts["discovery_location"]) ||
-          Location.find_by_title(Setting[:discovery_location]) ||
-          subnet.try(:locations).try(:first) ||
-          Location.first
-        Rails.logger.info "Assigned location: #{self.location}"
-      end
-      if SETTINGS[:organizations_enabled]
-        self.organization = Organization.find_by_title(facts["foreman_organization"] || facts["discovery_organization"]) ||
-          Organization.find_by_title(Setting[:discovery_organization]) ||
-          subnet.try(:organizations).try(:first) ||
-          Organization.first
-        Rails.logger.info "Assigned organization: #{self.organization}"
-      end
-    else
-      Rails.logger.warn "Unable to assign subnet - reboot trigger may not be possible, primary interface is missing IP address"
-    end
-
-    # lock the host into discovery via PXE, if feature is enabled in settings
-    lock_templates if Setting::Discovered.discovery_lock? && self.subnet.tftp?
+    ForemanDiscovery::ImportHookService.new(host: self, facts: facts).after_populate
   ensure
     self.save!
   end
 
-  def lock_templates
-    @host = self
-    TemplateKind::PXE.each do |kind|
-      template_name = Setting["discovery_#{kind.downcase}_lock_template"]
-      Rails.logger.info "Locking discovered host #{self.mac} in subnet #{subnet} via #{template_name} template"
-      template = unattended_render(::ProvisioningTemplate.find_by_name(template_name).template)
-      subnet.tftp_proxy.set(kind, mac, :pxeconfig => template)
-    end
-  rescue ::Foreman::Exception => e
-    ::Foreman::Logging.exception("Could not set tftp_proxy from proxy", e)
-  end
-
-  def import_from_facts(facts = self.facts_hash)
-    cpu_count  = facts['physicalprocessorcount'].to_i rescue 0
-    memory     = facts['memorysize_mb'].to_f.ceil rescue 0
-    disks      = facts.select { |key, value| key.to_s =~ /blockdevice.*_size/ }
-    disks_size = 0
-    disk_count = 0
-
-    if disks.any?
-      disks.values.each { |size| disks_size += (size.to_f rescue 0) }
-      disk_count = disks.size
-      # Turning disks_size to closest Mega for easier to read UI
-      disks_size = (disks_size / 1024 / 1024).ceil if disks_size > 0
-    end
-
-    {:cpu_count => cpu_count, :memory => memory, :disk_count => disk_count, :disks_size => disks_size}
-  end
-
   def proxied?
     subnet.present? && subnet.discovery.present?
   end

data/app/models/host/managed_extensions.rb

@@ -17,7 +17,7 @@ module Host::ManagedExtensions
       return
     end
     return if new_record? # Discovered Hosts already exist, and new_records will break `find`
-    return unless type_changed? and ::Host::Base.find(self.id).type == "Host::Discovered"
+    return unless will_save_change_to_attribute?(:type, from: 'Host::Discovered')
     # reboot task must be high priority and there is no compensation action apparently
     if facts['discovery_kexec'] && provisioning_template(:kind => 'kexec')
       post_queue.create(:name => _("Reloading kernel on %s") % self, :priority => 10000, :action => [self, :setKexec])
@@ -63,12 +63,12 @@ module Host::ManagedExtensions
 
   def delete_discovery_attribute_set
     return if new_record?
-    DiscoveryAttributeSet.where(:host_id => self.id).destroy_all if type_changed?
+    DiscoveryAttributeSet.where(:host_id => self.id).destroy_all if saved_change_to_attribute?(:type)
   end
 
   def update_notifications
     return if new_record?
-    return unless type_changed?
+    return unless saved_change_to_attribute?(:type)
     ForemanDiscovery::UINotifications::DestroyHost.deliver!(self)
   end
 end

data/app/models/nic/managed_extensions.rb

@@ -8,7 +8,7 @@ module Nic::ManagedExtensions
   def discovery_queue_rebuild_dns
     return unless (dns? || dns6? || reverse_dns? || reverse_dns6?) && errors.empty? && Setting[:discovery_always_rebuild_dns]
     return if self.host.new_record? || old.nil? # Discovered Hosts already exist, and new_records will break `find`
-    return unless self.host.type_changed? and ::Host::Base.find(self.host.id).type == "Host::Discovered"
+    return unless self.host.will_save_change_to_attribute?(:type, from: 'Host::Discovered')
     return if self.pending_dns_record_changes?
     logger.debug "Queuing DNS rebuild for #{self}"
     queue.create(:name => _("Rebuild DNS for %s") % self, :priority => 10, :action => [self, :set_discovery_rebuild_dns])

data/app/services/foreman_discovery/import_hook.rb

@@ -0,0 +1,12 @@
+module ForemanDiscovery
+  class ImportHook
+    attr_reader :host, :facts
+
+    def initialize(host:, facts:)
+      @host = host
+      @facts = facts
+    end
+
+    delegate :logger, to: Rails
+  end
+end

data/app/services/foreman_discovery/import_hook_service.rb

@@ -0,0 +1,24 @@
+module ForemanDiscovery
+  class ImportHookService
+    HOOKS = [
+      ForemanDiscovery::ImportHooks::DiscoveryAttribute,
+      ForemanDiscovery::ImportHooks::LldpNeighbor,
+      ForemanDiscovery::ImportHooks::SubnetAndTaxonomy,
+      ForemanDiscovery::ImportHooks::LockTemplates
+    ]
+
+    attr_reader :host, :facts
+
+    def initialize(host:, facts:)
+      @host = host
+      @facts = facts
+    end
+
+    def after_populate
+      HOOKS.each do |hook_class|
+        hook = hook_class.new(host: host, facts: facts)
+        hook.after_populate
+      end
+    end
+  end
+end

data/app/services/foreman_discovery/import_hooks/discovery_attribute.rb

@@ -0,0 +1,33 @@
+# set discovery search attributes first
+module ForemanDiscovery
+  module ImportHooks
+    class DiscoveryAttribute < ImportHook
+      def after_populate
+        host.discovery_attribute_set = DiscoveryAttributeSet.where(host_id: host.id).first_or_create
+        host.discovery_attribute_set.update(import_from_facts)
+      end
+
+      def import_from_facts
+        cpu_count  = facts['physicalprocessorcount'].to_i rescue 0
+        memory     = facts['memorysize_mb'].to_f.ceil rescue 0
+        disks      = facts.select { |key, value| key.to_s =~ /blockdevice.*_size/ }
+        disks_size = 0
+        disk_count = 0
+
+        if disks.any?
+          disks.values.each { |size| disks_size += (size.to_f rescue 0) }
+          disk_count = disks.size
+          # Turning disks_size to closest Mega for easier to read UI
+          disks_size = (disks_size / 1024 / 1024).ceil if disks_size > 0
+        end
+
+        {
+          cpu_count: cpu_count,
+          memory: memory,
+          disk_count: disk_count,
+          disks_size: disks_size
+        }
+      end
+    end
+  end
+end

data/app/services/foreman_discovery/import_hooks/lldp_neighbor.rb

@@ -0,0 +1,11 @@
+# Automatically bonds interfaces based on lldp facts
+module ForemanDiscovery
+  module ImportHooks
+    class LldpNeighbor < ImportHook
+      def after_populate
+        return unless Setting[:discovery_auto_bond]
+        ::ForemanDiscovery::LldpNeighbors.eventually_make_bond(host)
+      end
+    end
+  end
+end

data/app/services/foreman_discovery/import_hooks/lock_templates.rb

@@ -0,0 +1,27 @@
+# lock the host into discovery via PXE if feature is enabled in settings
+module ForemanDiscovery
+  module ImportHooks
+    class LockTemplates < ImportHook
+      def after_populate
+        lock_templates if Setting::Discovered.discovery_lock? && host.subnet.tftp?
+      end
+
+      def lock_templates
+        TemplateKind::PXE.each do |kind|
+          setting = "discovery_#{kind.downcase}_lock_template"
+          template_name = Setting[setting]
+          logger.info "Locking discovered host #{host.mac} in subnet #{host.subnet} via #{template_name} template"
+          template = ::ProvisioningTemplate.unscoped.find_by_name(template_name)
+          if template.nil?
+            logger.warn "Template '#{template_name}' provided by setting '#{setting}' does not exist, not locking"
+            next
+          end
+          rendered_template = host.render_template(template: template, params: { host: host })
+          host.subnet.tftp_proxy.set(kind, host.mac, pxeconfig: rendered_template)
+        end
+      rescue ::Foreman::Exception => e
+        ::Foreman::Logging.exception('Could not set tftp_proxy from proxy', e)
+      end
+    end
+  end
+end

data/app/services/foreman_discovery/import_hooks/subnet_and_taxonomy.rb

@@ -0,0 +1,63 @@
+# Sets subnet, location and organization of a host based on the discovery facts
+module ForemanDiscovery
+  module ImportHooks
+    class SubnetAndTaxonomy < ImportHook
+      def after_populate
+        primary_ip = host.primary_interface.ip
+
+        unless primary_ip
+          logger.warn "Unable to assign subnet - reboot trigger may not be possible, primary interface is missing IP address"
+          return
+        end
+
+        # set subnet
+        set_subnet(primary_ip)
+        # set location and organization
+        set_location
+        set_organization
+      end
+
+      private
+
+      def set_subnet(ip)
+        host.primary_interface.subnet = suggested_subnet(ip)
+      end
+
+      def suggested_subnet(ip)
+        subnet = Subnet.subnet_for(ip)
+        if subnet
+          logger.info "Detected subnet: #{subnet} with taxonomy #{subnet.organizations.collect(&:name)}/#{subnet.locations.collect(&:name)}"
+        else
+          logger.warn "Subnet could not be detected for #{ip}"
+        end
+        subnet
+      end
+
+      def set_location
+        return unless SETTINGS[:locations_enabled]
+        host.location = suggested_location
+        logger.info "Assigned location: #{host.location}"
+      end
+
+      def suggested_location
+        Location.find_by_title(facts["foreman_location"] || facts["discovery_location"]) ||
+          Location.find_by_title(Setting[:discovery_location]) ||
+          host.subnet.try(:locations).try(:first) ||
+          Location.first
+      end
+
+      def set_organization
+        return unless SETTINGS[:organizations_enabled]
+        host.organization = suggested_organization
+        logger.info "Assigned organization: #{host.organization}"
+      end
+
+      def suggested_organization
+        Organization.find_by_title(facts["foreman_organization"] || facts["discovery_organization"]) ||
+          Organization.find_by_title(Setting[:discovery_organization]) ||
+          host.subnet.try(:organizations).try(:first) ||
+          Organization.first
+      end
+    end
+  end
+end

data/app/views/discovered_hosts/_discovered_hosts_list.html.erb

@@ -21,7 +21,7 @@
     <% end -%>
     <th class="hidden-tablet hidden-xs"><%= sort :subnet, :as => _("Subnet") %></th>
     <th class="hidden-tablet hidden-xs"><%= sort :last_report, :as => _("Last Facts Upload") %></th>
-    <th></th>
+    <th class="hidden-tablet hidden-xs"><%= _("Actions") %></th>
   </tr>
   <% @hosts.each do |host| -%>
     <tr>

data/app/views/foreman_discovery/debian_kexec.erb

@@ -24,16 +24,17 @@ Please read kexec(8) man page for more information about semantics.
   mask = @host.facts['discovery_netmask']
   gw = @host.facts['discovery_gateway']
   dns = @host.facts['discovery_dns']
-  append = @host.facts['append']
-  options = ["auto=true"]
+  options = ["nomodeset", "auto=true"]
+  options << @host.facts['append']
   options << "domain=#{@host.domain}"
   options << 'console-setup/ask_detect=false console-setup/layout=USA console-setup/variant=USA keyboard-configuration/layoutcode=us localechooser/translation/warn-light=true localechooser/translation/warn-severe=true'
   options << "locale=#{@host.params['lang'] || 'en_US'}"
+  options << "inst.stage2=#{@host.operatingsystem.medium_uri(@host)}" if @host.operatingsystem.name.match(/Atomic/i)
 -%>
 {
   "comment": "WARNING: Both kernel and initram are not set in preview mode due to http://projects.theforeman.org/issues/19737",
   "kernel": "<%= @kexec_kernel %>",
   "initram": "<%= @kexec_initrd %>",
-  "append": "url=<%= foreman_url('provision') + "&static=yes" %> interface=<%= mac %> netcfg/get_ipaddress=<%= ip %> netcfg/get_netmask=<%= mask %> netcfg/get_gateway=<%= gw %> netcfg/get_nameservers=<%= dns %> netcfg/disable_dhcp=true netcfg/get_hostname=<%= @host.name %> BOOTIF=<%= bootif %> <%= options.join(' ') %>",
+  "append": "url=<%= foreman_url('provision') + "&static=yes" %> interface=<%= mac %> netcfg/get_ipaddress=<%= ip %> netcfg/get_netmask=<%= mask %> netcfg/get_gateway=<%= gw %> netcfg/get_nameservers=<%= dns %> netcfg/disable_dhcp=true netcfg/get_hostname=<%= @host.name %> BOOTIF=<%= bootif %> <%= options.compact.join(' ') %>",
   "extra": []
 }

data/app/views/foreman_discovery/redhat_kexec.erb

@@ -34,7 +34,9 @@ Please read kexec(8) man page for more information about semantics.
   mask = @host.facts['discovery_netmask']
   gw = @host.facts['discovery_gateway']
   dns = @host.facts['discovery_dns']
-  append = @host.facts['append']
+  options = ["nomodeset"]
+  options << @host.facts['append']
+  options << "inst.stage2=#{@host.operatingsystem.medium_uri(@host)}" if @host.operatingsystem.name.match(/Atomic/i)
 -%>
 {
   "comment": "WARNING: Both kernel and initram are not set in preview mode due to http://projects.theforeman.org/issues/19737",
@@ -44,7 +46,7 @@ Please read kexec(8) man page for more information about semantics.
     (@host.operatingsystem.name != 'Fedora' and @host.operatingsystem.major.to_i >= 7) -%>
   "append": "ks=<%= foreman_url('provision') + "&static=yes" %> inst.ks.sendmac <%= "ip=#{ip}::#{gw}:#{mask}:::none nameserver=#{dns} ksdevice=bootif BOOTIF=#{bootif} nomodeset #{append}" %>",
 <% else -%>
-  "append": "ks=<%= foreman_url('provision') + "&static=yes" %> kssendmac nicdelay=5 <%= "ip=#{ip} netmask=#{mask} gateway=#{gw} dns=#{dns} ksdevice=#{mac} BOOTIF=#{bootif} nomodeset #{append}" %>",
+  "append": "ks=<%= foreman_url('provision') + "&static=yes" %> kssendmac nicdelay=5 <%= "ip=#{ip} netmask=#{mask} gateway=#{gw} dns=#{dns} ksdevice=#{mac} BOOTIF=#{bootif} " + options.compact.join(' ') %>",
 <% end -%>
   "extra": []
 }

data/db/migrate/20141223142759_fill_discovery_attribute_sets_for_existing_hosts.rb

@@ -7,8 +7,7 @@ class FillDiscoveryAttributeSetsForExistingHosts < ActiveRecord::Migration[4.2]
     FakeDiscoveredHost.where(:type => "Host::Discovered").all.each do |host|
       begin
         say "Populating attribute set for discovered host #{host.name}"
-        host.discovery_attribute_set = DiscoveryAttributeSet.where(:host_id => host.id).first_or_create
-        host.discovery_attribute_set.update_attributes(host.import_from_facts)
+        ForemanDiscovery::ImportHooks::DiscoveryAttribute.new(host: host, facts: host.facts_hash).after_populate
         host.save!
       rescue Exception => e
         say "Error while populating host #{host.name}, deleting: #{e.message}:\n" + e.backtrace.join("\n")

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

@@ -1,4 +1,9 @@
-kind = TemplateKind.unscoped.where(:name => 'kexec').first_or_create
+organizations = Organization.unscoped.all
+locations = Location.unscoped.all
+
+kind = TemplateKind.unscoped.find_or_create_by(name: 'kexec')
+kind.description = N_("Command line options for kexec during PXE-less provisioning.")
+kind.save!
 
 ProvisioningTemplate.without_auditing do
   [['redhat_kexec.erb', 'Red Hat'], ['debian_kexec.erb', 'Debian']].each do |tmpl_names|
@@ -12,8 +17,10 @@ ProvisioningTemplate.without_auditing do
       :template => content,
       :default  => true,
       :vendor   => "Foreman Discovery",
-      :locked   => false
+      :locked   => true
     }
+    tmpl.organizations = organizations if SETTINGS[:organizations_enabled]
+    tmpl.locations = locations if SETTINGS[:locations_enabled]
     tmpl.save!(:validate => false) if tmpl.changes.present?
   end
 end

data/extra/discover-host

@@ -5,7 +5,7 @@ require 'rest-client'
 
 def find_base name="default"
   return name if File.exists?(name)
-  file = File.absolute_path(File.dirname(__FILE__) + "/discovery/#{name}.json")
+  file = File.absolute_path(File.dirname(__FILE__) + "../../test/facts/#{name}.json")
   raise "Unable to find file #{file}" unless File.exists?(file)
   file
 end