foreman_discovery 16.0.0 → 16.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40c64a4f3c756e207293b6e5be67190294b9c4f2ab5054e08edd8d085718556f
-  data.tar.gz: b22ef9bf418ac18e94170429e7368cb1c6f94b9b0d2290b60341a9415e908b01
+  metadata.gz: 633d9a0f20147b982f23bbcc7fe02eb210bdbb060ac2f304b098620981502899
+  data.tar.gz: e80520e5eacd123161aa6da427e8185ff0d52dd44d8925319391563ba2634372
 SHA512:
-  metadata.gz: d9f9013fa2d04e883da3c0c8c42b5a6e3552093323698359b8e9b70179f0284ccf35d633eac5720cc03fa79678af915b5eda3c7508be775b0836128ef6d738d8
-  data.tar.gz: 688c8d68c1a87aff1fda0a00eef057daf0c35a06ce007746e568763e868c82ee718d15a51d1124cb9dc1a47498ec94bc7f33e62d986ba7ed23e3eb6babfd140f
+  metadata.gz: 36a6ab1d08a10291ba5fa6665649fbaa2b23779305b83826b86a62c1644d9f4545e069c1eba6d13cac27789c50faa2093058de9396d60a06d36f212d995f17c4
+  data.tar.gz: 8c2e52c9eee44e6bd3f22098059395e10b4250d193b331b787bb87ffc7f222911510e650645e6d9ff26bd46245680060e7f033fde62bc8bdf0c13d8f39e7aea0

data/app/controllers/api/v2/discovered_hosts_controller.rb

@@ -51,24 +51,30 @@ module Api
       param :id, :identifier, :required => true
       param :discovered_host, Hash, :action_aware => true do
         param :name, String
-        param :environment_id, String
+        param :environment_id, String, :desc => N_("required if host is managed and value is not inherited from host group")
         param :ip, String, :desc => N_("not required if using a subnet with DHCP proxy")
         param :mac, String, :desc => N_("not required if it's a virtual machine")
-        param :architecture_id, :number
-        param :domain_id, :number
+        param :architecture_id, :number, :desc => N_("required if host is managed and value is not inherited from host group")
+        param :domain_id, :number, :desc => N_("required if host is managed and value is not inherited from host group")
         param :puppet_proxy_id, :number
         param :puppet_class_ids, Array
-        param :operatingsystem_id, String
-        param :medium_id, :number
-        param :ptable_id, :number
-        param :subnet_id, :number
+        param :operatingsystem_id, :number, :desc => N_("required if host is managed and value is not inherited from host group")
+        param :medium_id, String, :desc => N_("required if not imaged based provisioning and host is managed and value is not inherited from host group")
+        param :ptable_id, :number, :desc => N_("required if host is managed and custom partition has not been defined")
+        param :subnet_id, :number, :desc => N_("required if host is managed and value is not inherited from host group")
         param :sp_subnet_id, :number
         param :model_id, :number
         param :hostgroup_id, :number
         param :owner_id, :number
+        param :owner_type, Host::Base::OWNER_TYPES, :desc => N_("Host's owner type")
         param :puppet_ca_proxy_id, :number
         param :image_id, :number
-        param :host_parameters_attributes, Array
+        param :host_parameters_attributes, Array, :desc => N_("Host's parameters (array or indexed hash)") do
+          param :name, String, :desc => N_("Name of the parameter"), :required => true
+          param :value, String, :desc => N_("Parameter value"), :required => true
+          param :parameter_type, Parameter::KEY_TYPES, :desc => N_("Type of value")
+          param :hidden_value, :bool
+        end
         param :build, :bool
         param :enabled, :bool
         param :provision_method, String
@@ -102,9 +108,16 @@ module Api
         state = true
         User.as_anonymous_admin do
           @discovered_host = Host::Discovered.import_host(facts)
