foreman_bootdisk 14.0.0 → 17.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd7cc51c2b0f332b25d13f49d22c813c0ed28fb9b6e34238a7f44cfd40eddda1
-  data.tar.gz: f46b68427bbd016563ef186a9ed2cacbaf8f271c8da421db5f7eefb21eb363c6
+  metadata.gz: cc43113465fd89f890f9606fb04af3e948b96ac1bd6c1943211a452e38c4cb2a
+  data.tar.gz: 9db1069085f706df776576fc0df25f49a7d09ae71555ea15397d57656ddd0da5
 SHA512:
-  metadata.gz: cefbdba361acd20cdfb1a9137010da3290b8170fe9bf8bafc9f786f514acb7b81a5b448f4b8f794d5416800f5cdcf3faad55693efd6672fbe454375ae84ecf3c
-  data.tar.gz: b00a6e9af217a60d776508e3e076077729ebd0360cf3bdb246a71be9e307abeef10bc42c46a68f23834153a8fa86123eeb14cfafe007aa29c77b38087a3f612f
+  metadata.gz: 115bddba362f7c53b78d06ca78a1f120babae76cc2f922447cd0e05b1f322f189e30b186e6cb0718b7d9a24bfca67bf2287283fd9495eba4193a9b6bb560ec29
+  data.tar.gz: 1cd764fdc0a939d45934070d6b34e2619870c8c206afd4915cae93f68f7553cfcc9b18d3c04770aba9f4b6f45d62bbd779563798b7175595ee8c2b991f03b660

data/AUTHORS

@@ -0,0 +1,30 @@
+Adam Ruzicka
+Bernhard Suttner
+Bryan Kearney
+crito
+Damon Maria
+Dominic Cleal
+Greg Sutcliffe
+Ido Kanner
+Jon Fautley
+Justin Sherrill
+Leos Stejskal
+Lukas Zapletal
+Lukáš Zapletal
+Marek Hulan
+Marek Hulán
+Martin Bačovský
+Michael Hofer
+Michael Moll
+Ohad Levy
+Ondrej Prazak
+Ondřej Ezr
+Ondřej Pražák
+Robert Antoni Buj Gelonch
+Rohan21Lobo
+Ronald van Zantvoort
+Sam Kottler
+Sean O'Keeffe
+Stephen Benjamin
+Swapnil Abnave
+Timo Goebel

data/README.md

@@ -50,6 +50,10 @@ gPXE images are unsupported due to lack of initrd support.
 | >= 1.19         | ~> 13.0        |
 | >= 1.20         | ~> 14.0        |
 | >= 1.21         | ~> 15.0        |
+| >= 1.23         | ~> 16.0        |
+| >= 1.24         | ~> 16.1        |
+| >= 2.0          | ~> 16.1        |
+| >= 2.1          | ~> 17.0        |
 
 # Usage
 
@@ -119,6 +123,7 @@ TFTP settings are needed.
     <th>DHCP reservation</th>
     <th>Pre-register host</th>
     <th>OS-specific</th>
+    <th>EFI supported</th>
   </tr>
   <tr>
     <td>Per-host image</td>
@@ -127,6 +132,7 @@ TFTP settings are needed.
     <td>No</td>
     <td>Yes</td>
     <td>No</td>
+    <td>No</td>
   </tr>
   <tr>
     <td>Full host image</td>
@@ -135,6 +141,7 @@ TFTP settings are needed.
     <td>No</td>
     <td>Yes</td>
     <td>Yes</td>
+    <td>Yes</td>
   </tr>
   <tr>
     <td>Generic image</td>
@@ -143,6 +150,7 @@ TFTP settings are needed.
     <td>No</td>
     <td>Yes</td>
     <td>No</td>
+    <td>No</td>
   </tr>
   <tr>
     <td>Subnet image</td>
@@ -151,6 +159,7 @@ TFTP settings are needed.
     <td>No</td>
     <td>Yes</td>
     <td>No</td>
+    <td>Yes</td>
   </tr>
 </table>
 
@@ -236,6 +245,22 @@ 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.
 
+### Generic static image
+
+This is generic image type which asks for network credentials instead of doing
+DHCP request. Tokens must be turned off in order to find the host by MAC
+address. To do that, set Token duration to 0 in Administer - Settings.
+
+- Network interface name
+- IP Address
+- Netmask
+- Gateway
+- DNS
+
+To use generic static host image, set "Generic image template" to "Bootdisk
+iPXE - host template" in Administer - Settings - Boot disk. Only one template
+can be used at one time across all hosts.
+
 ### Subnet images
 
 Subnet images are similar to generic images, but chain-loading is done via the

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

