foreman_discovery 1.4.1 → 2.0.0.rc1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NWZjNjE1NzM2ODY0MjNhNzA5NTA3YTUwNDg5ZDIxNDEwNWJhYzVmYQ==
-  data.tar.gz: !binary |-
-    YzI1Yjc3N2VkMTBkODgyYWE2Nzg4ZDZkNzgzYTFmYWJkZGViZDlmOA==
+SHA1:
+  metadata.gz: 4b30c810a94650d5f72b8592168e2f2afd5d0854
+  data.tar.gz: 77645786d40659c4205c4f02ed2eb0a426f3fb62
 SHA512:
-  metadata.gz: !binary |-
-    MzkwZTcyZGNlYjZkYmQ0OWM5YTBmNTI0MTAyMzQwNDYwMzJhZDc5NDY3ODc5
-    OWIxYjA4OWNmYzVjZGQwN2NiOWY4ZDYwOGI2MmJmNGNlOWViNDNlODkxNTA4
-    ZmJjNzIwMTYxOGFmZmE0YTE4MjRjMmVkNGE4YThjZjQyMmVkNzc=
-  data.tar.gz: !binary |-
-    ODcxNDVjZDQxYzNmM2MxZTNkMDhhNDI1ZDY2NTBkNmJlMjE1MDZmNjk2NjFi
-    YmY1OTk0Yzc2YzA5NmVlMWIxMzE4NzVlODY2MjNmYTdjNTczNGNhZjllNjg5
-    OTUyODA1MTY0ZDkzOWQ3YzBhY2E4N2Y5YTA4NjE5ZTZiM2UyOTM=
+  metadata.gz: fc9544ac861a5a08b494b8a9089fbc4ce25bc2641f79877f85636927cb4d702ffd9b01d6bf266b0574068ae69d66884e7c71223159984e6e61fe8d445d7b4e49
+  data.tar.gz: bee1405da6e16b59b45fad2d4eb88da763b3af79e12de6fd1b1e24e95931ee69054d49796d83a58dac87ed1107a0d055b2434ad78853248a4174bc60792b9f94

data/README.md

@@ -11,14 +11,9 @@ artifacts (and terms) used in this document:
 
 ## Minimal hardware requirements
 
-Since the bootable image runs from memory, keep in mind the following minimum
-requirements on the hardware that is being discovered:
-
-* 700 MB RAM for the CentOS image
-* 900 MB RAM for the Fedora image
-
-When testing those images on virtual machines, make sure they have allocated
-enough memory, otherwise kernel panic can be seen during boot sequence.
+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)
 
@@ -33,12 +28,13 @@ RPM users can install the "ruby193-rubygem-foreman_discovery" or
 
 ## Compatibility
 
-| Foreman Version | Plugin Version | oVirt Image Version |
+| 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.5          | 1.3.0          | 0.5.0-1             |
+| >= 1.6          | 1.4.0          | 0.6 or 2.0          |
 
 ## Latest code
 
@@ -49,28 +45,20 @@ branch of the plugin can be obtained by updating the Gemfile in this way:
 
 # Installation (image)
 
-The image is based on CentOS 6 & Fedora 18 (there is an image for each) and it
-leverages the oVirt Node open-source project. The download site provides stable
-releases as well as nightly builds for those who want to live on the edge, or
-alternatively a local image can be rebuilt by the user.
-
-The recommended option is to download a prebuilt image from the Foreman
-repositories.
-
-Nightly builds have the ssh daemon enabled and root password set to "redhat";
-logging is also increased. Conversely, releases have the root account locked
-and there is no ssh access. Note that the first console (tty1) is reserved for
-Discovery output. For a login prompt (nightly images only) use tty2.
+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 CentOS6 images.  For this, re-run the installer with the
-following option:
+latest stable image.  For this, re-run the installer with the following
+option:
 
-    # foreman-installer --foreman-plugin-discovery-install-images=true
+    # foreman-installer \
+        --enable-foreman-plugin-discovery \
+        --foreman-plugin-discovery-install-images=true
 
 ### Manual download
 
@@ -78,39 +66,23 @@ Images are available from:
 
 * http://downloads.theforeman.org/discovery/
 
-A choice of using an ISO or a kernel/initrd pair is available.
-
-Kernel/initrd (recommended):
+To download the latest release to the expected location, do the following:
 
-* ovirt-node-iso-3.X.0-0.999.201404XXXXXX.el6.iso-img
-* ovirt-node-iso-3.X.0-0.999.201404XXXXXX.el6.iso-vmlinuz
+    # wget http://downloads.theforeman.org/discovery/releases/latest/fdi-image-latest.tar \
+      -O - | tar x --overwrite -C /var/lib/tftpboot/boot
 
-or ISO file:
+After download, verify checksums:
 