-          Rails.logger.warn 'Discovered facts import unsuccessful, skipping auto provisioning' unless @discovered_host
-          if Setting['discovery_auto'] && @discovered_host && (rule = find_discovery_rule(@discovered_host))
-            state = perform_auto_provision(@discovered_host, rule)
+          # Host::Based.set_taxonomies sets taxonomies during import from either
+          # facts or via Global Foreman setting "default_taxonomy", reset it back so
+          # the anonymous admin can see all records. We set taxonomy explicitly via
+          # discovery SubnetAndTaxonomy import hook and enforce taxnomy manually
+          # in find_discovery_rule method via validate_rule_by_taxonomy.
+          Taxonomy.no_taxonomy_scope do
+            Rails.logger.warn 'Discovered facts import unsuccessful, skipping auto provisioning' unless @discovered_host
+            if Setting['discovery_auto'] && @discovered_host && (rule = find_discovery_rule(@discovered_host))
+              state = perform_auto_provision(@discovered_host, rule)
+            end
           end
         end
         process_response state

data/app/controllers/api/v2/discovery_rules_controller.rb

@@ -55,7 +55,7 @@ module Api
       param_group :discovery_rule, :as => :update
 
       def update
-        process_response @discovery_rule.update_attributes(discovery_rule_params)
+        process_response @discovery_rule.update(discovery_rule_params)
       end
 
       api :DELETE, "/discovery_rules/:id/", N_("Delete a rule")

data/app/controllers/discovered_hosts_controller.rb

@@ -199,15 +199,17 @@ class DiscoveredHostsController < ::ApplicationController
 
   def setup_host_class_variables
     if @host.hostgroup
+      subnet = @host.hostgroup.subnet || @host.subnet
+      subnet6 = @host.hostgroup.subnet6 || @host.subnet6
       @architecture    = @host.hostgroup.architecture
       @operatingsystem = @host.hostgroup.operatingsystem
       @environment     = @host.hostgroup.environment
       @domain          = @host.hostgroup.domain
-      @subnet          = @host.hostgroup.subnet
+      @subnet          = subnet
+      @subnet6         = subnet6
       @compute_profile = @host.hostgroup.compute_profile
       @realm           = @host.hostgroup.realm
-      @host.interfaces.first.assign_attributes(subnet: @subnet,
-                                               domain: @domain)
+      @host.interfaces.first.assign_attributes(subnet: subnet, subnet6: subnet6, domain: @domain)
       @host.environment = @environment
     end
   end

data/app/controllers/discovery_rules_controller.rb

@@ -28,7 +28,7 @@ class DiscoveryRulesController < ApplicationController
   end
 
   def update
-    if @discovery_rule.update_attributes(discovery_rule_params)
+    if @discovery_rule.update(discovery_rule_params)
       process_success
     else
       process_error

data/app/models/discovery_rule.rb

@@ -22,7 +22,7 @@ class DiscoveryRule < ApplicationRecord
   before_validation :enforce_taxonomy
 
   belongs_to :hostgroup
-  has_many :hosts, :dependent => :nullify
+  has_many_hosts :dependent => :nullify
 
   scoped_search :on => :name, :complete_value => :true
   scoped_search :on => :priority, :only_explicit => true

data/app/models/host/discovered.rb

@@ -44,9 +44,13 @@ class Host::Discovered < ::Host::Base
 
   # Discovery import workflow:
   # discovered#import_host ->
-  #  discovered#import_facts -> base#import_facts -> base#parse_facts ->
-  #  discovered#populate_fields_from_facts -> base#populate_fields_from_facts -> base#set_interfaces
-  #  discovered#populate_discovery_fields_from_facts
+  # ForemanDiscovery::HostFactImporter#import_facts ->
+  # ::HostFactImporter#import_facts ->
+  # ::HostFactImporter#parse_facts ->
+  # discovered#populate_fields_from_facts ->
+  # base#populate_fields_from_facts ->
+  # base#set_interfaces ->
+  # discovered#populate_discovery_fields_from_facts
   def self.import_host facts
     raise(::Foreman::Exception.new(N_("Invalid facts, must be a Hash"))) unless facts.is_a?(Hash) || facts.is_a?(ActionController::Parameters)
 