@@ -21,9 +21,10 @@ module ForemanBootdisk
 
         api :GET, '/generic', N_('Download generic image')
         def generic
+          # EFI not supported for iPXE generic bootdisk
           tmpl = ForemanBootdisk::Renderer.new.generic_template_render
           ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl) do |iso|
-            send_data read_file(iso), filename: "bootdisk_#{URI.parse(Setting[:foreman_url]).host}.iso"
+            send_file(iso, filename: "bootdisk_#{URI.parse(Setting[:foreman_url]).host}.iso")
           end
         end
 
@@ -34,22 +35,19 @@ module ForemanBootdisk
           host = @disk
           if params[:full]
             ForemanBootdisk::ISOGenerator.generate_full_host(host) do |iso|
-              send_data read_file(iso), filename: "#{host.name}#{ForemanBootdisk::ISOGenerator.token_expiry(host)}.iso"
+              send_file(iso, filename: "#{host.name}#{ForemanBootdisk::ISOGenerator.token_expiry(host)}.iso")
             end
           else
+            # EFI not supported for iPXE host bootdisk
             tmpl = host.bootdisk_template_render
             ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl) do |iso|
-              send_data read_file(iso), filename: "#{host.name}.iso"
+              send_file(iso, filename: "#{host.name}.iso")
             end
           end
         end
 
         private
 
-        def read_file(filename)
-          File.read(filename)
-        end
-
         def resource_scope
           Host::Managed.authorized('view_hosts')
         end

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

@@ -25,10 +25,15 @@ module ForemanBootdisk
         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"
+          tmpl_bios = ForemanBootdisk::Renderer.new.generic_template_render(subnet)
+          tmpl_efi = nil
+          if subnet.httpboot
+            tmpl_efi = ForemanBootdisk::Renderer.new.generic_efi_template_render(subnet)
+          else
+            ForemanBootdisk.logger.warn('HTTPBOOT feature is not enabled for subnet %s, UEFI may not be available for bootdisk' % subnet.name)
+          end
+          ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl_bios, grub: tmpl_efi) do |temp_iso_filename|
+            send_file(temp_iso_filename, filename: subnet.name)
           end
         end
 

data/app/controllers/foreman_bootdisk/disks_controller.rb

@@ -12,6 +12,7 @@ module ForemanBootdisk
 
     def generic
       begin
+        # EFI not supported for iPXE generic bootdisk
         tmpl = ForemanBootdisk::Renderer.new.generic_template_render
       rescue StandardError => e
         error_rendering(e)
@@ -20,13 +21,14 @@ module ForemanBootdisk
       end
 
       ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl) do |iso|
-        send_data read_file(iso), filename: "bootdisk_#{URI.parse(Setting[:foreman_url]).host}.iso"
+        send_file(iso, filename: "bootdisk_#{URI.parse(Setting[:foreman_url]).host}.iso")
       end
     end
 
     def host
       host = @disk
       begin
+        # EFI not supported for iPXE host bootdisk
         tmpl = host.bootdisk_template_render
       rescue StandardError => e
         error_rendering(e)
@@ -35,14 +37,14 @@ module ForemanBootdisk
       end
 
       ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl) do |iso|
-        send_data read_file(iso), filename: "#{host.name}.iso"
+        send_file(iso, filename: "#{host.name}.iso")
       end
     end
 
     def full_host
       host = @disk
       ForemanBootdisk::ISOGenerator.generate_full_host(host) do |iso|
-        send_data read_file(iso), filename: "#{host.name}#{ForemanBootdisk::ISOGenerator.token_expiry(host)}.iso"
+        send_file(iso, filename: "#{host.name}#{ForemanBootdisk::ISOGenerator.token_expiry(host)}.iso")
       end
     end
 
@@ -51,15 +53,18 @@ module ForemanBootdisk
       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)
+        subnet.httpboot || ForemanBootdisk.logger.warn('HTTPBOOT feature is not enabled for subnet %s, UEFI may not be available for bootdisk' % subnet.name)
+
+        tmpl_bios = ForemanBootdisk::Renderer.new.generic_template_render(subnet)
+        tmpl_efi = ForemanBootdisk::Renderer.new.generic_efi_template_render(subnet)
       rescue StandardError => e
         error_rendering(e)
         redirect_back(fallback_location: '/')
         return
       end
 
-      ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl) do |iso|
-        send_data read_file(iso), filename: "bootdisk_subnet_#{subnet.name}.iso"
+      ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl_bios, grub: tmpl_efi) do |iso|
+        send_file(iso, filename: "bootdisk_subnet_#{subnet.name}.iso")
       end
     end
 
