foreman_discovery 2.0.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8376f5939d2a45b99fa967a25a8643d6b9145016
-  data.tar.gz: 51dbc6574fd0e9edc5625ccb1aad6ec9b19575fc
+  metadata.gz: 73911ee5b9b16a403e8f2709babed0be65bcdd31
+  data.tar.gz: ba4db8e574a8fac66bf4a7b481750581c2e22484
 SHA512:
-  metadata.gz: cc7ef21b60498eb6a65a7822c0d2aaf8a8bc52f1a1cc02e7026b4fac26efb0529774e4b2f2b741fa9015d06e28a0f73ae37d5d83756770017c88448735e75d93
-  data.tar.gz: 883e95584fe9574bccd635bc860ffec433b61b2b0715397108af6d16cdaf1f852cfc14cc79ef7923f2a9eb155962708bf61294aa2bffee77753bc54adf4007dc
+  metadata.gz: ab7fba75b6799fcc3c95890a3f942cafea7f4c590a45514f0ebba707256cff977bc5cdec67bdea7bd5ed96c0a5897e6f3c1133b47bc930184fc3750458eee121
+  data.tar.gz: 3fc4a54ee297c7c3134c3ef02e373225bfc809bc162a90b07dad598455318926065da63696fa0925066709cf1bbb4f54a00183ed8d9da1151243a8b048154695

data/README.md

@@ -1,40 +1,10 @@
 # foreman\_discovery
 
-This plugin enables MaaS hardware discovery in Foreman. There are two
-artifacts (and terms) used in this document:
+This plugin enables MaaS hardware discovery in Foreman.
 
-* foreman_discovery plugin - software installed in Foreman that adds Discovered
-  Hosts menu entry, API and required configuration
-* discovery image - net-bootable image that needs to be installed in the TFTP
-  server and configured in Foreman for new (unknown) hosts to boot from over
-  PXE
+# Documentation
 