@@ -92,19 +96,11 @@ class Host::Discovered < ::Host::Base
 
     # and save (interfaces are created via puppet parser extension)
     host.save(:validate => false) if host.new_record?
-    raise ::Foreman::Exception.new(N_("Facts could not be imported")) unless host.import_facts(facts)
+    importer = ForemanDiscovery::HostFactImporter.new(host)
+    raise ::Foreman::Exception.new(N_("Facts could not be imported")) unless importer.import_facts(facts)
     host
   end
 
-  def import_facts(facts)
-    # Discovered Hosts won't report in via puppet, so we can use that field to
-    # 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
-    super(facts)
-  end
-
   def setup_clone
     # Nic::Managed needs this method but Discovered hosts shouldn't
     # be doing orchestration anyway...
@@ -137,33 +133,55 @@ class Host::Discovered < ::Host::Base
     subnet.present? && subnet.discovery.present?
   end
 
-  def proxy_url
-    proxied? ? subnet.discovery.url + "/discovery/#{self.ip}" : "https://#{self.ip}:8443"
+  def proxy_url(node_ip)
+    proxied? ? subnet.discovery.url + "/discovery/#{node_ip}" : "https://#{node_ip}:8443"
   end
 
   def refresh_facts
-    facts = ::ForemanDiscovery::NodeAPI::Inventory.new(:url => proxy_url).facter
+    facts = ::ForemanDiscovery::NodeAPI::Inventory.new(:url => proxy_url(self.ip)).facter
     self.class.import_host facts
-    import_facts facts
+    ::ForemanDiscovery::HostFactImporter.new(self).import_facts facts
   rescue => e
     ::Foreman::Logging.exception("Unable to get facts from proxy", e)
-    raise ::Foreman::WrappedException.new(e, N_("Could not get facts from proxy %{url}: %{error}"), :url => proxy_url, :error => e)
-  end
-
-  def reboot
-    resource = ::ForemanDiscovery::NodeAPI::Power.service(:url => proxy_url)
-    resource.reboot
-  rescue => e
-    ::Foreman::Logging.exception("Unable to reboot #{name}", e)
-    raise ::Foreman::WrappedException.new(e, N_("Unable to reboot %{name} via %{url}: %{msg}"), :name => name, :url => proxy_url, :msg => e.to_s)
-  end
-
-  def kexec json
-    resource = ::ForemanDiscovery::NodeAPI::Power.service(:url => proxy_url)
-    resource.kexec json
-  rescue => e
-    ::Foreman::Logging.exception("Unable to perform kexec on #{name}", e)
-    raise ::Foreman::WrappedException.new(e, N_("Unable to perform kexec on %{name} via %{url}: %{msg}"), :name => name, :url => proxy_url, :msg => e.to_s)
+    raise ::Foreman::WrappedException.new(e, N_("Could not get facts from proxy %{url}: %{error}"), :url => proxy_url(self.ip), :error => e)
+  end
+
+  def reboot(old_ip = nil, new_ip = nil)
+    # perform the action against the original lease as well as the new reservation
+    ips = [old_ip, new_ip, self.ip].compact.uniq
+    logger.debug "Performing reboot calls against #{ips.to_sentence}, facts left #{facts.count}"
+    ips.each do |next_ip|
+      begin
+        node_url = proxy_url(next_ip)
+        logger.debug "Performing reboot call against #{node_url}"
+        resource = ::ForemanDiscovery::NodeAPI::Power.service(:url => node_url)
+        return true if resource.reboot
+      rescue => e
+        msg = N_("Unable to perform reboot on %{name} (%{url}): %{msg}")
+        ::Foreman::Logging.exception(msg % { :name => name, :url => node_url, :msg => e.to_s }, e)
+      end
+    end
+    msg = N_("Unable to perform %{action} on %{ips}")
+    raise ::Foreman::Exception.new(msg, action: "reboot", ips: ips.to_sentence)
+  end
+
+  def kexec(json, old_ip = nil, new_ip = nil)
+    # perform the action against the original lease as well as the new reservation
+    ips = [old_ip, new_ip, self.ip].compact.uniq
+    logger.debug "Performing kexec calls against #{ips.to_sentence}, #{facts.count} facts left"
+    ips.each do |next_ip|
+      begin
+        node_url = proxy_url(next_ip)
+        logger.debug "Performing kexec call against #{node_url}"
+        resource = ::ForemanDiscovery::NodeAPI::Power.service(:url => node_url)
+        return true if resource.kexec(json)
+      rescue => e
+        msg = N_("Unable to perform kexec on %{name} (%{url}): %{msg}")
+        ::Foreman::Logging.exception(msg % { :name => name, :url => node_url, :msg => e.to_s }, e)
+      end
+    end
+    msg = N_("Unable to perform %{action} on %{ips}")
+    raise ::Foreman::Exception.new(msg, action: "kexec", ips: ips.to_sentence)
   end
 
   def self.model_name

