foreman_bootdisk 1.2.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13d3ce70b8db0edb1ad13bf4d77184d885387b35
-  data.tar.gz: f3ec510df62e22c6013f89230e50b0cdb7ded5d8
+  metadata.gz: efc889edd64e77c31e018006515a86f9cdd68b58
+  data.tar.gz: 48185eb7638eab87a12853792dd2fc226e6adcb0
 SHA512:
-  metadata.gz: 7d72166081888de72ca236bfa1e953a25fb2ac94bb237492d76c70033c5df9b33a506d22bfbc8ea821854f51af4166ee76d38ea38cb9056e1fef3a1cf800f663
-  data.tar.gz: d090d45ff219fec5c560edb908ffcbc3c80aa09361e97bfadeff1a743ffcc7e25cfc69f3bc45158eb78a1f3cad453c1a31512beaedbf8deb7ea3e77cb3b3a7eb
+  metadata.gz: 1341fd44db6ff7d68060bd6129eef80fb50d4e530ba730f93d14c7cf3dcb05e5686b6485605fef25df036e41ffe30bb73253cd6c90dd2db53df8b5edc7d42852
+  data.tar.gz: 9abfa6c19bdc36bdc67c865a6867be88c2b8a625948ed6948db977e1cb832bc1d5efee537c64077775a0ba4fbf870d2f341df72799852ad4cb6ce8467e9d1650