-## Minimal hardware requirements
-
-Since the bootable image runs from memory, keep in mind the minimum
-requirement of 500 MB RAM otherwise kernel panic can be seen during boot
-sequence.
-
-# Installation (plugin)
-
-Please see the Foreman wiki for appropriate instructions:
-
-* [Foreman: How to Install a Plugin](http://projects.theforeman.org/projects/foreman/wiki/How_to_Install_a_Plugin)
-
-The gem name is "foreman_discovery".
-
-RPM users can install the "ruby193-rubygem-foreman_discovery" or
-"rubygem-foreman_discovery" packages.
-
-## Compatibility
-
-| Foreman Version | Plugin Version | Image Version       |
-| --------------- | --------------:| -------------------:|
-| <= 1.2          | 1.0.2          | N/A                 |
-|  = 1.3          | 1.1.0          | 0.1.0               |
-|  = 1.4          | 1.2.0          | 0.3.0-1             |
-|  = 1.5          | 1.3.0          | 0.5.0-1             |
-| >= 1.6          | 1.4.0          | 0.6 or 2.0          |
+The main documentation can be found in [Foreman Discovery 2.0 Manual] (http://theforeman.org/plugins/foreman_discovery/2.0/).
 
 ## Latest code
 
@@ -43,155 +13,6 @@ branch of the plugin can be obtained by updating the Gemfile in this way:
 
     gem 'foreman_discovery', :git => "https://github.com/theforeman/foreman_discovery.git"
 
-# Installation (image)
-
-The image is based on CentOS 7 and about 150 MB in size. The recommended
-option is to download a prebuilt image from the Foreman repositories.
-
-## Downloading an image
-
-### Download via installer
-
-As of Foreman 1.6, the foreman-installer is able to automatically download
-latest stable image.  For this, re-run the installer with the following
-option:
-
-    # foreman-installer \
-        --enable-foreman-plugin-discovery \
-        --foreman-plugin-discovery-install-images=true
-
-### Manual download
-
-Images are available from:
-
-* http://downloads.theforeman.org/discovery/
-
-To download the latest release to the expected location, do the following:
-
-    # wget http://downloads.theforeman.org/discovery/releases/latest/fdi-image-latest.tar \
-      -O - | tar x --overwrite -C /var/lib/tftpboot/boot
-
-After download, verify checksums:
-
-    # cat /var/lib/tftpboot/boot/fdi-image/SHA256SUM
-    beb3cfba7d9fb9d71481c0c8f... initrd0.img
-    f03bce150d2473a28697d2988... vmlinuz0
-    # sha256sum /var/lib/tftpboot/boot/fdi-image/*
-
-### Building an image
-
-To build a discovery image, please visit the
-[foreman-discovery-image](https://github.com/theforeman/foreman-discovery-image)
-git repository and find the README for further instructions.
-
-# Configuration (image)
-
-Foreman Discovery relies on intercepting the normal boot process for machines
-not registered in Foreman. To achieve this, the PXE default.cfg file needs to
-be altered to instruct new machines to boot the discovery image.
-
-In the Foreman UI, go to Provisioning Templates, edit *PXELinux global default*
-template and add the following after the "LABEL local" block of options:
-
-    LABEL discovery
-    MENU LABEL Foreman Discovery
-    MENU DEFAULT
-    KERNEL boot/fdi-image/vmlinuz0
-    APPEND initrd=boot/fdi-image/initrd0.img rootflags=loop root=live:/fdi.iso rootfstype=auto ro rd.live.image acpi=force rd.luks=0 rd.md=0 rd.dm=0 rd.lvm=0 rd.bootif=0 rd.neednet=0 nomodeset proxy.url=http://xyz proxy.type=proxy
-    IPAPPEND 2
-
-The `proxy.type` option can be either `proxy` or `foreman`. In the first case
-all communication goes through Smart Proxy, in the latter case the
-communication goes directly to Foreman (legacy mode). This is the default when
-not specified.
-
-The `proxy.url` specifies URL of the Smart Proxy or Foreman depending on the
-previous setting. Both http and https schemes are supported. For backward
-compatibility, `foreman.url` is an alias for this setting.
-
-Once the APPEND line is modified properly, set the entry to be default via the
-`ONTIMEOUT` option:
-
-    ONTIMEOUT discovery
-
-*Alternatively*, the Discovery image also searches for DNS SRV record named
-`_x-foreman._tcp`. If the DNS server is configured for this (see the example
-for ISC BIND below), then it is not required to provide `foreman.url` at all.
-
-    _x-foreman._tcp SRV 0 5 443 foreman
-
-This can still be overriden with the command line opts.
-
-It is important to have *IPAPPEND 2* option which adds BOOTIF=MAC option which
-is then reported via facter as `discovery_bootif` which is key fact which is
-used for provisioning. Without this line, DNS will not work properly as well.
-
-It is important to know that DNS servers from DHCP are enabled only for the
-interface that was specified via the BOOTIF option. This means when a system
-have multiple NICs, DNS will work for the correct interface - the one that was
-booted from.
-
-_Warning_: For now, the selinux=0 option *must* be provided, the image is read
-only anyway but we plan to enable and test with SELinux too.
-
-## Updating the on-disk `default` file
-
-Once the template has been updated, click the Build PXE Default button at the top
-of the Provisioning Templates page. This will instruct the TFTP proxy to rewrite
-the `pxelinux.cfg/default` file.
-
-# Configuration (plugin)
-
-No configuration of the plugin in the Foreman UI is required, but some
-configuration is available.
-
-If Locations and/or Organisations are enabled, Foreman will default to using
-the first Location and first Organisation for Discovered hosts. If hosts should
-be placed in some other Location/Organization, alter the default Loc/Org in
-`More->Settings->Discovered`
-
-There is also setting called `discovery_fact` which defaults to
-`discovery_bootif` which specifies which incoming fact should be used to get
-the MAC address. By default PXELinux BOOTIF kernel command line option is used
-which gives a MAC address of the interface which was booted from. Make sure
-the `IPAPPEND 2` option is set correctly in the Foreman template.
-
-# Usage
-
-Boot a machine using the new PXE config above. It should register with
-Foreman. The new Host should show up in `Hosts->Discovered Hosts`. Then select
-a Discovered Host and choose Provision. This will redirect to the normal Edit
-page for a Host, with the discovered data filled in where possible. Fill in
-the details as normal.
-
-On save, a reboot is sent to the discovered host, after which it should reboot into
-the installer for the chosen OS, and finally into the installed OS.
-
-Delete a machine and reboot it to have it move back to the Discovery Pool.
-
-# Permissions
-
-The plugin will create a Role called `Discovery` when first started. This can
-be assigned to roles for non-admins to allow them to use the discovery plugin.
-Alternatively assign the `:perform_discovery` permission to an existing Role.
-
-# Troubleshooting
-
-If the booted machine fails to register with Foreman, then there are a number of common causes:
-
-* Machine did not boot the correct image
-  * check your `pxelinux.cfg/default` has the right config as above
-* Machine booted image but failed to contact Foreman
-  * Check the `foreman.url` option in `pxelinux.cfg/default` is correctly defined
-  * Check DNS is working for that image, or use an IP in `foreman.url`
-  * Check DHCP is handing IPs to the booted image correctly
-
-To log in the running image you need to set root password which is locked by
-default. In addition, you can enable ssh server as well. To do this, provide
-the following kernel command line options:
-
-    APPEND ... fdi.ssh=1 fdi.rootpw=redhat
-
 # API
 
 see the [API README](README.api.md)

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

@@ -119,7 +119,7 @@ module Api
       def auto_provision
         @discovered_host.transaction do
           if rule = find_discovery_rule(@discovered_host)
-            msg = _("Host %s was provisioned with rule %s") % [@discovered_host.name, rule.name]
+            msg = _("Host %{host} was provisioned with rule %{rule}") % {:host => @discovered_host.name, :rule => rule.name}
             process_response perform_auto_provision(@discovered_host, rule), msg
           else
             process_success _("No rule found for host %s") % @discovered_host.name
@@ -135,7 +135,7 @@ module Api
         result = true
         error_message = _("Errors during auto provisioning: %s")
 
-        if  Host::Discovered.count == 0
+        if Host::Discovered.count == 0
           error_message = _("No discovered hosts to provision")
           result = false
         end

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

@@ -28,13 +28,13 @@ module Api
 
       def_param_group :discovery_rule do
         param :discovery_rule, Hash, :action_aware => true do
-          param :name, String, :required => true, :desc => N_("represents rule name shown to the users")
-          param :search, String, :required => true, :desc => N_("query to match discovered hosts for the particular rule")
-          param :hostgroup_id, Integer, :required => true, :desc => N_("the hostgroup that is used to auto provision a host")
-          param :hostname, String, :desc => N_("defines a pattern to assign human-readable hostnames to the matching hosts")
-          param :max_count, Integer, :desc => N_("enables to limit maximum amount of provisioned hosts per rule")
-          param :priority, Integer, :desc => N_("puts the rules in order, low numbers go first. Must be greater then zero")
-          param :enabled, :bool, :desc => N_("flag is used for temporary shutdown of rules")
+          param :name, String, :required => true
+          param :search, String, :required => true
+          param :hostgroup_id, Integer, :required => true
+          param :hostname, String, :required => true
+          param :max_count, Integer
+          param :priority, Integer
+          param :enabled, :bool
         end
       end
 
@@ -48,7 +48,15 @@ module Api
 
       api :PUT, "/discovery_rules/:id/", N_("Update a rule")
       param :id, :identifier, :required => true
-      param_group :discovery_rule, :as => :update
+      param :discovery_rule, Hash, :action_aware => true do
+          param :name, String, :required => true
+          param :search, String, :required => true
+          param :hostgroup_id, Integer, :required => true
+          param :hostname, String, :required => true
+          param :max_count, Integer
+          param :priority, Integer
+          param :enabled, :bool
+      end
 
       def update
         process_response @discovery_rule.update_attributes(params[:discovery_rule])

data/app/controllers/discovered_hosts_controller.rb

@@ -154,6 +154,13 @@ class DiscoveredHostsController < ::ApplicationController
 
   def auto_provision_all
     result = true
+    error_message = _("Errors during auto provisioning: %s")
+
+    if Host::Discovered.count == 0
+      error_message = _("No discovered hosts to provision")
+      result = false
+    end
+
     Host.transaction do
       overall_errors = ""
       Host::Discovered.all.each do |discovered_host|
@@ -169,7 +176,7 @@ class DiscoveredHostsController < ::ApplicationController
       if result
         process_success :success_msg => _("Discovered hosts are provisioning now"), :success_redirect => :back
       else
-        process_error :error_msg => _("Errors during auto provisioning: %s") % overall_errors, :redirect => :back
+        process_error :error_msg => error_message % overall_errors, :redirect => :back
       end
     end
   end

data/app/helpers/discovered_hosts_helper.rb

@@ -30,7 +30,7 @@ module DiscoveredHostsHelper
 
     select_action_button( _("Select Action"), {:id => 'submit_multiple'},
       actions.map do |action|
-        link_to(action[0] , action[1], :'data-dialog-title' => _("%s - The following hosts are about to be changed") % action[0])
+        link_to_function(action[0], "build_modal(this, '#{action[1]}')", :'data-dialog-title' => _("%s - The following hosts are about to be changed") % action[0])
       end.flatten
     )
 

data/app/models/discovery_rule.rb

@@ -15,7 +15,6 @@ class DiscoveryRule < ActiveRecord::Base
   validates :max_count, :numericality => { :only_integer => true, :greater_than_or_equal_to => 0 }
   validates :priority, :presence => true, :numericality => { :only_integer => true, :greater_than_or_equal_to => 0 }
   validates_lengths_from_database
-  before_validation :default_int_attributes
 
   belongs_to :hostgroup
   has_many :hosts
@@ -24,10 +23,4 @@ class DiscoveryRule < ActiveRecord::Base
   scoped_search :on => :priority
   scoped_search :on => :search
   scoped_search :on => :enabled
-  scoped_search :in => :hostgroup, :on => :name, :complete_value => true, :rename => :hostgroup
-
-  def default_int_attributes
-   self.max_count ||= 0
-   self.priority  ||= 0
-  end
 end

data/app/models/host/discovered.rb

@@ -9,8 +9,6 @@ class Host::Discovered < ::Host::Base
   belongs_to :hostgroup
   has_one    :discovery_attribute_set, :foreign_key => :host_id, :dependent => :destroy
 
-  validates :mac, :uniqueness => true, :mac_address => true, :presence => true
-  validates :ip, :format => {:with => Net::Validations::IP_REGEXP}, :uniqueness => true
   validates :discovery_attribute_set, :presence => true
 
   delegate :memory, :cpu_count, :disk_count, :disks_size, :to => :discovery_attribute_set
@@ -92,8 +90,14 @@ class Host::Discovered < ::Host::Base
     super
   end
 
+  def setup_clone
+    # Nic::Managed needs this method but Discovered hosts shouldn't
+    # be doing orchestration anyway...
+    clone
+  end
+
   def attributes_to_import_from_facts
-    super + [:ip]
+    super
   end
 
   def populate_fields_from_facts facts = self.facts_hash, type = 'puppet'
@@ -103,7 +107,7 @@ class Host::Discovered < ::Host::Base
     else
       importer = super(facts)
     end
-    self.subnet = Subnet.subnet_for(importer.ip)
+    self.primary_interface.subnet = Subnet.subnet_for(self.primary_interface.ip)
     self.discovery_attribute_set = DiscoveryAttributeSet.where(:host_id => id).first_or_create
     self.discovery_attribute_set.update_attributes(import_from_facts)
     self.save
@@ -178,4 +182,10 @@ class Host::Discovered < ::Host::Base
     false
   end
 
+  def lookup_value_match
+    # We don't really expect lookup values to be used to match discovered hosts,
+    # so simply put a string that won't match anything here
+    "discovery-not-matched"
+  end
+
 end

data/app/services/host_converter.rb

@@ -1,6 +1,6 @@
 class ForemanDiscovery::HostConverter
 
-  # must be called from SQL transaction 
+  # must be called from SQL transaction
   def self.to_managed(original_host, set_managed = true, set_build = true)
     if ActiveRecord::Base.connection.open_transactions <= 0
       raise "This method must be executed with explicit transaction"
@@ -10,7 +10,7 @@ class ForemanDiscovery::HostConverter
     # the following flags can be skipped when parameters are set to false
     if set_managed
       host.managed = set_managed
-      host.managed = set_managed
+      host.primary_interface.managed = set_managed
     end
     host.build = set_build if set_build
     # this gets rolled back when anything in the transaction fails

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

@@ -2,9 +2,4 @@ object @discovery_rule
 
 extends "api/v2/discovery_rules/base"
 
-attributes :name, :enabled, :hostgroup_id, :hostgroup_name, :hostname, :priority, :search
-attribute :max_count => :hosts_limit
-
-child :hosts do
-  extends "api/v2/discovered_hosts/base"
-end
+attributes :name, :enabled, :hostgroup_id, :hostname, :max_count, :priority, :search

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

@@ -1,4 +1,4 @@
-<td><%= link_to h(host.name), discovered_host_path(host) %></td>
+<td><%= link_to trunc_with_tooltip(h(host.name)), discovered_host_path(host) %></td>
 <td class="hidden-tablet hidden-xs"><%= model_name host %></td>
 <td class="hidden-tablet hidden-xs"><%= host.ip %></td>
 <td class="hidden-tablet hidden-xs"><%= discovery_attribute(host, :cpu_count) %></td>

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

@@ -35,7 +35,7 @@
       <% if SETTINGS[:organizations_enabled] -%>
         <td class="hidden-tablet hidden-xs"><%= host.organization.try(:name) %></td>
       <% end -%>
-      <td class="hidden-tablet hidden-xs"><%= host.subnet %></td>
+      <td class="hidden-tablet hidden-xs"><%= host.primary_interface.try(:subnet) %></td>
       <td class="hidden-tablet hidden-xs"><%= disc_report_column(host) %></td>
       <td>
         <%= action_buttons(
@@ -61,7 +61,7 @@
       </div>
       <div class="modal-footer">
         <button type="button" class="btn btn-default" data-dismiss="modal"><%= _('Cancel') %></button>
-        <button type="button" class="btn btn-primary"><%= _('Submit') %></button>
+        <button type="button" class="btn btn-primary" onclick="submit_modal_form()"><%= _('Submit') %></button>
       </div>
     </div><!-- /.modal-content -->
   </div><!-- /.modal-dialog -->

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

@@ -13,10 +13,10 @@
   </tr>
   <% for rule in @discovery_rules %>
     <tr>
-      <td class='col-md-3 display-two-pane'><%= link_to_if_authorized(rule.name, hash_for_edit_discovery_rule_path(:id => rule).merge(:auth_object => rule, :authorizer => authorizer)) %></td>
+      <td class='col-md-3 display-two-pane'><%= link_to_if_authorized(trunc_with_tooltip(rule.name), hash_for_edit_discovery_rule_path(:id => rule).merge(:auth_object => rule, :authorizer => authorizer)) %></td>
       <td><%= rule.priority %></td>
-      <td><%= rule.search %></td>
-      <td><%= rule.hostgroup.name %></td>
+      <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><%= action_buttons(*permitted_discovery_actions(rule)) %></td>

data/lib/foreman_discovery/engine.rb

@@ -37,7 +37,7 @@ module ForemanDiscovery
 
     initializer 'foreman_discovery.register_plugin', :after=> :finisher_hook do |app|
       Foreman::Plugin.register :foreman_discovery do
-        requires_foreman '~> 1.7.0'
+        requires_foreman '>= 1.8.0'
 
         # discovered hosts permissions
         security_block :discovery do
@@ -106,6 +106,10 @@ module ForemanDiscovery
 
         # add template helpers
         allowed_template_helpers :rand
+
+        # apipie API documentation
+        # Only available in 1.8, otherwise it has to be in the initializer below
+        apipie_documented_controllers ["#{ForemanDiscovery::Engine.root}/app/controllers/api/v2/*.rb"]
       end
     end
 
@@ -114,13 +118,6 @@ module ForemanDiscovery
     end
 
     initializer "foreman_discovery.apipie" do
-      # this condition is here for compatibility reason to work with Foreman 1.4.x
-      # Also need to handle the reverse of the 1.8 method above
-      unless (SETTINGS[:version].to_s.include?('develop') or Gem::Version.new(SETTINGS[:version]) >= Gem::Version.new('1.8'))
-        if Apipie.configuration.api_controllers_matcher.is_a?(Array)
-          Apipie.configuration.api_controllers_matcher << "#{ForemanDiscovery::Engine.root}/app/controllers/api/v2/*.rb"
-        end
-      end
       if Apipie.configuration.respond_to?(:checksum_path)
         Apipie.configuration.checksum_path += ['/discovered_hosts/']
       end