data/app/models/host/managed_extensions.rb

@@ -27,7 +27,7 @@ module Host::ManagedExtensions
   end
 
   def setReboot
-    old.becomes(Host::Discovered).reboot
+    old.becomes(Host::Discovered).reboot(old.ip, ip)
     # It is too late to report error in the post_queue, we catch them and
     # continue. If flash is implemented for new hosts (http://projects.theforeman.org/issues/10559)
     # we can report the error to the user perhaps.
@@ -55,7 +55,7 @@ module Host::ManagedExtensions
   end
 
   def setKexec
-    old.becomes(Host::Discovered).kexec(render_kexec_template.to_json)
+    old.becomes(Host::Discovered).kexec(render_kexec_template.to_json, old.ip, ip)
     true
   rescue ::Foreman::Exception => e
     Foreman::Logging.exception("Unable to kexec", e)

data/app/models/setting/discovered.rb

@@ -8,7 +8,9 @@ class Setting::Discovered < ::Setting
   BLANK_ATTRS << 'discovery_facts_hardware'
   BLANK_ATTRS << 'discovery_facts_network'
   BLANK_ATTRS << 'discovery_facts_ipmi'
-  BLANK_ATTRS << 'discovery_prefix'
+
+  STRING_PRESENCE_ATTRS = ['discovery_hostname', 'discovery_prefix']
+  validates :value, :presence => true, :if => proc { |s| STRING_PRESENCE_ATTRS.include?(s.name) }
 
   def self.default_settings
     [

data/app/services/foreman_discovery/host_converter.rb

@@ -1,6 +1,6 @@
 class ForemanDiscovery::HostConverter
   # Converts discovered host to managed host without uptading the database.
-  # Record must be saved explicitly (using save! or update_attributes! or similar).
+  # Record must be saved explicitly (using save! or update! or similar).
   # Creates shallow copy.
   def self.to_managed(original_host, set_managed = true, set_build = true, added_attributes = {})
     host = original_host.becomes(::Host::Managed)
@@ -35,12 +35,21 @@ class ForemanDiscovery::HostConverter
   end
 
   def self.unused_ip_for_subnet(subnet, mac, existing_ip)
-    ipam = subnet.unused_ip(mac)
-    raise(::Foreman::Exception.new(N_("IPAM must be configured for subnet '%s'"), subnet)) unless ipam.present?
+    # prefer existing reservation to prevent conflicts
+    existing_rec = subnet&.dhcp_proxy&.record(subnet.network, mac)
 
-    # None IPAM returns nil - in that case keep the current address
-    suggested_ip = ipam.suggest_ip
-    suggested_ip.nil? ? existing_ip : suggested_ip
+    if existing_rec && existing_rec.type == "reservation"
+      # reuse the reservation
+      existing_rec.ip
+    else
+      # no reservation - find new unused IP
+      ipam = subnet.unused_ip(mac)
+      raise(::Foreman::Exception.new(N_("IPAM must be configured for subnet '%s'"), subnet)) unless ipam.present?
+
+      # None IPAM returns nil - in that case keep the current address
+      suggested_ip = ipam.suggest_ip
+      suggested_ip.nil? ? existing_ip : suggested_ip
+    end
   end
 
   def self.unused_ip_for_host(host, new_subnet = nil, new_subnet6 = nil)
@@ -51,7 +60,6 @@ class ForemanDiscovery::HostConverter
       interface.subnet6 = new_subnet6 if new_subnet6
       interface.ip = unused_ip_for_subnet(interface.subnet, interface.mac, interface.ip) if interface.subnet
       interface.ip6 = unused_ip_for_subnet(interface.subnet6, interface.mac, interface.ip6) if interface.subnet6
-      interface.save!
     end
   end
 

data/app/services/foreman_discovery/host_fact_importer.rb

@@ -0,0 +1,10 @@
+class ForemanDiscovery::HostFactImporter < ::HostFactImporter
+    def import_facts(facts)
+        # Discovered Hosts won't report in via puppet, so we can use that field to
+        # record the last time it sent facts...
+        host.last_report = Time.now
+        # Set the correct facts type for new foreman facts importing code.
+        facts[:_type] = :foreman_discovery
+        super(facts)
+    end
+end

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

@@ -35,6 +35,7 @@ module ForemanDiscovery
         Location.find_by_title(facts["discovery_location"]) ||
           Location.find_by_title(Setting[:discovery_location]) ||
           host.subnet.try(:locations).try(:first) ||
+          host.subnet6.try(:locations).try(:first) ||
           Location.first
       end
 
@@ -48,6 +49,7 @@ module ForemanDiscovery
         Organization.find_by_title(facts["discovery_organization"]) ||
           Organization.find_by_title(Setting[:discovery_organization]) ||
           host.subnet.try(:organizations).try(:first) ||
+          host.subnet6.try(:organizations).try(:first) ||
           Organization.first
       end
     end

data/app/services/foreman_discovery/node_api/node_resource.rb

@@ -6,6 +6,7 @@ module ForemanDiscovery::NodeAPI
       @args = args
       @connect_params = {
         :headers => { :accept => :json },
+        :timeout => 20, # tighter timeout, discovery performs up to two calls per request
       }
 
       if url.match(/^https/i) && Rails.env != "test"

data/app/views/api/v2/discovery_rules/create.json.rabl

@@ -0,0 +1,3 @@
+object @discovery_rule
+
+extends "api/v2/discovery_rules/show"

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

@@ -17,8 +17,6 @@
           <% if show_location_tab? %>
             <%= select_f f, :location_id, Location.my_locations, :id, :to_label, {}, {:size => 'col-md-10'} %>
           <% end %>
-
-          <div>Changing the Host's Subnet is not possible via Customize Host form, use Create Host or Auto provisioning and set the desired Subnet in the Hostgroup.</div>
         </div>
         <div class="modal-footer">
           <button type="button" class="btn btn-default" data-dismiss="modal">Cancel</button>

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

@@ -1,10 +1,16 @@
+<% content_for(:javascripts) do %>
+  <%= webpacked_plugins_js_for :'foreman_discovery' %>
+<% end %>
+<% content_for(:stylesheets) do %>
+  <%= webpacked_plugins_css_for :'foreman_discovery' %>
+<% end %>
+
 <% content_for(:title, _("Discovered Hosts")) %>
-<div class="blank-slate-pf">
-  <div class="blank-slate-pf-icon">
-    <%= icon_text("gears", "", :kind => "fa") %>
-  </div>
-  <h1><%= _('Discovered Hosts') %></h1>
-  <p><%= _("No discovered hosts found in this context.") %>
-  <%= _("This page shows discovered bare-metal or virtual nodes waiting to be provisioned.") %></p>
-  <p><%= link_to _('Learn more about this in the documentation.'), documentation_url("#{ForemanDiscovery::VERSION.scan(/\d+\.\d+/).first}/index.html", {:root_url => 'https://theforeman.org/plugins/foreman_discovery/'})%></p>
-</div>
+
+<% content_for(:content) do %>
+  <%= notifications %>
+  <div id="organization-id" data-id="<%= Organization.current.id if Organization.current %>" ></div>
+  <div id="user-id" data-id="<%= User.current.id if User.current %>" ></div>
+  <%= react_component('DiscoveredHosts',
+       docUrl: "https://theforeman.org/plugins/foreman_discovery/#{ForemanDiscovery::VERSION.scan(/\d+\.\d+/).first}/index.html" ) %>
+<% end %>

data/app/views/discovery_rules/index.html.erb

@@ -18,7 +18,7 @@
       <td><%= trunc_with_tooltip(rule.search) %></td>
       <td><%= label_with_link(rule.hostgroup, 26, authorizer) %></td>
       <td><%= rule.hosts.count %> / <%= rule.max_count %></td>
-      <td><%= rule.enabled %></td>
+      <td><%= checked_icon rule.enabled %></td>
       <td><%= action_buttons(*permitted_discovery_actions(rule)) %></td>
     </tr>
   <% end %>

data/app/views/foreman_discovery/debian_kexec.erb

@@ -12,9 +12,10 @@ environments. The template must generate JSON format with the following items
 "kernel", "initram", "append" and "extra". The kexec command is composed in
 the following way:
 
-kexec --force --reset-vga --append=$append --initrd=$initram $extra $kernel
+kexec --force --debug --append=$append --initrd=$initram $extra $kernel
 
 Please read kexec(8) man page for more information about semantics.
+Extra options like --reset-vga can be set via "extra" array.
 -%>
 <%
   mac = @host.facts['discovery_bootif']
@@ -28,7 +29,7 @@ Please read kexec(8) man page for more information about semantics.
   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 << "locale=#{host_param('lang') || 'en_US'}"
   options << "inst.stage2=#{@host.operatingsystem.medium_uri(@host)}" if @host.operatingsystem.name.match(/Atomic/i)
 -%>
 {

data/app/views/foreman_discovery/redhat_kexec.erb

@@ -22,9 +22,10 @@ environments. The template must generate JSON format with the following items
 "kernel", "initram", "append" and "extra". The kexec command is composed in
 the following way:
 
-kexec --force --reset-vga --append=$append --initrd=$initram $extra $kernel
+kexec --force --debug --append=$append --initrd=$initram $extra $kernel
 
 Please read kexec(8) man page for more information about semantics.
+Extra options like --reset-vga can be set via "extra" array.
 -%>
 <%
   mac = @host.facts['discovery_bootif']

data/db/migrate/20150512150432_remove_old_discovery_reader_permissions.rb

@@ -1,7 +1,7 @@
 class RemoveOldDiscoveryReaderPermissions < ActiveRecord::Migration[4.2]
   def up
     Permission.where("name like '%_discovery_rules' and resource_type is null").each do |permission|
-      permission.update_attributes(:resource_type => 'DiscoveryRule')
+      permission.update(:resource_type => 'DiscoveryRule')
     end
   end
 

data/db/migrate/20151023144501_regenerate_red_hat_kexec.rb

@@ -1,7 +1,7 @@
 class RegenerateRedHatKexec < ActiveRecord::Migration[4.2]
   def up
     t = ProvisioningTemplate.find_by_name("Discovery Red Hat kexec")
-    t.update_attributes(:template => t.template.sub(/rescue ''$/, 'if mac')) if t
+    t.update(:template => t.template.sub(/rescue ''$/, 'if mac')) if t
   end
 
   def down