foreman_bootdisk 1.0.0 → 1.1.0

data/CHANGES.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## v1.1.0
+* per-host USB image support using isohybrid
+* templates updated for multi-NIC support
+* Ruby 1.8.7 fixes
+
+## v1.0.0
+* initial release
+* per-host ISO image support

data/README.md

@@ -5,9 +5,9 @@ DHCP and TFTP services.  However many users don't have these available, so
 foreman_bootdisk provides both a per-host and generic boot disks to enable
 deployments in datacentres without these capabilities.
 
-Boot images can be written as ISO images or for USB disks (TODO), and booted
-either from physical media or virtual disk/CDROM (via a lights out management
-device).
+Boot images are written as hybrid ISO images (usable as ISOs or USB disks),
+and booted either from physical media or virtual disk/CDROM (via a lights out
+management device).
 
 # Installation
 
@@ -25,6 +25,7 @@ RPM users can install the "ruby193-rubygem-foreman_bootdisk" or
 
 * iPXE images are required
 * syslinux is required
+* mkisofs and isohybrid are required
 
 gPXE images are unsupported due to lack of initrd support, but the name will
 crop up as Foreman's script support is still named after the project.
@@ -49,11 +50,10 @@ The templates used on the boot disks themselves are read-only so they can be
 updated in new versions of the plugin.  To customise, copy the contents to a
 new template and set the name in More>Settings>Bootdisk.
 
-An OS gPXE provisioning template is required, e.g. "Kickstart default gPXE"
-(as supplied by Foreman).  Ensure the OSes are ticked under the Associations
-tab and that the gPXE template is selected under the Templates tab on the OS.
-
-TODO: missing Debian template, kickstart gPXE template assumes `net0`
+An OS gPXE provisioning template is required, preferably "Kickstart boot disk
+gPXE" (as supplied by this plugin).  Ensure the OSes are ticked under the
+Associations tab and that the gPXE template is selected under the Templates tab
+on the OS.
 
 Lastly, the OS provision template (i.e. kickstart/preseed) should provide the
 static IP details required to configure the OS.  For a kickstart file, the
@@ -61,6 +61,14 @@ 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
 
 Using the host and subnet data in Foreman, per-host images can be created with
@@ -68,15 +76,14 @@ 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, click the
-"Boot disk" button and select the image type from the menu.
+To generate the image from the web interface, view the host page and click the
+"Boot disk" button.
 
 To generate from the command line:
 
     foreman-rake bootdisk:generate:host NAME=foo.example.com
 
-Optionally set `TYPE=iso` or `TYPE=usb` to change the image type, or
-`OUTPUT=/path/foo.iso` to change the output destination.
+Optionally set `OUTPUT=/path/foo.iso` to change the output destination.
 
 ## Generic host group images
 
