foreman_bootdisk 6.0.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffdf260d555ad64c9c24397f293902ab11750afe
-  data.tar.gz: 737a352d301347d4cf8a7549822e7e1b0cb5ae95
+  metadata.gz: a8a61c973be01e36e750806d001adeb4787dd22c
+  data.tar.gz: 759b57674e0090025cbbf30bbae4b31a3ff9a994
 SHA512:
-  metadata.gz: 51d13826e62222446b190c2d031f24a9cbd360f8e3e8f7aab0024b2b392edafd1b56a01c6f000594581cef58c8e8fed27e529fdb434ca737f5d91c5afc7e01e0
-  data.tar.gz: d3c6946fe6fbdede2d47edeb0844dbbc3625bf46ad1e7dfdf07e4aa695967de44d70aef37dc8ad7f1dfbe635fdfb4ffc5a7eb1ed00b3f6481940316349db222d
+  metadata.gz: 0e1f1a9790e67338e9e846f075da4ad20da44c8d659c15a973712d5f020c3f40fe40225593339c2b704bec1c956179eb316039b11e462433ed449eef3d649054
+  data.tar.gz: 76bcadb8a821cd544a2d912058e6c72e920134b01f5e216cb1ed6a638ed08a14e6e85413d622302b9f41aede0e18bedfbf42462cdaeef43011707d1cda7e9656

