foreman_bootdisk 1.1.0 → 1.2.0

data/CHANGES.md

@@ -1,6 +1,10 @@
 # Changelog
 
-## v1.1.0
+## v1.2.0
+* add generic image, relying on DHCP and a MAC/IP search
+* fix inability to associate provided templates with OSes
+
+# v1.1.0
 * per-host USB image support using isohybrid
 * templates updated for multi-NIC support
 * Ruby 1.8.7 fixes

data/README.md

@@ -39,6 +39,7 @@ Some configuration is set under More>Settings>Bootdisk in the Foreman UI.
 * `bootdisk_ipxe_dir` points to the directory containing ipxe.lkrn
 * `bootdisk_syslinux_dir` points to the directory containing syslinux images
 * `bootdisk_host_template` is the name of the per-host boot disk template
+* `bootdisk_generic_host_template` is the name of the generic boot disk template
 
 For per-host images, ensure host IP addresses and subnets are populated, and
 the subnet's gateway, subnet mask and DNS resolver(s) are correctly configured
@@ -61,23 +62,45 @@ following configuration will do this:
 
     network --bootproto <%= @static ? "static" : "dhcp" %> --hostname <%= @host %> <%= "--ip=#{@host.ip} --netmask=#{@host.subnet.mask} --gateway=#{@host.subnet.gateway} --nameserver=#{@host.subnet.dns_primary},#{@host.subnet.dns_secondary}" if @static %>
 
-## USB images
-
-The ISO images generated are run through `isohybrid` which makes them bootable
-as disks too, suitable for copying to a USB device.
-
-Use `dd if=fqdn.iso of=/dev/sdb` or similar to copy the image to a USB disk.
-Ensure the device name is correct to avoid writing over the wrong disk.
-
-## Per-host images
+## Available images
+
+The image types have trade-offs, but are all meant for environments without
+total control over the network infrastructure - so no DHCP reservations or
+TFTP settings are needed.
+
+<table>
+  <tr>
+    <th>Type</th>
+    <th>Generic</th>
+    <th>DHCP required</th>
+    <th>DHCP reservation</th>
+    <th>Pre-register host</th>
+  </tr>
+  <tr>
+    <td>Per-host image</td>
+    <td>No</td>
+    <td>No</td>
+    <td>No</td>
+    <td>Yes</td>
+  </tr>
+  <tr>
+    <td>Generic image</td>
+    <td>Yes</td>
+    <td>Yes</td>
+    <td>No</td>
+    <td>Yes</td>
+  </tr>
+</table>
+
+### Per-host images
 
 Using the host and subnet data in Foreman, per-host images can be created with
 fully static networking.  The behaviour is dynamic, as the image chainloads
 from Foreman, so the current OS and build state will be provided by Foreman
 instead of being stored in the image.
 
-To generate the image from the web interface, view the host page and click the
-"Boot disk" button.
+To generate the image from the web interface, view the host page, click the
+"Boot disk" button and select "Host 'FQDN' image".
 
 To generate from the command line:
 
@@ -85,10 +108,38 @@ To generate from the command line:
 
 Optionally set `OUTPUT=/path/foo.iso` to change the output destination.
 
-## Generic host group images
+### Generic image
+
+This provides a single ISO that can be used by all hosts, but since IP details
+can't be stored inside, it requires a DHCP pool on the network to bootstrap.
+It will boot and contact Foreman for template of a registered host matching a
+MAC address or the IP the host was assigned by DHCP.
+
+The installation can continue on either the DHCP or static IP depending on how
+the OS gPXE template is configured, and could configure the assigned IP
+address statically for the installed system via the kickstart file.
+
+To generate the image from the web interface, view a host page, click the
+"Boot disk" button and select "Generic image".
+
+To generate from the command line:
+
+    foreman-rake bootdisk:generate:generic
+
+Optionally set `OUTPUT=/path/foo.iso` to change the output destination.
+
+### Host group images
 
 TODO
 