@@ -88,8 +95,6 @@ Report issues on the Redmine project: [foreman_bootdisk](http://projects.thefore
 
 ## Known issues
 
-* USB support not implemented
-* Templates only support first NIC
 * No Debian guidance or templates
 * No SELinux policy support
 

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

@@ -8,10 +8,7 @@ module Bootdisk::HostsHelperExt
   def host_title_actions_with_bootdisk(host, vm)
     title_actions(
       button_group(
-        select_action_button(_('Boot disk'),
-          display_link_if_authorized(_("ISO image"), hash_for_bootdisk_iso_host_path(:id => @host), :class=>'btn'),
-          display_link_if_authorized(_("USB image"), hash_for_bootdisk_iso_host_path(:id => @host), :class=>'btn'),
-        )
+        display_link_if_authorized(_("Boot disk"), hash_for_bootdisk_iso_host_path(:id => @host), :class=>'btn')
       )
     )
     host_title_actions_without_bootdisk(host, vm)

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

@@ -3,18 +3,21 @@
 module Bootdisk::ConfigTemplateExt
   extend ActiveSupport::Concern
 
+  BOOTDISK_TMPLS = ['Boot disk gPXE - host', 'Kickstart boot disk gPXE']
+
   included do
     before_destroy :bootdisk_destroy?
     validate :bootdisk_readonly
   end
 
   def bootdisk_destroy?
+    return true if ARGV.find { |a| a.start_with? "db:migrate" }
     bootdisk_readonly
     errors.empty?
   end
 
   def bootdisk_readonly
-    if ['Boot disk gPXE - host'].include? name_was
+    if BOOTDISK_TMPLS.include? name_was
       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/services/bootdisk/iso_generator.rb

@@ -1,6 +1,6 @@
-# Generates an iPXE ISO image
+# Generates an iPXE ISO hybrid image
 #
-# requires syslinux, ipxe/ipxe-bootimgs, mkisofs
+# requires syslinux, ipxe/ipxe-bootimgs, mkisofs, isohybrid
 class Bootdisk::ISOGenerator
   attr_reader :script
 
@@ -11,22 +11,29 @@ class Bootdisk::ISOGenerator
   def generate(&block)
     Dir.mktmpdir('bootdisk') do |wd|
       Dir.mkdir(File.join(wd, 'build'))
-      File.write(File.join(wd, 'build', 'isolinux.cfg'), <<EOF)
+      File.open(File.join(wd, 'build', 'isolinux.cfg'),'w') do |file|
+        file.write(<<EOF)
 default ipxe
 label ipxe
 kernel /ipxe
 initrd /script
 EOF
+      end
 
       FileUtils.cp(File.join(Setting[:bootdisk_syslinux_dir], 'isolinux.bin'), File.join(wd, 'build', 'isolinux.bin'))
       FileUtils.cp(File.join(Setting[:bootdisk_ipxe_dir], 'ipxe.lkrn'), File.join(wd, 'build', 'ipxe'))
-      File.write(File.join(wd, 'build', 'script'), script)
+      File.open(File.join(wd, 'build', 'script'),'w') { |file| file.write(script) }
 
       iso = File.join(wd, 'output.iso')
       unless system("mkisofs -o #{iso} -b isolinux.bin -c boot.cat -no-emul-boot -boot-load-size 4 -boot-info-table #{File.join(wd, 'build')}")
         raise ::Foreman::Exception.new(N_("ISO build failed"))
       end
 
+      # Make the ISO bootable as a HDD/USB disk too
+      unless system("isohybrid", iso)
+        raise ::Foreman::Exception.new(N_("ISO hybrid conversion failed"))
+      end
+
       yield iso
     end
   end

data/app/views/bootdisk/host_v1.erb

@@ -0,0 +1,21 @@
+#!ipxe
+# Example foreman_bootdisk host template
+# This template is rendered for use inside a host-specific boot disk.
+#
+# Copy this template to customize it, the original is read-only.
+
+# TODO: loop over net* until the host's MAC matches
+ifopen net0
+set net0/ip <%= @host.ip %>
+set net0/netmask <%= @host.subnet.mask %>
+set net0/gateway <%= @host.subnet.gateway %>
+route
+
+# Note, iPXE can only use one DNS server
+set dns <%= @host.subnet.dns_primary %> <%= @host.subnet.dns_secondary %>
+set net0/dns ${dns}
+set domain <%= @host.domain.to_s %>
+
+# Chainload from Foreman rather than embedding OS info here, so the behaviour
+# is entirely dynamic.
+chain <%= foreman_url("gPXE") %>

data/app/views/bootdisk/host_v2.erb

@@ -0,0 +1,38 @@
+#!ipxe
+# Example foreman_bootdisk host template
+# This template is rendered for use inside a host-specific boot disk.
+#
+# Copy this template to customize it, the original is read-only.
+
+# loop over net* until the host's MAC matches
+<% (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}
+iseq ${net<%= i -%>/mac} <%= @host.mac -%> || goto net<%= i+1 %>
+ifopen net<%= i %>
+set idx:int32 <%= i %>
+goto loop_success
+<% end -%>
+
+:loop_success
+echo Configuring net${idx} for static IP address
+ifopen net${idx}
+set netX/ip <%= @host.ip %>
+set netX/netmask <%= @host.subnet.mask %>
+set netX/gateway <%= @host.subnet.gateway %>
+route
+
+# Note, iPXE can only use one DNS server
+set dns <%= @host.subnet.dns_primary %> <%= @host.subnet.dns_secondary %>
+set domain <%= @host.domain.to_s %>
+
+# Chainload from Foreman rather than embedding OS info here, so the behaviour
+# is entirely dynamic.
+chain <%= foreman_url("gPXE") %>
+exit 0
+
+:no_nic
+echo Cannot find interface with MAC <%= @host.mac %>
+sleep 30
+exit 1

data/app/views/bootdisk/kickstart_v1.erb

@@ -0,0 +1,5 @@
+#!gpxe
+kernel <%= "#{@host.url_for_boot(:kernel)}" %> ks=<%= foreman_url("provision")%>?static=yes ksdevice=<%= @host.mac %> network kssendmac ip=${netX/ip} netmask=${netX/netmask} gateway=${netX/gateway} dns=${dns}
+initrd <%= "#{@host.url_for_boot(:initrd)}" %>
+
+boot

data/db/migrate/20130914211030_create_host_bootdisk_template.rb

@@ -3,29 +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),
-      :template => <<EOS
-#!ipxe
-# Example foreman_bootdisk host template
-# This template is rendered for use inside a host-specific boot disk.
-#
-# Copy this template to customize it, the original is read-only.
-
-# TODO: loop over net* until the host's MAC matches
-ifopen net0
-set net0/ip <%= @host.ip %>
-set net0/netmask <%= @host.subnet.mask %>
-set net0/gateway <%= @host.subnet.gateway %>
-route
-
-# Note, iPXE can only use one DNS server
-set dns <%= @host.subnet.dns_primary %> <%= @host.subnet.dns_secondary %>
-set net0/dns ${dns}
-set domain <%= @host.domain.to_s %>
-
-# Chainload from Foreman rather than embedding OS info here, so the behaviour
-# is entirely dynamic.
-chain <%= foreman_url("gPXE") %>
-EOS
+      :template => File.read(File.join(Bootdisk::Engine.root, 'app', 'views', 'bootdisk', 'host_v1.erb'))
     )
   end
   