data/CHANGES.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v6.1.0
+* add subnet-level generic image relying on template smart proxy (#8146)
+* add Catalan translation
+* fix compatibility with Rails 4 for Foreman 1.11
+
 ## v6.0.0
 * compatibility with Foreman 1.9 template changes (#10773)
 * generate correct links under sub-URI (#10494)

data/README.md

@@ -123,6 +123,14 @@ TFTP settings are needed.
     <td>Yes</td>
     <td>No</td>
   </tr>
+  <tr>
+    <td>Subnet image</td>
+    <td>Yes</td>
+    <td>Yes</td>
+    <td>No</td>
+    <td>Yes</td>
+    <td>No</td>
+  </tr>
 </table>
 
 ### Per-host images
@@ -154,8 +162,9 @@ It must be writable by the 'foreman' user.
 A variant of the per-host image, this version doesn't chainload from Foreman,
 but contains the initial OS bootloader.  It can be useful for hosts that fail
 to chainload correctly, but has the downsides that it may become out of date
-if the host OS, bootloader or templates change, or build tokens are required
-and expire.
+if the host OS, bootloader or PXELinux templates change, or build tokens are
+required and expire.  The provisioning template is still fetched from the
+Foreman server.
 
 To generate the image from the web interface, view the host page, click the
 "Boot disk" button and select "Full host 'FQDN' image".  This image may take
@@ -204,6 +213,33 @@ To generate from the command line on the Foreman server:
 Set `OUTPUT=/path` to change the output destination path (directory or file).
 It must be writable by the 'foreman' user.
 
+### Subnet images
+
+Subnet images are similar to generic images, but chain-loading is done via the
+TFTP Smart Proxy assigned to the Subnet of the host. The smart proxy must have
+the "Templates" module enabled and configured.
+
+This image is generic for all hosts with a provisioning NIC on that subnet.
+
+To generate the image from the web interface, view a host page, click the
+"Boot disk" button and select "Subnet image".
+
+To generate using the Hammer CLI, install the [hammer_cli_foreman_bootdisk](https://github.com/theforeman/hammer_cli_foreman_bootdisk)
+plugin and run:
+
+    hammer bootdisk subnet --subnet local.lan
+
+See the hammer_cli_foreman_bootdisk documentation for more advanced usage.
+
+To generate from the command line on the Foreman server:
+
+    foreman-rake bootdisk:generate:subnet NAME=subnet-name
+
+Note that foreman-rake does connect to the foreman-proxy.
+
+Set `OUTPUT=/path` to change the output destination path (directory or file).
+It must be writable by the 'foreman' user.
+
 ### Host group images
 
 TODO
@@ -244,6 +280,14 @@ the Foreman UI.
 * `bootdisk_cache_media` controls whether to cache OS boot files from
   installation media for full host images
 
+### RBAC
+
+This plugin provides "Boot disk access" role which requires the following
+permissions to be present to allow host and subnet image downloading:
+
+* `view_hosts`
+* `view_subnets`
+
 # Issues
 
 Report issues on the Redmine project: [foreman_bootdisk](http://projects.theforeman.org/projects/bootdisk/issues/new)

data/app/controllers/foreman_bootdisk/api/v2/subnet_disks_controller.rb

@@ -0,0 +1,37 @@
+require 'uri'
+
+module ForemanBootdisk::Api::V2
+  class SubnetDisksController < ::Api::V2::BaseController
+    include ::Api::Version2
+
+    resource_description do
+      api_base_url "/bootdisk/api"
+    end
+
+    before_filter :find_resource, :only => :subnet
+
+    skip_after_filter :log_response_body
+
+    # no-op, but required for apipie documentation
+    api :GET, '', N_('Subnet boot disks')
+    def index; end
+
+    api :GET, '/subnets/:subnet_id', N_('Download subnet generic image')
+    param :subnet_id, :identifier_dottable, :required => true
+    def subnet
+      subnet = @subnet_disk
+      subnet.tftp || raise(::Foreman::Exception.new(N_("TFTP feature not enabled for subnet %s"), subnet.name))
+      tmpl = ForemanBootdisk::Renderer.new.generic_template_render(subnet)
+      ForemanBootdisk::ISOGenerator.generate(:ipxe => tmpl) do |iso|
+        name=subnet.name
+        send_data File.read(iso), :filename => "bootdisk_subnet_#{name}.iso"
+      end
+    end
+
+    private
+
+    def resource_scope
+      Subnet.authorized('view_subnets')
+    end
+  end
+end

data/app/controllers/foreman_bootdisk/disks_controller.rb

@@ -2,13 +2,13 @@ require 'uri'
 
 module ForemanBootdisk
   class DisksController < ::ApplicationController
-    before_filter :find_resource, :only => %w[host full_host]
+    before_filter :find_resource, :only => %w[host full_host subnet]
 
     def generic
       begin
         tmpl = ForemanBootdisk::Renderer.new.generic_template_render
       rescue => e
-        error _('Failed to render boot disk template: %s') % e
+        error_rendering(e)
         redirect_to :back
         return
       end
@@ -23,7 +23,7 @@ module ForemanBootdisk
       begin
         tmpl = host.bootdisk_template_render
       rescue => e
-        error _('Failed to render boot disk template: %s') % e
+        error_rendering(e)
         redirect_to :back
         return
       end
@@ -40,6 +40,23 @@ module ForemanBootdisk
       end
     end
 
+    def subnet
+      host = @disk
+      begin
+        subnet = host.try(:subnet) || raise(::Foreman::Exception.new(N_("Subnet is not assigned to the host %s"), host.name))
+        subnet.tftp || raise(::Foreman::Exception.new(N_("TFTP feature not enabled for subnet %s"), subnet.name))
+        tmpl = ForemanBootdisk::Renderer.new.generic_template_render(subnet)
+      rescue => e
+        error_rendering(e)
+        redirect_to :back
+        return
+      end
+
+      ForemanBootdisk::ISOGenerator.generate(:ipxe => tmpl) do |iso|
+        send_data File.read(iso), :filename => "bootdisk_subnet_#{subnet.name}.iso"
+      end
+    end
+
     def help
     end
 
@@ -48,5 +65,11 @@ module ForemanBootdisk
     def resource_scope(controller = controller_name)
       Host::Managed.authorized(:view_hosts)
     end
+
+    def error_rendering(e)
+      msg = _('Failed to render boot disk template')
+      error("#{msg}: #{e.message}")
+      ::Foreman::Logging.exception(msg, e)
+    end
   end
 end

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

@@ -11,7 +11,10 @@ module ForemanBootdisk::HostsHelperExt
         select_action_button(_('Boot disk'), {},
           display_bootdisk_link_if_authorized(_("Host '%s' image") % @host.name.split('.')[0], {:controller => 'foreman_bootdisk/disks', :action => 'host', :id => @host}, :class=>'btn'),
           display_bootdisk_link_if_authorized(_("Full host '%s' image") % @host.name.split('.')[0], {:controller => 'foreman_bootdisk/disks', :action => 'full_host', :id => @host}, :class=>'btn'),
+          content_tag(:li, "", :class => "divider"),
           display_bootdisk_link_if_authorized(_("Generic image"), {:controller => 'foreman_bootdisk/disks', :action => 'generic'}, :class=>'btn'),
+          display_bootdisk_for_subnet,
+          content_tag(:li, "", :class => "divider"),
           display_bootdisk_link_if_authorized(_("Help"), {:controller => 'foreman_bootdisk/disks', :action => 'help'}, :class=>'btn')
         )
       )
@@ -19,6 +22,15 @@ module ForemanBootdisk::HostsHelperExt
     host_title_actions_without_bootdisk(*args)
   end
 
+  # need to wrap this one in a test for template proxy presence
+  def display_bootdisk_for_subnet
+    if (proxy = @host.try(:subnet).try(:tftp)) && proxy.has_feature?('Templates')
+      display_bootdisk_link_if_authorized(_("Subnet '%s' generic image") % @host.subnet.name, {:controller => 'foreman_bootdisk/disks', :action => 'subnet', :id => @host}, :class=>'btn')
+    else
+      ""
+    end
+  end
+
   # Core Foreman helpers can't look up a URL against a mounted engine
   def display_bootdisk_link_if_authorized(name, options = {}, html_options = {})
     if bootdisk_authorized_for(options)

data/app/models/concerns/foreman_bootdisk/host_ext.rb

@@ -13,10 +13,7 @@ module ForemanBootdisk::HostExt
   end
 
   def bootdisk_chain_url(mac = self.mac, action = 'iPXE')
-    u = URI.parse(foreman_url(action))
-    u.query = "#{u.query}&mac=#{mac}"
-    u.fragment = nil
-    u.to_s
+    ForemanBootdisk::Renderer.format_bootdisk_chain_url(foreman_url(action), mac)
   end
 
   def bootdisk_raise(*args)

data/app/services/foreman_bootdisk/iso_generator.rb

@@ -23,7 +23,7 @@ class ForemanBootdisk::ISOGenerator
         iso_suffix = iso9660_filename(suffix)
         iso_f0 = iso9660_filename(f[0].to_s) + '_' + iso_suffix
         tmpl.gsub!(f[0].to_s + '-' + suffix, iso_f0)
-        Rails.logger.debug("Boot file #{iso_f0}, source #{f[1]}")
+        ForemanBootdisk.logger.debug("Boot file #{iso_f0}, source #{f[1]}")
         [iso_f0, f[1]]
       end
     end
@@ -107,10 +107,10 @@ class ForemanBootdisk::ISOGenerator
       file.binmode
 
       if use_cache && !(contents = Rails.cache.fetch(uri, :raw => true)).nil?
-        Rails.logger.info("Retrieved #{uri} from local cache (use foreman-rake tmp:cache:clear to empty)")
+        ForemanBootdisk.logger.info("Retrieved #{uri} from local cache (use foreman-rake tmp:cache:clear to empty)")
         file.write(contents)
       else
-        Rails.logger.info("Fetching #{uri}")
+        ForemanBootdisk.logger.info("Fetching #{uri}")
         write_cache = use_cache
         uri = URI(uri)
         Net::HTTP.start(uri.host, uri.port) do |http|
@@ -126,7 +126,7 @@ class ForemanBootdisk::ISOGenerator
     end
 
     if write_cache
-      Rails.logger.debug("Caching contents of #{uri}")
+      ForemanBootdisk.logger.debug("Caching contents of #{uri}")
       Rails.cache.write(uri, File.read(path), :raw => true)
     end
   end

data/app/services/foreman_bootdisk/renderer.rb

@@ -4,16 +4,35 @@ module ForemanBootdisk
   class Renderer
     include ::Foreman::Renderer
     include Rails.application.routes.url_helpers
+    delegate :logger, :to => :ForemanBootdisk
 
-    def generic_template_render
+    def generic_template_render(subnet = nil)
       tmpl = ProvisioningTemplate.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, :subnet).new(nil, nil)
-      unattended_render(tmpl.template)
+
+      if subnet.present?
+        # rendering a subnet-level bootdisk requires tricking the renderer into thinking it has a
+        # valid host, with a token, and with a tftp proxy
+        @host = Struct.new(:token, :subnet).new(
+          Struct.new(:value).new('faketoken'),
+          subnet
+        )
+      else
+        @host = Struct.new(:token, :subnet).new(nil,nil)
+      end
+      modified_template = unattended_render(tmpl.template)
+      # remove the token from subnet-level generation, since this is meant to be generic
+      modified_template.gsub!(/(?<=iPXE\?)token=faketoken\&(?=mac=)/,'')
+      modified_template
+    end
+
+    def bootdisk_chain_url(mac = '', action = 'iPXE')
+      Renderer.format_bootdisk_chain_url(foreman_url(action), mac)
     end
 
-    def bootdisk_chain_url(action = 'iPXE')
-      u = URI.parse(foreman_url(action))
-      u.query = "#{u.query}&mac="
+    def self.format_bootdisk_chain_url(url, mac)
+      u = URI.parse(url)
+      ForemanBootdisk.logger.warn("Foreman or proxy is configured with HTTPS, probably not supported by iPXE: #{u}") if u.scheme == 'https'
+      u.query = "#{u.query}&mac=#{mac}"
       u.fragment = nil
       u.to_s
     end

data/app/views/foreman_bootdisk/disks/help.html.erb

@@ -19,7 +19,7 @@
 
   <h2><%= _('Full host image') %></h2>
   <p>
-    <%= _('A variant of the per-host image which contains the OS bootloader embedded inside the disk.  This may be useful if chainloading fails on certain hardware, but has the downside that the image must be regenerated for any change in the OS, bootloader or templates.') %>
+    <%= _('A variant of the per-host image which contains the OS bootloader embedded inside the disk.  This may be useful if chainloading fails on certain hardware, but has the downside that the image must be regenerated for any change in the OS, bootloader or PXELinux templates.') %>
   </p>
 
   <h2><%= _('Generic image') %></h2>
@@ -29,4 +29,12 @@
   <p>
     <%= _('The OS install continues using the installation media configured in Foreman, and it will typically configure static networking, depending on how the OS iPXE template is configured.') %>
   </p>
+
+  <h2><%= _('Subnet image') %></h2>
+  <p>
+    <%= _('Subnet images are similar to generic images, but chain-loading is done via the TFTP Smart Proxy assigned to the Subnet of the host. The smart proxy must have the "Templates" module enabled and configured.') %>
+  </p>
+  <p>
+    <%= _('This image is generic for all hosts with a provisioning NIC on that subnet.') %>
+  </p>
 </div>

data/app/views/foreman_bootdisk/generic_host.erb

@@ -10,12 +10,13 @@
 # Copy this template to customize it, the original is read-only.
 
 # loop over net* until we can get a template
+<% url = bootdisk_chain_url %>
 <% (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 <%= bootdisk_chain_url %>${net<%= i -%>/mac} || goto net<%= i+1 %>
+chain <%= url %>${net<%= i -%>/mac} || goto net<%= i+1 %>
 exit 0
 <% end -%>
 

data/config/routes.rb

@@ -5,6 +5,7 @@ ForemanBootdisk::Engine.routes.draw do
     constraints(:id => /[^\/]+/) do
       get 'hosts/:id', :on => :collection, :to => 'disks#host'
       get 'full_hosts/:id', :on => :collection, :to => 'disks#full_host'
+      get 'subnet/:id', :on => :collection, :to => 'disks#subnet'
     end
   end
 
@@ -13,6 +14,7 @@ ForemanBootdisk::Engine.routes.draw do
       get 'generic', :to => 'disks#generic'
       constraints(:id => /[^\/]+/) do
         get 'hosts/:id', :to => 'disks#host'
+        get 'subnets/:id', :to => 'subnet_disks#subnet'
       end
     end
   end

data/db/migrate/20140522185700_change_templatekind_to_bootdisk.rb

@@ -8,7 +8,7 @@ class ChangeTemplatekindToBootdisk < ActiveRecord::Migration
   end
 
   def self.up
-    kind = TemplateKind.find_or_create_by_name('Bootdisk')
+    kind = TemplateKind.where(:name => 'Bootdisk').first_or_create
 
     tmpl_h = Setting.find_by_name('bootdisk_host_template').try(:value)
     tmpl_g = Setting.find_by_name('bootdisk_generic_host_template').try(:value)

data/db/seeds.d/50-bootdisk_templates.rb

@@ -1,33 +1,35 @@
-kind = TemplateKind.find_or_create_by_name('Bootdisk')
+kind = TemplateKind.where(:name => 'Bootdisk').first_or_create
 
 ProvisioningTemplate.without_auditing do
   content = File.read(File.join(ForemanBootdisk::Engine.root, 'app', 'views', 'foreman_bootdisk', 'host.erb'))
-  tmpl = ProvisioningTemplate.find_or_create_by_name(
-    :name => 'Boot disk iPXE - host',
-    :template_kind_id => kind.id,
-    :snippet => false,
-    :template => content
-  )
+  tmpl = ProvisioningTemplate.where(:name => 'Boot disk iPXE - host').first_or_create do |template|
+    template.attributes = {
+      :template_kind_id => kind.id,
+      :snippet => false,
+      :template => content
+    }
+  end
   tmpl.attributes = {
     :template => content,
     :default  => true,
     :vendor   => "Foreman boot disk",
-    :locked   => true
   }
+  tmpl.locked = true
   tmpl.save!(:validate => false) if tmpl.changes.present?
 
   content = File.read(File.join(ForemanBootdisk::Engine.root, 'app', 'views', 'foreman_bootdisk', 'generic_host.erb'))
-  tmpl = ProvisioningTemplate.find_or_create_by_name(
-    :name => 'Boot disk iPXE - generic host',
-    :template_kind_id => kind.id,
-    :snippet => false,
-    :template => content
-  )
+  tmpl = ProvisioningTemplate.where(:name => 'Boot disk iPXE - generic host').first_or_create do |template|
+    template.attributes = {
+      :template_kind_id => kind.id,
+      :snippet => false,
+      :template => content
+    }
+  end
   tmpl.attributes = {
     :template => content,
     :default  => true,
     :vendor   => "Foreman boot disk",
-    :locked   => true
   }
+  tmpl.locked = true
   tmpl.save!(:validate => false) if tmpl.changes.present?
 end

data/lib/foreman_bootdisk.rb

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

data/lib/foreman_bootdisk/engine.rb

@@ -19,7 +19,9 @@ module ForemanBootdisk
     end
 
     initializer "foreman_bootdisk.load_app_instance_data" do |app|
-      app.config.paths['db/migrate'] += ForemanBootdisk::Engine.paths['db/migrate'].existent
+      ForemanBootdisk::Engine.paths['db/migrate'].existent.each do |path|
+        app.config.paths['db/migrate'] << path
+      end
     end
 
     initializer "foreman_bootdisk.apipie" do
@@ -31,7 +33,7 @@ module ForemanBootdisk
         requires_foreman '>= 1.9'
 
         security_block :bootdisk do |map|
-          permission :download_bootdisk, {:'foreman_bootdisk/disks' => [:generic, :host, :full_host, :help],
+          permission :download_bootdisk, {:'foreman_bootdisk/disks' => [:generic, :host, :full_host, :subnet, :help],
                                           :'foreman_bootdisk/api/v2/disks' => [:generic, :host]}
         end
 
@@ -58,4 +60,8 @@ module ForemanBootdisk
       end
     end
   end
+
+  def self.logger
+    Foreman::Logging.logger('foreman_bootdisk')
+  end
 end