@@ -67,10 +72,6 @@ module ForemanBootdisk
 
     private
 
-    def read_file(filename)
-      File.read(filename)
-    end
-
     def resource_scope(_controller = controller_name)
       Host::Managed.authorized(:view_hosts)
     end

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

@@ -2,27 +2,27 @@
 
 module ForemanBootdisk
   module HostsHelperExt
-    def host_title_actions(*args)
-      if @host.bootdisk_downloadable?
+    def host_title_actions(host)
+      if host.bootdisk_downloadable?
         title_actions(
           button_group(
             select_action_button(
               _('Boot disk'), { class: 'btn btn-group' },
               display_bootdisk_link_if_authorized(
-                _("Host '%s' image") % @host.name.split('.')[0],
+                _("Host '%s' image") % host.name.split('.')[0],
                 {
                   controller: 'foreman_bootdisk/disks',
                   action: 'host',
-                  id: @host
+                  id: host
                 },
                 class: 'la'
               ),
               display_bootdisk_link_if_authorized(
-                _("Full host '%s' image") % @host.name.split('.')[0],
+                _("Full host '%s' image") % host.name.split('.')[0],
                 {
                   controller: 'foreman_bootdisk/disks',
                   action: 'full_host',
-                  id: @host
+                  id: host
                 },
                 class: 'la'
               ),
@@ -35,7 +35,7 @@ module ForemanBootdisk
                 },
                 class: 'la'
               ),
-              display_bootdisk_for_subnet,
+              display_bootdisk_for_subnet(host),
               content_tag(:li, '', class: 'divider'),
               display_bootdisk_link_if_authorized(
                 _('Help'), {
@@ -48,29 +48,29 @@ module ForemanBootdisk
           )
         )
       else
-        bootdisk_button_disabled
+        bootdisk_button_disabled(host)
       end
 
       super
     end
 
-    def bootdisk_button_disabled
+    def bootdisk_button_disabled(host)
       title_actions(
         button_group(
           link_to(_('Boot disk'), '#', disabled: true, class: 'btn btn-default',
-                                       title: _('Boot disk download not available for %s architecture') % @host.architecture.name)
+                                       title: _('Boot disk download not available for %s architecture') % host.architecture.name)
         )
       )
     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')
+    def display_bootdisk_for_subnet(host)
+      if (proxy = host.try(:subnet).try(:tftp) || host.try(:subnet).try(:httpboot)) && proxy.has_feature?('Templates')
         display_bootdisk_link_if_authorized(
-          _("Subnet '%s' generic image") % @host.subnet.name, {
+          _("Subnet '%s' generic image") % host.subnet.name, {
             controller: 'foreman_bootdisk/disks',
             action: 'subnet',
-            id: @host
+            id: host
           },
           class: 'la'
         )

data/app/lib/foreman_bootdisk/scope/bootdisk.rb

@@ -6,7 +6,6 @@ module ForemanBootdisk
       def bootdisk_chain_url(mac = host.try(:mac), action = 'iPXE')
         url = foreman_url(action)
         u = URI.parse(url)
-        ForemanBootdisk.logger.warn("Foreman or proxy is configured with HTTPS, probably not supported by iPXE: #{u}") if u.scheme == 'https'
         new_query_data = URI.decode_www_form(u.query || '') << ['mac', mac || '']
         new_querystring = URI.encode_www_form(new_query_data)
         u.query = nil
@@ -18,6 +17,10 @@ module ForemanBootdisk
       def bootdisk_raise(*args)
         raise ::Foreman::Exception.new(*args)
       end
+
+      def template_name
+        "Foreman Bootdisk"
+      end
     end
   end
 end

data/app/lib/foreman_bootdisk/scope/full_host_bootdisk_efi.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ForemanBootdisk
+  module Scope
+    class FullHostBootdiskEfi < Bootdisk
+      def kernel(medium_provider)
+        '/' + ForemanBootdisk::ISOGenerator.iso9660_filename(super)
+      end
+
+      def initrd(medium_provider)
+        '/' + ForemanBootdisk::ISOGenerator.iso9660_filename(super)
+      end
+    end
+  end
+end

data/app/models/concerns/foreman_bootdisk/compute_resources/vmware.rb

@@ -36,12 +36,21 @@ module ForemanBootdisk
           'instance_uuid' => vm_uuid,
           'iso' => "foreman_isos/#{iso}",
           'datastore' => bootdisk_datastore(vm_uuid),
-          'start_connected' => false,
+          'start_connected' => true,
           'connected' => true,
           'allow_guest_control' => true
         }
         client.vm_reconfig_cdrom options
       end