+### USB images
+
+The ISO images generated are run through `isohybrid` which makes them bootable
+as disks too, suitable for copying to a USB device.
+
+Use `dd if=fqdn.iso of=/dev/sdb` or similar to copy the image to a USB disk.
+Ensure the device name is correct to avoid writing over the wrong disk.
+
 # Issues
 
 Report issues on the Redmine project: [foreman_bootdisk](http://projects.theforeman.org/projects/bootdisk/issues/new)

data/app/controllers/bootdisk/disks_controller.rb

@@ -0,0 +1,9 @@
+module Bootdisk
+  class DisksController < ::ApplicationController
+    def generic_iso
+      Bootdisk::ISOGenerator.new(Bootdisk::Renderer.new.generic_template_render).generate do |iso|
+        send_data File.read(iso), :filename => "bootdisk_#{Setting[:foreman_url]}.iso"
+      end
+    end
+  end
+end

data/app/controllers/concerns/bootdisk/unattended_controller_ext.rb

@@ -0,0 +1,12 @@
+module Bootdisk::UnattendedControllerExt
+  extend ActiveSupport::Concern
+
+  included do
+    alias_method_chain :find_host_by_ip_or_mac, :param_mac
+  end
+
+  def find_host_by_ip_or_mac_with_param_mac
+    request.env['HTTP_X_RHN_PROVISIONING_MAC_0'] = "unknown #{params['mac']}" unless request.env.has_key?('HTTP_X_RHN_PROVISIONING_MAC_0')
+    find_host_by_ip_or_mac_without_param_mac
+  end
+end

data/app/helpers/concerns/bootdisk/hosts_helper_ext.rb

@@ -8,7 +8,10 @@ module Bootdisk::HostsHelperExt
   def host_title_actions_with_bootdisk(host, vm)
     title_actions(
       button_group(
-        display_link_if_authorized(_("Boot disk"), hash_for_bootdisk_iso_host_path(:id => @host), :class=>'btn')
+        select_action_button(_('Boot disk'),
+          display_link_if_authorized(_("Host '%s' image") % @host.name.split('.')[0], hash_for_bootdisk_iso_host_path(:id => @host), :class=>'btn'),
+          display_link_if_authorized(_("Generic image"), hash_for_generic_iso_disks_path, :class=>'btn')
+        )
       )
     )
     host_title_actions_without_bootdisk(host, vm)

data/app/models/concerns/bootdisk/config_template_ext.rb

@@ -17,7 +17,19 @@ module Bootdisk::ConfigTemplateExt
   end
 
   def bootdisk_readonly
-    if BOOTDISK_TMPLS.include? name_was
+    c = changes
+
+    # ignore CRLF changes
+    if c['template'] && (c['template'][0].nil? || c['template'][0].gsub("\n", "\r\n") == c['template'][1])
+      c.delete 'template'
+    end
+
+    # ignore nil to false changes
+    c.delete 'snippet' if c['snippet'] == [nil, false]
+
+    # allow the user to associate it, just not change the content
+    other_attrs = c.keys.find { |f| !['template_combinations', 'template_associations'].include? f }
+    if BOOTDISK_TMPLS.include?(name_was) && other_attrs
       errors.add(:base, _("Template is read-only as it's supplied in foreman_bootdisk.  Please copy it to a new template to customize."))
     end
   end

data/app/models/setting/bootdisk.rb

@@ -11,6 +11,7 @@ class Setting::Bootdisk< ::Setting
         self.set('bootdisk_ipxe_dir', _('Path to directory containing iPXE images'), ipxe),
         self.set('bootdisk_syslinux_dir', _('Path to directory containing syslinux images'), syslinux),
         self.set('bootdisk_host_template', _('gPXE template to use for host-specific boot disks'), 'Boot disk gPXE - host'),
+        self.set('bootdisk_generic_host_template', _('gPXE template to use for generic host boot disks'), 'Boot disk gPXE - generic host'),
       ].compact.each { |s| self.create s.update(:category => "Setting::Bootdisk") }
     end
 