-* ovirt-node-iso-3.X.0-0.999.201404XXXXXX.el6.iso
-
-When downloading the ISO file, it must be extracted before proceeding:
-
-    # yum -y install livecd-tools
-    # ln -sf ovirt-node-iso-3.X.0-0.999.201404170648.el6.iso foreman.iso
-    # sudo livecd-iso-to-pxeboot foreman.iso
-    # find tftpboot/
-    tftpboot/
-    tftpboot/vmlinuz0
-    tftpboot/pxelinux.0
-    tftpboot/pxelinux.cfg
-    tftpboot/pxelinux.cfg/default
-    tftpboot/initrd0.img
-
-Once the initrd/vmlinuz pair (whether from direct download or from ISO
-extraction) is available, copy them to the TFTP BOOT directory and rename them
-to *vmlinuz0* and *initrd0.img*.
+    # 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
-[ovirt-node-plugin-foreman](https://github.com/theforeman/ovirt-node-plugin-foreman)
-page for further instructions.
+[foreman-discovery-image](https://github.com/theforeman/foreman-discovery-image)
+git repository and find the README for further instructions.
 
 # Configuration (image)
 
@@ -119,19 +91,26 @@ 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:
+template and add the following after the "LABEL local" block of options:
 
     LABEL discovery
     MENU LABEL Foreman Discovery
     MENU DEFAULT
-    KERNEL boot/tftpboot/vmlinuz0
-    APPEND rootflags=loop initrd=boot/tftpboot/initrd0.img root=live:/foreman.iso rootfstype=auto ro rd.live.image rd.live.check rd.lvm=0 rootflags=ro crashkernel=128M elevator=deadline max_loop=256 rd.luks=0 rd.md=0 rd.dm=0 nomodeset selinux=0 stateless foreman.url=https://foreman.example.com
+    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
 
-to the end of the file.  Note the `foreman.url` option on the APPEND line,
-which defines where foreman instance is. Make sure this is set correctly or
-discovered hosts will not register to Foreman.  Then make this the default by
-altering the `ONTIMEOUT` option:
+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
 
@@ -155,21 +134,11 @@ 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.
 
-An example complete *PXELinux global default* template for Discovery might look
-like this:
+## Updating the on-disk `default` file
 
-    DEFAULT menu
-    PROMPT 0
-    MENU TITLE PXE Menu
-    TIMEOUT 200
-    TOTALTIMEOUT 6000
-    ONTIMEOUT discovery
-
-    LABEL discovery
-    MENU LABEL Foreman Discovery
-    KERNEL boot/tftpboot/vmlinuz0
-    APPEND rootflags=loop initrd=boot/tftpboot/initrd0.img root=live:/foreman.iso rootfstype=auto ro rd.live.image rd.live.check rd.lvm=0 rootflags=ro crashkernel=128M elevator=deadline max_loop=256 rd.luks=0 rd.md=0 rd.dm=0 nomodeset selinux=0 stateless foreman.url=https://foreman.example.com
-    IPAPPEND 2
+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)
 
@@ -179,7 +148,7 @@ 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->Discovery Settings`
+`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
@@ -189,11 +158,11 @@ 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 `More->Provisioning->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.
+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.
@@ -217,15 +186,11 @@ If the booted machine fails to register with Foreman, then there are a number of
   * Check DNS is working for that image, or use an IP in `foreman.url`
   * Check DHCP is handing IPs to the booted image correctly
 
-When working with production images (no root password set), it is still
-possible to log on as root. Generate some root password:
+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:
 
-    $ openssl passwd -salt RH redhat
-    RHhwCLrQXB8zE
-
-And then provide it as an kernel command line option:
-
-    ... stateless rootpw=RHhwCLrQXB8zE
+    APPEND ... fdi.ssh=1 fdi.rootpw=redhat
 
 # API
 
@@ -242,18 +207,9 @@ If you only wish to test the plugin code itself, you don't need to create the PX
 image above, or have a TFTP server to run it from. Simply POST a hash of Host Facts to
 `/api/v2/discovered_hosts/facts` to create a Discovered Host in the UI.
 
-# TODO
-
-* Support for downloading shell script for oVirt Node image
-* Add more Tests
-* Add proper Location/Organization handling (via a Wizard maybe?)
-* Add per-subnet discovery
-* Rake Task for ISO build
-* Easy way to add custom facts to build/runtime
-
 # Copyright
 
-Copyright (c) 2012-2013 Greg Sutcliffe
+Copyright (c) 2012-2014 Greg Sutcliffe and The Foreman developers
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by

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

@@ -1,8 +1,9 @@
 module Api
   module V2
     class DiscoveredHostsController < ::Api::V2::BaseController
+      include Foreman::Controller::DiscoveredExtensions
 
-      before_filter :find_resource, :except => %w{index create facts}
+      before_filter :find_resource, :except => %w{index create facts auto_provision_all}
       skip_before_filter :authorize, :only => :facts
 
       resource_description do
@@ -80,7 +81,13 @@ module Api
         @host.managed = true
         @host.build   = true
         forward_request_url
-        process_response @host.update_attributes(params[:discovered_host])
+        update_response = @host.update_attributes(params[:discovered_host])
+        Host.transaction do
+          if update_response
+            delete_discovery_attribute_set(@host.id)
+          end
+        end
+        process_response update_response
       end
 
       api :DELETE, "/discovered_hosts/:id/", N_("Delete a discovered host")
@@ -94,12 +101,94 @@ module Api
       param :facts, Hash, :required => true, :desc => N_("hash containing facts for the host")
 
       def facts
-        @discovered_host, state = Host::Discovered.import_host_and_facts(params[:facts])
+        state = true
+        Host.transaction do
+          @discovered_host, state = Host::Discovered.import_host_and_facts(params[:facts])
+        end
+        @discovered_host.transaction do
+          if state && rule = find_discovery_rule(@discovered_host)
+            state = perform_auto_provision(@discovered_host, rule) if Setting['discovery_auto']
+          else
+            Rails.logger.warn "Discovered facts import unsuccessful, skipping auto provisioning" if Setting['discovery_auto']
+          end
+        end
         process_response state
       rescue ::Foreman::Exception => e
         render :json => {'message'=>e.to_s}, :status => :unprocessable_entity
       end
 
+      api :POST, "/discovered_hosts/:id/auto_provision", N_("Execute rules against a discovered host")
+      param :id, :identifier, :required => true
+
+      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]
+            process_response perform_auto_provision(@discovered_host, rule), msg
+          else
+            process_success _("No rule found for host %s") % @discovered_host.name
+          end
+        end
+      rescue ::Foreman::Exception => e
+        render :json => {'message' => e.to_s}, :status => :unprocessable_entity
+      end
+
+      api :POST, "/discovered_hosts/auto_provision_all", N_("Execute rules against all currently discovered hosts")
+
+      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|
+            if rule = find_discovery_rule(discovered_host)
+              result &= perform_auto_provision(discovered_host, rule)
+              unless discovered_host.errors.empty?
+                errors = discovered_host.errors.full_messages.join(' ')
+                logger.warn "Failed to auto provision host %s: %s" % [discovered_host.name, errors]
+                overall_errors << "#{discovered_host.name}: #{errors} "
+              end
+            else
+              logger.warn "No rule found for host %s" % discovered_host.name
+            end
+          end
+
+          if result
+            process_success _("Discovered hosts are provisioning now")
+          else
+            render_error :custom_error,
+              :status => :unprocessable_entity,
+              :locals => {
+                :message => error_message % overall_errors
+              }
+          end
+        end
+      end
+
+      api :PUT, "/discovered_hosts/:id/refresh_facts", N_("Refreshing the facts of a discovered host")
+      param :id, :identifier, :required => true
+
+      def refresh_facts
+        process_response @discovered_host.refresh_facts
+      rescue ::Foreman::Exception => e
+        render :json => { 'message' => e.to_s }
+      end
+
+      api :PUT, "/discovered_hosts/:id/reboot", N_("Rebooting a discovered host")
+      param :id, :identifier, :required => true
+
+      def reboot
+        process_response @discovered_host.reboot
+      rescue ::Foreman::Exception => e
+        render :json => {'message'=>e.to_s}
+      end
+
       private
 
       def resource_class
@@ -110,6 +199,18 @@ module Api
         @discovered_host.request_url = request.host_with_port if @discovered_host.respond_to?(:request_url)
       end
 
+      def action_permission
+        case params[:action]
+          when 'auto_provision'
+            :auto_provision
+          when 'auto_provision_all'
+            :auto_provision_all
+          when 'refresh_facts', 'reboot'
+            :edit
+          else
+            super
+        end
+      end
     end
   end
 end

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

@@ -0,0 +1,79 @@
+module Api
+  module V2
+    class DiscoveryRulesController < ::Api::V2::BaseController
+
+      before_filter :find_resource, :except => %w{index create facts}
+
+      resource_description do
+        resource_id 'discovery_rules'
+        api_version 'v2'
+        api_base_url "/api/v2"
+      end
+
+      api :GET, "/discovery_rules/", N_("List all discovery rules")
+      param :search, String, :desc => N_("filter results")
+      param :order, String, :desc => N_("sort results")
+      param :page, String, :desc => N_("paginate results")
+      param :per_page, String, :desc => N_("number of entries per request")
+
+      def index
+        @discovery_rules = resource_scope.search_for(*search_options).paginate(paginate_options)
+      end
+
+      api :GET, "/discovery_rules/:id/", N_("Show a discovery rule")
+      param :id, :identifier_dottable, :required => true
+
+      def show
+      end
+
+      def_param_group :discovery_rule do
+        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
+      end
+
+      api :POST, "/discovery_rules/", N_("Create a discovery rule")
+      param_group :discovery_rule, :as => :create
+
+      def create
+        @discovery_rule = DiscoveryRule.new(params[:discovery_rule])
+        process_response @discovery_rule.save
+      end
+
+      api :PUT, "/discovery_rules/:id/", N_("Update a rule")
+      param :id, :identifier, :required => true
+      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])
+      end
+
+      api :DELETE, "/discovery_rules/:id/", N_("Delete a rule")
+      param :id, :identifier, :required => true
+
+      def destroy
+        process_response @discovery_rule.destroy
+      end
+
+      private
+
+      def resource_class
+        DiscoveryRule
+      end
+    end
+  end
+end