+
+      def iso_detach(vm_uuid)
+        options = {
+          'instance_uuid' => vm_uuid,
+          'start_connected' => false,
+          'connected' => false,
+        }
+        client.vm_reconfig_cdrom options
+      end
     end
   end
 end

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

@@ -5,14 +5,11 @@ require 'uri'
 module ForemanBootdisk
   module HostExt
     def bootdisk_template
-      template = ProvisioningTemplate.unscoped.find_by(
-        name: Setting[:bootdisk_host_template]
-      )
+      template = ProvisioningTemplate.unscoped.find_by(name: Setting[:bootdisk_host_template])
       unless template
-        raise ::Foreman::Exception.new(
-          N_('Unable to find template specified by %s setting'), 'bootdisk_host_template'
-        )
+        raise ::Foreman::Exception.new(N_('Unable to find template specified by %s setting'), 'bootdisk_host_template')
       end
+
       template
     end
 
@@ -36,12 +33,12 @@ module ForemanBootdisk
       /i.86|x86[_-]64/ =~ architecture.name
     end
 
-    def validate_media?
-      super || (managed && bootdisk_build? && build?)
-    end
-
     def can_be_built?
       super || (managed? && SETTINGS[:unattended] && bootdisk_build? && !build?)
     end
   end
 end
+
+class Host::Managed::Jail < Safemode::Jail
+  allow :bootdisk_build?
+end

data/app/models/concerns/foreman_bootdisk/orchestration/compute.rb

@@ -9,7 +9,6 @@ module ForemanBootdisk
 
       included do
         after_validation :queue_bootdisk_compute
-        after_build :rebuild_with_bootdisk
       end
 
       def bootdisk_isodir
@@ -21,15 +20,25 @@ module ForemanBootdisk
       end
 
       def queue_bootdisk_compute
-        return unless compute? && errors.empty? && new_record?
+        return unless compute? && errors.empty?
         return unless provision_method == 'bootdisk'
 
-        queue.create(name: _('Generating ISO image for %s') % self, priority: 5,
-                     action: [self, :setGenerateIsoImage])
-        queue.create(name: _('Upload ISO image to datastore for %s') % self, priority: 6,
-                     action: [self, :setIsoImage])
-        queue.create(name: _('Attach ISO image to CDROM drive for %s') % self, priority: 1001,
-                     action: [self, :setAttachIsoImage])
+        # We want to add our queue jobs only if really necessary:
+        #   - in case of starting to create a new host
+        #   - in case of a rebuild
+        if (old.nil? || !old.build?) && build?
+          queue.create(name: _('Generating ISO image for %s') % self, priority: 5,
+                       action: [self, :setGenerateIsoImage])
+          queue.create(name: _('Upload ISO image to datastore for %s') % self, priority: 6,
+                       action: [self, :setIsoImage])
+          queue.create(name: _('Attach ISO image to CDROM drive for %s') % self, priority: 1001,
+                       action: [self, :setAttachIsoImage])
+        # Detach ISO image when host sends 'built' HTTP POST request
+        elsif old&.build? && !build?
+          queue.create(name: _('Detach ISO image from CDROM drive for %s') % self, priority: 52,
+                       action: [self, :setDetachIsoImage])
+        end
+        true
       end
 
       def bootdisk_generate_iso_image
@@ -46,6 +55,10 @@ module ForemanBootdisk
         compute_resource.iso_attach(File.basename(bootdisk_isofile), uuid)
       end
 
+      def bootdisk_detach_iso
+        compute_resource.iso_detach(uuid)
+      end
+
       def setGenerateIsoImage
         logger.info format('Generating ISO image for %s', name)
         bootdisk_generate_iso_image
@@ -73,18 +86,14 @@ module ForemanBootdisk
 
       def delAttachIsoImage; end
 
-      def rebuild_with_bootdisk
-        return true unless bootdisk?
-
-        begin
-          bootdisk_generate_iso_image
-          bootdisk_upload_iso
-          bootdisk_attach_iso
-        rescue StandardError => e
-          Foreman::Logging.exception "Failed to rebuild Bootdisk image for #{name}", e, level: :error
-          return false
-        end
+      def setDetachIsoImage
+        logger.info format('Detaching ISO image from CDROM drive for %s', name)
+        bootdisk_detach_iso
+      rescue StandardError => e
+        failure format(_('Failed to detach ISO image from CDROM drive of instance %{name}: %{message}'), name: name, message: e.message), e
       end
+
+      def delDetachIsoImage; end
     end
   end
 end