foreman_bootdisk 15.0.0 → 17.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4733307c911d25a22301bdb3527422e04e4ab2491c2210b914f3c27d00ca1ea2
-  data.tar.gz: 14955cfafbe62b393e45927a36805173a00e41f8bf0e4868f7f11026bc260fac
+  metadata.gz: ca80bb43629c291c9d6b27bb8c94ebd10fcc2e6e267378e4852ab42bdcee0088
+  data.tar.gz: 743d4a31beef4d80d6ab5b025cf6261bbbb11cb62eb82b65d8f7c5aaed58c9fb
 SHA512:
-  metadata.gz: b605a6809d4cfa2c2fee39e1744c54f4114b1b05d64e46e983cf2f4d3344766b4173d6a4519e1758e2afc30d0f0aa12b64e013208d2f706828ae8aa8fb8381d7
-  data.tar.gz: 2497d42c876c57097cde13de621696b3fb60140238ef00585e49e76980a6d28d12bd0c4931120648f2af20ef55d9f9865522eb59a2a74a71673d3634a169e66d
+  metadata.gz: 1915d2f7f01f58ec795f343707fe7a6d24f49af0ce6fb6ee9577f3279749e74f5cfb74b7ee707f3eea0e972b92344bc7d10a30f7be9556bffe8be2a39315526d
+  data.tar.gz: b21943b356b209d60ad7cd1bc655a81c042ef93534fb94f719c271688f64f42a2f2ea3ba21a10280b388861fd061d1e08df498de216dc233f27a92e10065c942

data/.github/workflows/rubocop.yaml

@@ -0,0 +1,19 @@
+name: Rubocop
+
+on: [pull_request]
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_FOREMAN: '0'
+      BUNDLE_WITHOUT: development:test
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.5
+          bundler-cache: true
+      - name: Run rubocop
+        run: bundle exec rubocop -P --format github

data/.tx/config

@@ -1,7 +1,7 @@
 [main]
 host = https://www.transifex.com
 
-[foreman.bootdisk]
+[foreman.foreman_bootdisk]
 file_filter = locale/<lang>/foreman_bootdisk.edit.po
 source_file = locale/foreman_bootdisk.pot
 source_lang = en

data/AUTHORS

@@ -1,20 +1,31 @@
+Adam Ruzicka
+Bernhard Suttner
 Bryan Kearney
+crito
+Damon Maria
 Dominic Cleal
+Dominik Matoulek
 Greg Sutcliffe
 Ido Kanner
 Jon Fautley
 Justin Sherrill
+Leos Stejskal
 Lukas Zapletal
 Lukáš Zapletal
 Marek Hulan
 Marek Hulán
+Markus Bucher
 Martin Bačovský
 Michael Hofer
 Michael Moll
 Ohad Levy
+Oleh Fedorenko
 Ondrej Prazak
+Ondřej Ezr
 Ondřej Pražák
+Pat Riehecky
 Robert Antoni Buj Gelonch
+Rohan21Lobo
 Ronald van Zantvoort
 Sam Kottler
 Sean O'Keeffe

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/concerns/allowed_actions.rb

@@ -0,0 +1,16 @@
+module AllowedActions
+  extend ActiveSupport::Concern
+
+  def bootdisk_type_allowed?(action = params[:action])
+    return true if Setting::Bootdisk.allowed_types&.include?(action)
+
+    message = _('This type of bootdisk is not allowed. Please contact administrator.')
+    if api_request?
+      render_error :custom_error, status: :unprocessable_entity, locals: { message: message}
+    else
+      error(message)
+      redirect_back(fallback_location: '/')
+    end
+    false
+  end
+end

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

@@ -7,11 +7,13 @@ module ForemanBootdisk
     module V2
       class DisksController < ::Api::V2::BaseController
         include ::Api::Version2
+        include AllowedActions
 
         resource_description do
           api_base_url '/bootdisk/api'
         end
 
+        before_action :bootdisk_type_allowed?, only: :generic
         before_action :find_resource, only: :host
         skip_after_action :log_response_body
 
@@ -21,9 +23,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
 
@@ -33,23 +36,22 @@ module ForemanBootdisk
         def host
           host = @disk
           if params[:full]
+            return unless bootdisk_type_allowed?('full_host')
             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
+            return unless bootdisk_type_allowed?
+            # 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