data/app/services/bootdisk/renderer.rb

@@ -0,0 +1,12 @@
+module Bootdisk
+  class Renderer
+    include ::Foreman::Renderer
+    include Rails.application.routes.url_helpers
+
+    def generic_template_render
+      tmpl = ConfigTemplate.find_by_name(Setting[:bootdisk_generic_host_template]) || raise(::Foreman::Exception.new(N_('Unable to find template specified by %s setting'), 'bootdisk_generic_host_template'))
+      @host = Struct.new(:token).new(nil)
+      unattended_render(tmpl.template)
+    end
+  end
+end

data/app/views/bootdisk/generic_host_v1.erb

@@ -0,0 +1,25 @@
+#!ipxe
+# Example foreman_bootdisk generic host template
+#
+# This template is generic, but it will chainload to Foreman so expects the
+# host to be registered already.
+#
+# It loops through all interfaces using DHCP, requesting a template from
+# Foreman in the hope that one of the MACs or IPs matches.
+#
+# Copy this template to customize it, the original is read-only.
+
+# loop over net* until we can get a template
+<% (0..32).each do |i| -%>
+:net<%= i %>
+isset ${net<%= i -%>/mac} || goto no_nic
+echo net<%= i -%> is a ${net<%= i -%>/chip} with MAC ${net<%= i -%>/mac}
+dhcp net<%= i %> || goto net<%= i+1 %>
+chain <%= (u = URI.parse(foreman_url("gPXE")); u.query = "#{u.query}&mac="; u.to_s) %>${net<%= i -%>/mac} || goto net<%= i+1 %>
+exit 0
+<% end -%>
+
+:no_nic
+echo Failed to chainload from any network interface
+sleep 30
+exit 1

data/config/routes.rb

@@ -1,4 +1,8 @@
-Foreman::Application.routes.draw do
+Rails.application.routes.draw do
+  resources :disks, :module => 'bootdisk', :only => :index do
+    get 'generic_iso', :on => :collection
+  end
+
   constraints(:id => /[^\/]+/) do
     resources :hosts do
       member do

data/db/migrate/20130914211030_create_host_bootdisk_template.rb

@@ -3,6 +3,7 @@ class CreateHostBootdiskTemplate < ActiveRecord::Migration
     ConfigTemplate.find_or_create_by_name(
       :name => 'Boot disk gPXE - host',
       :template_kind_id => TemplateKind.find_by_name('gPXE').try(:id),
+      :snippet => false,
       :template => File.read(File.join(Bootdisk::Engine.root, 'app', 'views', 'bootdisk', 'host_v1.erb'))
     )
   end

data/db/migrate/20130915133321_create_kickstart_bootdisk_template.rb

@@ -3,6 +3,7 @@ class CreateKickstartBootdiskTemplate < ActiveRecord::Migration
     ConfigTemplate.find_or_create_by_name(
       :name => 'Kickstart boot disk gPXE',
       :template_kind_id => TemplateKind.find_by_name('gPXE').try(:id),
+      :snippet => false,
       :template => File.read(File.join(Bootdisk::Engine.root, 'app', 'views', 'bootdisk', 'kickstart_v1.erb'))
     )
   end

data/db/migrate/20130915201457_create_generic_host_bootdisk_template.rb

@@ -0,0 +1,14 @@
+class CreateGenericHostBootdiskTemplate < ActiveRecord::Migration
+  def self.up
+    ConfigTemplate.find_or_create_by_name(
+      :name => 'Boot disk gPXE - generic host',
+      :template_kind_id => TemplateKind.find_by_name('gPXE').try(:id),
+      :snippet => false,
+      :template => File.read(File.join(Bootdisk::Engine.root, 'app', 'views', 'bootdisk', 'generic_host_v1.erb'))
+    )
+  end
+  
+  def self.down
+    ConfigTemplate.destroy_all(:name => 'Boot disk gPXE - generic host')
+  end
+end