data/db/migrate/20130915104500_edit_host_bootdisk_template_multinic.rb

@@ -0,0 +1,11 @@
+class EditHostBootdiskTemplateMultinic < ActiveRecord::Migration
+  def self.up
+    ConfigTemplate.find_by_name('Boot disk gPXE - host').update_attribute(
+      :template, File.read(File.join(Bootdisk::Engine.root, 'app', 'views', 'bootdisk', 'host_v2.erb')))
+  end
+
+  def self.down
+    ConfigTemplate.find_by_name('Boot disk gPXE - host').update_attribute(
+      :template, File.read(File.join(Bootdisk::Engine.root, 'app', 'views', 'bootdisk', 'host_v1.erb')))
+  end
+end

data/db/migrate/20130915133321_create_kickstart_bootdisk_template.rb

@@ -0,0 +1,13 @@
+class CreateKickstartBootdiskTemplate < ActiveRecord::Migration
+  def self.up
+    ConfigTemplate.find_or_create_by_name(
+      :name => 'Kickstart boot disk gPXE',
+      :template_kind_id => TemplateKind.find_by_name('gPXE').try(:id),
+      :template => File.read(File.join(Bootdisk::Engine.root, 'app', 'views', 'bootdisk', 'kickstart_v1.erb'))
+    )
+  end
+
+  def self.down
+    ConfigTemplate.destroy_all(:name => 'Kickstart boot disk gPXE')
+  end
+end

data/lib/foreman_bootdisk.rb

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

data/lib/tasks/bootdisk.rake

@@ -1,15 +1,11 @@
 namespace :bootdisk do
   namespace :generate do
-    desc 'Generate a static boot disk for a specific host.  NAME=fqdn, TYPE=iso (default) or usb, OUTPUT path'
+    desc 'Generate a static boot disk for a specific host.  NAME=fqdn, OUTPUT path'
     task :host => :environment do
       host = Host::Base.find_by_name(ENV['NAME']) || raise("cannot find host '#{ENV['NAME']}', specify NAME=fqdn")
       tmpl = host.bootdisk_template_render
 
-      type = (ENV['TYPE'] || 'iso').downcase
-      case type
-        when 'usb'; Bootdisk::USBGenerator
-        else; Bootdisk::ISOGenerator
-      end.new(tmpl).generate do |image|
+      Bootdisk::ISOGenerator.new(tmpl).generate do |image|
         output = ENV['OUTPUT'] || "#{host.name}.#{type}"
         FileUtils.cp image, output
         puts "Wrote #{output}"

metadata

@@ -1,24 +1,35 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: foreman_bootdisk
-version: !ruby/object:Gem::Version
-  version: 1.0.0
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: 
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
 platform: ruby
-authors:
+authors: 
 - Dominic Cleal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-29 00:00:00.000000000 Z
+
+date: 2013-09-15 00:00:00 Z
 dependencies: []
-description: Plugin for Foreman that creates iPXE-based boot disks to provision hosts
-  without the need for PXE infrastructure.
+
+description: Plugin for Foreman that creates iPXE-based boot disks to provision hosts without the need for PXE infrastructure.
 email: dcleal@redhat.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
+- CHANGES.md
 - LICENSE
 - README.md
-files:
+files: 
+- CHANGES.md
 - LICENSE
 - README.md
 - app/controllers/concerns/bootdisk/hosts_controller_ext.rb
@@ -27,33 +38,48 @@ files:
 - app/models/concerns/bootdisk/host_ext.rb
 - app/models/setting/bootdisk.rb
 - app/services/bootdisk/iso_generator.rb
+- app/views/bootdisk/host_v1.erb
+- app/views/bootdisk/host_v2.erb
+- app/views/bootdisk/kickstart_v1.erb
 - config/routes.rb
 - 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
 - lib/bootdisk/engine.rb
 - lib/foreman_bootdisk.rb
 - lib/tasks/bootdisk.rake
 homepage: http://github.com/theforeman/foreman_bootdisk
-licenses:
+licenses: 
 - GPL-3
-metadata: {}
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Create boot disks to provision hosts with Foreman
 test_files: []
+

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: b3533e45d6b16fee4d6c491d48539d5363cf856e
-  data.tar.gz: c60a73d067c98d1ad7fdcebe0b858513ac2c48f9
-SHA512:
-  metadata.gz: ca8ceaa8d47f2ffe6ebae5c77debca1c02cd23d30cb6803c764691994a77ee4778da498c566605965ec5e4e01e394e75e7dec68b635f768988946b658c7a89dc
-  data.tar.gz: 5e70814bcbdea0e5e10a3eee1c050a07c75e159bd101d3ab251307f25980dd175dcfdb772797c57241c46342fe9eff6a5ff31a672ded3fe2a5cf3eaf4aa0de49