@@ -7,11 +7,14 @@ module ForemanBootdisk
     module V2
       class SubnetDisksController < ::Api::V2::BaseController
         include ::Api::Version2
+        include AllowedActions
 
         resource_description do
           api_base_url '/bootdisk/api'
         end
 
+        rescue_from ActiveRecord::RecordNotFound, :with => :subnet_not_found
+        before_action :bootdisk_type_allowed?, only: :subnet
         before_action :find_resource, only: :subnet
 
         skip_after_action :log_response_body
@@ -25,10 +28,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
 
@@ -37,6 +45,10 @@ module ForemanBootdisk
         def resource_scope
           Subnet.authorized('view_subnets')
         end
+
+        def subnet_not_found
+          not_found ("Subnet not found by id '%s'") % params[:id]
+        end
       end
     end
   end

data/app/controllers/foreman_bootdisk/disks_controller.rb

@@ -4,6 +4,9 @@ require 'uri'
 
 module ForemanBootdisk
   class DisksController < ::ApplicationController
+    include AllowedActions
+
+    before_action :bootdisk_type_allowed?, except: :help
     before_action :find_resource, only: %w[host full_host subnet]
 
     # as this engine is isolated, we need to include url helpers from core explicitly
@@ -12,6 +15,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 +24,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 +40,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 +56,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 +75,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,75 +2,40 @@
 
 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],
-                {
-                  controller: 'foreman_bootdisk/disks',
-                  action: 'host',
-                  id: @host
-                },
-                class: 'la'
-              ),
-              display_bootdisk_link_if_authorized(
-                _("Full host '%s' image") % @host.name.split('.')[0],
-                {
-                  controller: 'foreman_bootdisk/disks',
-                  action: 'full_host',
-                  id: @host
-                },
-                class: 'la'
-              ),
-              content_tag(:li, '', class: 'divider'),
-              display_bootdisk_link_if_authorized(
-                _('Generic image'),
-                {
-                  controller: 'foreman_bootdisk/disks',
-                  action: 'generic'
-                },
-                class: 'la'
-              ),
-              display_bootdisk_for_subnet,
-              content_tag(:li, '', class: 'divider'),
-              display_bootdisk_link_if_authorized(
-                _('Help'), {
-                  controller: 'foreman_bootdisk/disks',
-                  action: 'help'
-                },
-                class: 'la'
-              )
+              host_action_buttons(host)
             )
           )
         )
       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'
         )
@@ -95,5 +60,66 @@ module ForemanBootdisk
     def bootdisk_authorized_for(options)
       User.current.allowed_to?(options)
     end
+
+    def host_action_buttons(host)
+      actions = []
+
+      allowed_actions = Setting::Bootdisk.allowed_types
+      return '' unless allowed_actions
+
+      host_image_link = display_bootdisk_link_if_authorized(
+                          _("Host '%s' image") % host.name.split('.')[0],
+                          {
+                              controller: 'foreman_bootdisk/disks',
+                              action: 'host',
+                              id: host
+                          },
+                          class: 'la'
+                        )
+
+      full_host_image_link = display_bootdisk_link_if_authorized(
+                               _("Full host '%s' image") % host.name.split('.')[0],
+                               {
+                                   controller: 'foreman_bootdisk/disks',
+                                   action: 'full_host',
+                                   id: host
+                               },
+                               class: 'la'
+                             )
+
+      generic_image_link = display_bootdisk_link_if_authorized(
+                             _('Generic image'),
+                             {
+                                 controller: 'foreman_bootdisk/disks',
+                                 action: 'generic'
+                             },
+                             class: 'la'
+                           )
+
+      help_link = display_bootdisk_link_if_authorized(
+                    _('Help'),
+                    {
+                    controller: 'foreman_bootdisk/disks',
+                    action: 'help'
+                    },
+                    class: 'la'
+                  )
+
+      divider = tag(:li, '', class: 'divider')
+
+      actions << host_image_link if allowed_actions.include?('host')
+      actions << full_host_image_link if allowed_actions.include?('full_host')
+
+      subnet_link = display_bootdisk_for_subnet(host)
+      actions << divider if allowed_actions.include?('generic') || (allowed_actions.include?('subnet') && subnet_link.present?)
+
+      actions << generic_image_link if allowed_actions.include?('generic')
+      actions << subnet_link if allowed_actions.include?('subnet')
+
+      actions << divider
+      actions << help_link
+
+      actions
+    end
   end
 end