data/lib/bootdisk/engine.rb

@@ -2,6 +2,8 @@ require 'foreman_bootdisk'
 
 module Bootdisk
   class Engine < ::Rails::Engine
+    engine_name Bootdisk::ENGINE_NAME
+
     config.autoload_paths += Dir["#{config.root}/app/controllers/concerns"]
     config.autoload_paths += Dir["#{config.root}/app/helpers/concerns"]
     config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
@@ -19,6 +21,7 @@ module Bootdisk
       Host::Managed.send(:include, Bootdisk::HostExt)
       HostsController.send(:include, Bootdisk::HostsControllerExt)
       HostsHelper.send(:include, Bootdisk::HostsHelperExt)
+      UnattendedController.send(:include, Bootdisk::UnattendedControllerExt)
     end
   end
 end

data/lib/bootdisk/version.rb

@@ -0,0 +1,3 @@
+module Bootdisk
+  VERSION = '1.2.0'
+end

data/lib/foreman_bootdisk.rb

@@ -1,6 +1,7 @@
+require 'bootdisk/version'
+
 module Bootdisk
   ENGINE_NAME = 'bootdisk'
-  VERSION = '1.1.0'
 
   require 'bootdisk/engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
 end

data/lib/tasks/bootdisk.rake

@@ -6,7 +6,18 @@ namespace :bootdisk do
       tmpl = host.bootdisk_template_render
 
       Bootdisk::ISOGenerator.new(tmpl).generate do |image|
-        output = ENV['OUTPUT'] || "#{host.name}.#{type}"
+        output = ENV['OUTPUT'] || "#{host.name}.iso"
+        FileUtils.cp image, output
+        puts "Wrote #{output}"
+      end
+    end
+
+    desc 'Generate a generic boot disk.  OUTPUT=path'
+    task :generic => :environment do
+      tmpl = Bootdisk::Renderer.new.generic_template_render
+
+      Bootdisk::ISOGenerator.new(tmpl).generate do |image|
+        output = ENV['OUTPUT'] || "bootdisk_#{Setting[:foreman_url]}.iso"
         FileUtils.cp image, output
         puts "Wrote #{output}"
       end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: foreman_bootdisk
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 31
   prerelease: 
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Dominic Cleal
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-09-15 00:00:00 Z
+date: 2013-09-17 00:00:00 Z
 dependencies: []
 
 description: Plugin for Foreman that creates iPXE-based boot disks to provision hosts without the need for PXE infrastructure.
@@ -32,12 +32,16 @@ files:
 - CHANGES.md
 - LICENSE
 - README.md
+- app/controllers/bootdisk/disks_controller.rb
 - app/controllers/concerns/bootdisk/hosts_controller_ext.rb
+- app/controllers/concerns/bootdisk/unattended_controller_ext.rb
 - app/helpers/concerns/bootdisk/hosts_helper_ext.rb
 - app/models/concerns/bootdisk/config_template_ext.rb
 - app/models/concerns/bootdisk/host_ext.rb
 - app/models/setting/bootdisk.rb
 - app/services/bootdisk/iso_generator.rb
+- app/services/bootdisk/renderer.rb
+- app/views/bootdisk/generic_host_v1.erb
 - app/views/bootdisk/host_v1.erb
 - app/views/bootdisk/host_v2.erb
 - app/views/bootdisk/kickstart_v1.erb
@@ -45,7 +49,9 @@ files:
 - db/migrate/20130914211030_create_host_bootdisk_template.rb
 - db/migrate/20130915104500_edit_host_bootdisk_template_multinic.rb
 - db/migrate/20130915133321_create_kickstart_bootdisk_template.rb
+- db/migrate/20130915201457_create_generic_host_bootdisk_template.rb
 - lib/bootdisk/engine.rb
+- lib/bootdisk/version.rb
 - lib/foreman_bootdisk.rb
 - lib/tasks/bootdisk.rake
 homepage: http://github.com/theforeman/foreman_bootdisk