data/CHANGES.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v2.0.0
+* compatible with Foreman 1.4 (only), uses new plugin registration system
+* add validation of host and subnet data to host template
+* remove kickstart iPXE, use the one supplied in Foreman 1.4
+
 ## v1.2.3
 * remove secondary DNS server from iPXE template (#3558)
 

data/README.md

@@ -27,14 +27,20 @@ RPM users can install the "ruby193-rubygem-foreman_bootdisk" or
 * 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.
+gPXE images are unsupported due to lack of initrd support.
+
+## Compatibility
+
+| Foreman Version | Plugin Version |
+| --------------- | --------------:|
+| <= 1.3          | ~> 1.0         |
+| >= 1.4          | ~> 2.0         |
 
 # Usage
 
 ## Configuration
 
-Some configuration is set under More>Settings>Bootdisk in the Foreman UI.
+Some configuration is set under Administer>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
@@ -43,7 +49,7 @@ Some configuration is set under More>Settings>Bootdisk in the Foreman UI.
 
 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
-under More>Provisioning>Subnets in Foreman.
+under Infrastructure>Subnets in Foreman.
 
 To permit access to images for non-admin users, add the "Boot disk access" role
 to a user or the "download_bootdisk" permission to an existing role.
@@ -52,12 +58,11 @@ to a user or the "download_bootdisk" permission to an existing role.
 
 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.
+new template and set the name in Administer>Settings>Bootdisk.
 
-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.
+An OS iPXE provisioning template is required, preferably "Kickstart default
+iPXE".  Ensure the OSes are ticked under the Associations tab and that the
+iPXE 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
@@ -65,6 +70,8 @@ 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 %>
 
+Foreman's default kickstart file is ready to use.
+
 ## Available images
 
 The image types have trade-offs, but are all meant for environments without
@@ -119,7 +126,7 @@ 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
+the OS iPXE 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

data/app/controllers/bootdisk/disks_controller.rb

@@ -1,7 +1,15 @@
 module Bootdisk
   class DisksController < ::ApplicationController
     def generic_iso
-      Bootdisk::ISOGenerator.new(Bootdisk::Renderer.new.generic_template_render).generate do |iso|
+      begin
+        tmpl = Bootdisk::Renderer.new.generic_template_render
+      rescue => e
+        error _('Failed to render boot disk template: %s') % e
+        redirect_to :back
+        return
+      end
+
+      Bootdisk::ISOGenerator.new(tmpl).generate do |iso|
         send_data File.read(iso), :filename => "bootdisk_#{Setting[:foreman_url]}.iso"
       end
     end

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

@@ -7,7 +7,15 @@ module Bootdisk::HostsControllerExt
   end
 
   def bootdisk_iso
-    Bootdisk::ISOGenerator.new(@host.bootdisk_template_render).generate do |iso|
+    begin
+      tmpl = @host.bootdisk_template_render
+    rescue => e
+      error _('Failed to render boot disk template: %s') % e
+      redirect_to :back
+      return
+    end
+
+    Bootdisk::ISOGenerator.new(tmpl).generate do |iso|
       send_data File.read(iso), :filename => "#{@host.name}.iso"
     end
   end

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

@@ -8,7 +8,7 @@ module Bootdisk::HostsHelperExt
   def host_title_actions_with_bootdisk(host, vm)
     title_actions(
       button_group(
-        select_action_button(_('Boot disk'),
+        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')
         )

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

@@ -3,7 +3,7 @@
 module Bootdisk::ConfigTemplateExt
   extend ActiveSupport::Concern
 
-  BOOTDISK_TMPLS = ['Boot disk gPXE - host', 'Kickstart boot disk gPXE']
+  BOOTDISK_TMPLS = ['Boot disk iPXE - host', 'Kickstart boot disk iPXE']
 
   included do
     before_destroy :bootdisk_destroy?

data/app/models/setting/bootdisk.rb

@@ -10,8 +10,8 @@ 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'),
+        self.set('bootdisk_host_template', _('iPXE template to use for host-specific boot disks'), 'Boot disk iPXE - host'),
+        self.set('bootdisk_generic_host_template', _('iPXE template to use for generic host boot disks'), 'Boot disk iPXE - generic host'),
       ].compact.each { |s| self.create s.update(:category => "Setting::Bootdisk") }
     end
 

data/app/views/bootdisk/{generic_host_v1.erb → generic_host.erb}

@@ -15,7 +15,7 @@
 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 %>
+chain <%= (u = URI.parse(foreman_url("iPXE")); u.query = "#{u.query}&mac="; u.to_s) %>${net<%= i -%>/mac} || goto net<%= i+1 %>
 exit 0
 <% end -%>
 

data/app/views/bootdisk/{host_v3.erb → host.erb}

@@ -4,6 +4,14 @@
 #
 # Copy this template to customize it, the original is read-only.
 
+<%
+raise ::Foreman::Exception.new(N_('Host has no IP address defined')) if @host.ip.empty?
+raise ::Foreman::Exception.new(N_('Host has no subnet defined')) if @host.subnet.nil?
+raise ::Foreman::Exception.new(N_('Host has no domain defined')) if @host.domain.nil?
+raise ::Foreman::Exception.new(N_('Subnet (%s) has no gateway defined'), @host.subnet) if @host.subnet.gateway.empty?
+raise ::Foreman::Exception.new(N_('Subnet (%s) has no primary DNS server defined'), @host.subnet) if @host.subnet.dns_primary.empty?
+%>
+
 # loop over net* until the host's MAC matches
 <% (0..32).each do |i| -%>
 :net<%= i %>
@@ -29,7 +37,7 @@ 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") %>
+chain <%= foreman_url("iPXE") %>
 exit 0
 
 :no_nic

data/db/migrate/20130914211030_create_host_bootdisk_template.rb

@@ -1,14 +1,7 @@
 class CreateHostBootdiskTemplate < ActiveRecord::Migration
   def self.up
-    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
-  
+
   def self.down
-    ConfigTemplate.destroy_all(:name => 'Boot disk gPXE - host')
   end
 end

data/db/migrate/20130915104500_edit_host_bootdisk_template_multinic.rb

@@ -1,11 +1,7 @@
 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

@@ -1,14 +1,7 @@
 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),
-      :snippet => false,
-      :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/db/migrate/20130915201457_create_generic_host_bootdisk_template.rb

@@ -1,14 +1,7 @@
 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/db/migrate/20131021095100_edit_host_bootdisk_template_dns_secondary.rb

@@ -1,11 +1,7 @@
 class EditHostBootdiskTemplateDnsSecondary < 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_v3.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_v2.erb')))
   end
 end

data/db/seeds.rb

@@ -0,0 +1,22 @@
+def format_errors(model = nil)
+  return '(nil found)' if model.nil?
+  model.errors.full_messages.join(';')
+end
+
+ConfigTemplate.without_auditing do
+  content = File.read(File.join(Bootdisk::Engine.root, 'app', 'views', 'bootdisk', 'host.erb'))
+  ConfigTemplate.find_or_create_by_name(
+    :name => 'Boot disk iPXE - host',
+    :template_kind_id => TemplateKind.find_by_name('iPXE').try(:id),
+    :snippet => false,
+    :template => content
+  ).update_attribute(:template, content)
+
+  content = File.read(File.join(Bootdisk::Engine.root, 'app', 'views', 'bootdisk', 'generic_host.erb'))
+  ConfigTemplate.find_or_create_by_name(
+    :name => 'Boot disk iPXE - generic host',
+    :template_kind_id => TemplateKind.find_by_name('iPXE').try(:id),
+    :snippet => false,
+    :template => content
+  ).update_attribute(:template, content)
+end

data/lib/bootdisk/engine.rb

@@ -16,6 +16,19 @@ module Bootdisk
       app.config.paths['db/migrate'] += Bootdisk::Engine.paths['db/migrate'].existent
     end
 
+    initializer 'my_plugin.register_plugin', :after=> :finisher_hook do |app|
+      Foreman::Plugin.register :foreman_bootdisk do
+        requires_foreman '>= 1.4'
+
+        security_block :bootdisk do |map|
+          permission :download_bootdisk, {:hosts => [:bootdisk_iso],
+                                          :'bootdisk/disks' => [:generic_iso, :index]}
+        end
+
+        role "Boot disk access", [:download_bootdisk] unless (Role.count rescue nil).nil?
+      end
+    end
+
     config.to_prepare do
       begin
         ConfigTemplate.send(:include, Bootdisk::ConfigTemplateExt)
@@ -27,5 +40,11 @@ module Bootdisk
         puts "#{Bootdisk::ENGINE_NAME}: skipping engine hook (#{e.to_s})"
       end
     end
+
+    rake_tasks do
+      Rake::Task['db:seed'].enhance do
+        Bootdisk::Engine.load_seed
+      end
+    end
   end
 end

data/lib/bootdisk/version.rb

@@ -1,3 +1,3 @@
 module Bootdisk
-  VERSION = '1.2.3'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_bootdisk
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Dominic Cleal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-01 00:00:00.000000000 Z
+date: 2014-01-22 00:00:00.000000000 Z
 dependencies: []
 description: Plugin for Foreman that creates iPXE-based boot disks to provision hosts
   without the need for PXE infrastructure.
@@ -32,18 +32,15 @@ files:
 - 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/host_v3.erb
-- app/views/bootdisk/kickstart_v1.erb
-- config/initializers/bootdisk_permissions.rb
+- app/views/bootdisk/generic_host.erb
+- app/views/bootdisk/host.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
 - db/migrate/20130915201457_create_generic_host_bootdisk_template.rb
 - db/migrate/20131021095100_edit_host_bootdisk_template_dns_secondary.rb
+- db/seeds.rb
 - lib/bootdisk/engine.rb
 - lib/bootdisk/version.rb
 - lib/foreman_bootdisk.rb
@@ -68,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.8
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Create boot disks to provision hosts with Foreman

data/app/views/bootdisk/host_v1.erb

@@ -1,21 +0,0 @@
-#!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

@@ -1,38 +0,0 @@
-#!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

@@ -1,5 +0,0 @@
-#!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/config/initializers/bootdisk_permissions.rb

@@ -1,16 +0,0 @@
-# Add permissions
-Foreman::AccessControl.map do |map|
-  map.security_block :bootdisk do |map|
-    map.permission :download_bootdisk, {:hosts => [:bootdisk_iso],
-                                        :'bootdisk/disks' => [:generic_iso, :index]}
-  end
-end
-
-begin
-  # Add a new role called 'Boot disk access' if it doesn't exist
-  Role.transaction do
-    role = Role.find_or_create_by_name("Boot disk access")
-    role.update_attribute :permissions, [:download_bootdisk] if role.permissions.empty?
-  end
-rescue
-end