foreman_bootdisk 16.1.0 → 17.0.2

data/app/services/foreman_bootdisk/renderer.rb

@@ -4,36 +4,46 @@ require 'uri'
 
 module ForemanBootdisk
   class Renderer
-    def generic_template_render(subnet = nil)
-      host = if subnet.present?
-               # rendering a subnet-level bootdisk requires tricking the renderer into thinking it has a
-               # valid host, without a token, but with a tftp proxy
-               Struct.new(:token, :provision_interface, :content_source).new(
-                 nil,
-                 Struct.new(:subnet).new(subnet),
-                 nil
-               )
-             else
-               Struct.new(:token, :subnet, :content_source).new(nil, nil, nil)
-             end
-
-      render_template(template: generic_host_template, host: host)
-    end
-
-    def render_template(template:, host:, scope_class: renderer_scope)
+    def render_template(template:, host:, scope_class: renderer_scope, subnet: nil)
       source = Foreman::Renderer.get_source(
         template: template,
-        host: host
       )
       scope = Foreman::Renderer.get_scope(
         host: host,
-        klass: scope_class
+        variables: { subnet: subnet, bootdisk: true },
+        klass: scope_class,
       )
       Foreman::Renderer.render(source, scope)
     end
 
+    def generic_template_render(subnet = nil)
+      render_template(template: generic_host_template, host: stub_host(subnet), subnet: subnet)
+    end
+
+    def generic_efi_template_render(subnet)
+      if subnet.httpboot?
+        render_template(template: generic_efi_host_template, host: stub_host(subnet), subnet: subnet)
+      else
+        ForemanBootdisk.logger.warn('HTTPBOOT feature is not enabled for subnet %s, UEFI may not be available for bootdisk' % subnet.name)
+      end
+    end
+
     private
 
+    def stub_host(subnet)
+      if subnet.present?
+        # rendering a subnet-level bootdisk requires tricking the renderer into thinking it has a
+        # valid host, without a token, but with a tftp proxy
+        Struct.new(:token, :provision_interface, :content_source).new(
+          nil,
+          Struct.new(:subnet).new(subnet),
+          nil
+        )
+      else
+        Struct.new(:token, :subnet, :content_source).new(nil, nil, nil)
+      end
+    end
+
     def renderer_scope
       ForemanBootdisk::Scope::Bootdisk
     end
@@ -44,5 +54,12 @@ module ForemanBootdisk
 
       template
     end
+
+    def generic_efi_host_template
+      template = ProvisioningTemplate.unscoped.find_by(name: Setting[:bootdisk_generic_efi_host_template])
+      raise ::Foreman::Exception.new(N_('Unable to find template specified by %s setting'), 'bootdisk_generic_efi_host_template') unless template
+
+      template
+    end
   end
 end

data/app/views/foreman_bootdisk/generic_efi_host.erb

@@ -0,0 +1,64 @@
+#
+# Boot disk Grub2 EFI - generic host
+#
+#set debug="http,efinet,net"
+#set debug=all
+echo "Foreman Bootdisk: 'Boot disk Grub2 EFI - generic host' template"
+echo
+echo "********************************************************"
+echo " REQUIREMENTS:"
+echo " * SUBNET GENERIC IMAGE ONLY (host image not supported)"
+echo " * HOST PARAM default_grub_install_entry set to efi_http"
+echo " * PROXY WITH HTTPBOOT FEATURE"
+echo " * HTTP UEFI BOOT ONLY (Legacy/PXE not supported)"
+echo " * IPv4 ONLY (IPv6 not tested, change the template)"
+echo " * HTTP ONLY (change the template for HTTPS)"
+echo " * ISC DHCP (other servers not tested)"
+echo " * GRUB FROM RHEL 8.3+/7.9+ (when generating the image)"
+echo " * EFI HTTP or HTTPS grub entry must be selected in menu"
+echo " * DNS must resolve proxy hostname via DNS proxy if set"
+echo "*******************************************************"
+sleep 5
+<%
+# possible values are: "http" or "https"
+proxy_proto = "http"
+
+@subnet || bootdisk_raise("Generic disk not supported for EFI, use subnet disk")
+@subnet.template? || bootdisk_raise("Requires a proxy with template feature")
+proxy_port = if proxy_proto == "http"
+  @subnet.httpboot.httpboot_http_port
+else
+  @subnet.httpboot.httpboot_https_port
+end
+# Workaround for "no DNS server configured" https://bugzilla.redhat.com/show_bug.cgi?id=1842509
+proxy_httpboot_host = dns_lookup(@subnet.httpboot.hostname)
+proxy_template_host = dns_lookup(@subnet.template.hostname)
+-%>
+echo
+net_ls_cards
+echo "Configuring ALL cards via BOOTP/IPv4"
+net_bootp
+# uncomment here for IPv6 support (not tested)
+#echo "Configuring ALL cards via BOOTP/IPv6"
+#net_ipv6_autoconf
+net_ls_addr
+net_ls_routes
+net_ls_dns
+sleep 5
+set root=(<%= proxy_proto %>,<%= proxy_httpboot_host %>:<%= proxy_port %>)
+# The variable will not survive configfile fetch, therefore absolute path
+# must be used in the chainloaded template.
+# https://bugzilla.redhat.com/show_bug.cgi?id=1842893
+set http_path=/httpboot/
+set default=efi_<%= proxy_proto %>
+<% (0..32).each do |i| -%>
+  echo "Trying efinet<%= i %> via <%= proxy_proto %>://<%= proxy_template_host %>:<%= proxy_port %>/unattended/PXEGrub2?mac=$net_efinet<%= i %>_dhcp_mac"
+  set net_default_mac=$net_efinet<%= i %>_dhcp_mac
+  sleep 5
+  configfile (<%= proxy_proto %>,<%= proxy_template_host %>:<%= proxy_port %>)/unattended/PXEGrub2?mac=$net_efinet<%= i %>_dhcp_mac
+<% end -%>
+
+echo "Could not find a host with PXEGrub2 template and one of the MAC addresses!"
+echo "The system will poweroff in few minutes..."
+sleep 500
+poweroff

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

@@ -27,5 +27,6 @@ end
 ProvisioningTemplate.without_auditing do
   ensure_bootdisk_template("Boot disk iPXE - host", read_bootdisk_template("host.erb"))
   ensure_bootdisk_template("Boot disk iPXE - generic host", read_bootdisk_template("generic_host.erb"))
+  ensure_bootdisk_template("Boot disk Grub2 EFI - generic host", read_bootdisk_template("generic_efi_host.erb"))
   ensure_bootdisk_template("Boot disk iPXE - generic static host", read_bootdisk_template("generic_static_host.erb"))
 end

data/lib/foreman_bootdisk/engine.rb

@@ -38,7 +38,7 @@ module ForemanBootdisk
 
     initializer 'foreman_bootdisk.register_plugin', before: :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_bootdisk do
-        requires_foreman '>= 1.24'
+        requires_foreman '>= 2.1'
 
         security_block :bootdisk do |_map|
           permission :download_bootdisk, 'foreman_bootdisk/disks': %i[generic host full_host subnet help],

data/lib/foreman_bootdisk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ForemanBootdisk
-  VERSION = '16.1.0'
+  VERSION = '17.0.2'
 end

data/lib/tasks/bootdisk.rake

@@ -20,9 +20,10 @@ namespace :bootdisk do
     task host: :environment do
       User.as_anonymous_admin do
         host = Host::Base.unscoped.find_by(name: ENV['NAME']) || raise("cannot find host '#{ENV['NAME']}', specify NAME=fqdn")
-        tmpl = host.bootdisk_template_render
+        tmpl_bios = host.bootdisk_template_render
+        tmpl_efi = host.generic_efi_template_render
 
-        ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl, dir: outputdir) do |image|
+        ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl_bios, grub: tmpl_efi, dir: outputdir) do |image|
           output = ENV['OUTPUT'] || File.join(outputdir, "#{host.name}.iso")
           FileUtils.mv image, output
           puts "Wrote #{output}"
@@ -45,9 +46,9 @@ namespace :bootdisk do
     desc 'Generate a generic boot disk.  OUTPUT=path'
     task generic: :environment do
       User.as_anonymous_admin do
-        tmpl = ForemanBootdisk::Renderer.new.generic_template_render
+        tmpl_bios = ForemanBootdisk::Renderer.new.generic_template_render
 
-        ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl, dir: outputdir) do |image|
+        ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl_bios, dir: outputdir) do |image|
           output = ENV['OUTPUT'] || File.join(outputdir, "bootdisk_#{URI.parse(Setting[:foreman_url]).host}.iso")
           FileUtils.cp image, output
           puts "Wrote #{output}"
@@ -60,8 +61,10 @@ namespace :bootdisk do
       User.as_anonymous_admin do
         subnet = Subnet.unscoped.find_by(name: ENV['NAME']) || raise("cannot find subnet '#{ENV['NAME']}', specify NAME=subnet")
         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, dir: outputdir) do |image|
+        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)
+        ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl_bios, grub: tmpl_efi, dir: outputdir) do |image|
           output = ENV['OUTPUT'] || File.join(outputdir, "bootdisk_subnet_#{subnet.name}.iso")
           FileUtils.cp image, output
           puts "Wrote #{output}"
@@ -93,6 +96,7 @@ namespace :foreman_bootdisk do
         task.patterns = ["#{ForemanBootdisk::Engine.root}/app/**/*.rb",
                          "#{ForemanBootdisk::Engine.root}/lib/**/*.rb",
                          "#{ForemanBootdisk::Engine.root}/test/**/*.rb"]
+        task.options << '--auto-correct' if ENV['RUBOCOP_AUTOCORRECT']
       end
     rescue StandardError
       puts 'Rubocop not loaded.'

data/locale/action_names.rb

@@ -0,0 +1,5 @@
+# Autogenerated!
+_("Remote action:")
+_("Import facts")
+_("Import Puppet classes")
+_("Action with sub plans")

data/locale/ca/foreman_bootdisk.po

@@ -7,7 +7,7 @@
 # Robert Antoni Buj Gelonch <rbuj@fedoraproject.org>, 2015-2016
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_bootdisk 16.1.0\n"
+"Project-Id-Version: foreman_bootdisk 17.0.0\n"
 "Report-Msgid-Bugs-To: \n"
 "PO-Revision-Date: 2019-10-22 20:06+0000\n"
 "Last-Translator: Lukáš Zapletal\n"
@@ -55,6 +55,12 @@ msgstr ""
 msgid "Command to generate ISO image, use genisoimage or mkisofs"
 msgstr "L'ordre per generar la imatge ISO, utilitzeu genisoimage o mkisofs"
 
+msgid "Creating new image failed, install truncate utility"
+msgstr ""
+
+msgid "Detach ISO image from CDROM drive for %s"
+msgstr ""
+
 msgid "Download generic image"
 msgstr "Baixa la imatge genèrica"
 
@@ -64,9 +70,21 @@ msgstr "Baixa la imatge d'amfitrió"
 msgid "Download subnet generic image"
 msgstr "Baixa la imatge genèrica de subxarxa"
 
+msgid "Ensure %{path} contains grubx64.efi and shimx64.efi: install TFTP module or copy those files into /var/lib/foreman/bootdisk (Grub2 directory setting)"
+msgstr ""
+
 msgid "Failed to attach ISO image to CDROM drive of instance %{name}: %{message}"
 msgstr ""
 
+msgid "Failed to create a directory within the ESP image"
+msgstr ""
+
+msgid "Failed to detach ISO image from CDROM drive of instance %{name}: %{message}"
+msgstr ""
+
+msgid "Failed to format the ESP image via mkfs.msdos"
+msgstr ""
+
 msgid "Failed to generate ISO image for instance %{name}: %{message}"
 msgstr ""
 
@@ -85,6 +103,9 @@ msgstr "Imatge completa d'amfitrió"
 msgid "Generating ISO image for %s"
 msgstr ""
 
+msgid "Generic Grub2 EFI image template"
+msgstr ""
+
 msgid "Generic image"
 msgstr "Imatge genèrica"
 
@@ -94,6 +115,12 @@ msgstr ""
 msgid "Generic images are a reusable disk image that works for any host registered in Foreman.  It requires a basic DHCP and DNS service to function and contact the server, but does not require DHCP reservations or static IP addresses."
 msgstr ""
 
+msgid "Grub2 directory"
+msgstr ""
+
+msgid "Grub2 template to use for generic EFI host boot disks"
+msgstr ""
+
 msgid "Help"
 msgstr "Ajuda"
 
@@ -130,7 +157,7 @@ msgstr "No s'ha pogut construir l'ISO"
 msgid "ISO generation command"
 msgstr ""
 
-msgid "ISO hybrid conversion failed"
+msgid "ISO hybrid conversion failed: %s"
 msgstr ""
 
 msgid "ISOLINUX directory"
@@ -151,6 +178,9 @@ msgstr "Els fitxers dels mitjans d'instal·lació s'emmagatzemaran en memòria c
 msgid "Once chainloaded, the OS bootloader and installer are downloaded directly from the installation media configured in Foreman, and the provisioning script (kickstart/preseed) is downloaded from Foreman."
 msgstr ""
 
+msgid "Path to directory containing grubx64.efi and shimx64.efi"
+msgstr ""
+
 msgid "Path to directory containing iPXE images"
 msgstr "El camí al directori que conté les imatges iPXE"
 
@@ -208,10 +238,13 @@ msgstr ""
 msgid "Unable to find template specified by %s setting"
 msgstr "No es pot trobar la plantilla especificada per l'ajust %s"
 
-msgid "Unable to generate disk PXELinux template: %s"
+msgid "Unable to generate disk %{kind} template: %{error}"
+msgstr ""
+
+msgid "Unable to generate disk template, %{kind} template not found."
 msgstr ""
 
-msgid "Unable to generate disk template, PXELinux template not found."
+msgid "Unable to mcopy %{path}"
 msgstr ""
 
 msgid "Upload ISO image to datastore for %s"

data/locale/de/foreman_bootdisk.po

@@ -8,11 +8,11 @@
 # Martin Zimmermann <martin.zimmermann@gmx.com>, 2018
 # Paul Puschmann, 2014
 # abf90805572190d649c59f7a021d76cb, 2014
-# simon11 <simon.stieger.98@live.de>, 2014
-# simon11 <simon.stieger.98@live.de>, 2014
+# simon11 <transifex@stieger.co>, 2014
+# simon11 <transifex@stieger.co>, 2014
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_bootdisk 16.1.0\n"
+"Project-Id-Version: foreman_bootdisk 17.0.0\n"
 "Report-Msgid-Bugs-To: \n"
 "PO-Revision-Date: 2019-10-22 20:06+0000\n"
 "Last-Translator: Bryan Kearney <bryan.kearney@gmail.com>\n"
@@ -59,6 +59,12 @@ msgstr ""
 msgid "Command to generate ISO image, use genisoimage or mkisofs"
 msgstr "Kommando zur Erstellung von ISO-Abbildern, verwende genisoimage oder mkisofs"
 
+msgid "Creating new image failed, install truncate utility"
+msgstr ""
+
+msgid "Detach ISO image from CDROM drive for %s"
+msgstr ""
+
 msgid "Download generic image"
 msgstr "Generisches Abbild herunterladen"
 
@@ -68,9 +74,21 @@ msgstr "Host-Abbild herunterladen"
 msgid "Download subnet generic image"
 msgstr "Generisches Abbild von Subnetz herunterladen"
 
+msgid "Ensure %{path} contains grubx64.efi and shimx64.efi: install TFTP module or copy those files into /var/lib/foreman/bootdisk (Grub2 directory setting)"
+msgstr ""
+
 msgid "Failed to attach ISO image to CDROM drive of instance %{name}: %{message}"
 msgstr "Fehler beim Einhängen des ISO-Abbild am CDROM-Laufwerk für Instanz %{name}: %{message}"
 
+msgid "Failed to create a directory within the ESP image"
+msgstr ""
+
+msgid "Failed to detach ISO image from CDROM drive of instance %{name}: %{message}"
+msgstr ""
+
+msgid "Failed to format the ESP image via mkfs.msdos"
+msgstr ""
+
 msgid "Failed to generate ISO image for instance %{name}: %{message}"
 msgstr "Fehler beim Erzeugen des ISO-Abbild für Instanz %{name}: %{message}"
 
@@ -89,6 +107,9 @@ msgstr "Vollständiges Host-Abbild"
 msgid "Generating ISO image for %s"
 msgstr "ISO-Abbild für %s wird erzeugt"
 
+msgid "Generic Grub2 EFI image template"
+msgstr ""
+
 msgid "Generic image"
 msgstr "Generisches Abbild"
 
@@ -98,6 +119,12 @@ msgstr "Generische Abbildvorlage"
 msgid "Generic images are a reusable disk image that works for any host registered in Foreman.  It requires a basic DHCP and DNS service to function and contact the server, but does not require DHCP reservations or static IP addresses."
 msgstr "Generische Abbilder sind wiederverwendbare Festplattenabbilder die für beliebige in Foreman registrierte Hosts funktionieren. Sie erfordern einen einfachen DHCP- und DNS-Service, um zu funktionieren und den Server zu kontaktieren. Jedoch benötigen sie keinerlei DHCP-Reservierungen oder statische IP-Adressen."
 
+msgid "Grub2 directory"
+msgstr ""
+
+msgid "Grub2 template to use for generic EFI host boot disks"
+msgstr ""
+
 msgid "Help"
 msgstr "Hilfe"
 
@@ -134,8 +161,8 @@ msgstr "ISO-Erstellung fehlgeschlagen"
 msgid "ISO generation command"
 msgstr "ISO-Erzeugungsbefehl"
 
-msgid "ISO hybrid conversion failed"
-msgstr "ISO hybrid Konvertierung fehlgeschlagen"
+msgid "ISO hybrid conversion failed: %s"
+msgstr ""
 
 msgid "ISOLINUX directory"
 msgstr "ISOLINUX-Verzeichnis"
@@ -155,6 +182,9 @@ msgstr "Installationsmedien-Dateien werden für vollständige Host-Images zwisch
 msgid "Once chainloaded, the OS bootloader and installer are downloaded directly from the installation media configured in Foreman, and the provisioning script (kickstart/preseed) is downloaded from Foreman."
 msgstr "Sobald sie nacheinander geladen (Chainloading) sind, werden der OS-Bootloader und das OS-Installationsprogramm direkt von den in Foreman konfigurierten Installationsmedien heruntergeladen, und das Bereitstellungsskript (kickstart/preseed) wird von Foreman heruntergeladen."
 
+msgid "Path to directory containing grubx64.efi and shimx64.efi"
+msgstr ""
+
 msgid "Path to directory containing iPXE images"
 msgstr "Pfad zum Verzeichnis mit iPXE-Abbildern"
 
@@ -212,10 +242,13 @@ msgstr "\"True\" für vollständiges, \"false\" für einfaches wiederverwendbare
 msgid "Unable to find template specified by %s setting"
 msgstr "Konnte Vorlage mit der %s-Einstellung nicht finden"
 
-msgid "Unable to generate disk PXELinux template: %s"
+msgid "Unable to generate disk %{kind} template: %{error}"
+msgstr ""
+
+msgid "Unable to generate disk template, %{kind} template not found."
 msgstr ""
 
-msgid "Unable to generate disk template, PXELinux template not found."
+msgid "Unable to mcopy %{path}"
 msgstr ""
 
 msgid "Upload ISO image to datastore for %s"

data/locale/en/foreman_bootdisk.po

@@ -4,7 +4,7 @@
 #
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_bootdisk 16.1.0\n"
+"Project-Id-Version: foreman_bootdisk 17.0.0\n"
 "Report-Msgid-Bugs-To: \n"
 "PO-Revision-Date: 2014-02-13 12:09+0000\n"
 "Last-Translator: Dominic Cleal <dcleal@redhat.com>\n"
@@ -51,6 +51,12 @@ msgstr ""
 msgid "Command to generate ISO image, use genisoimage or mkisofs"
 msgstr ""
 
+msgid "Creating new image failed, install truncate utility"
+msgstr ""
+
+msgid "Detach ISO image from CDROM drive for %s"
+msgstr ""
+
 msgid "Download generic image"
 msgstr ""
 
@@ -60,9 +66,21 @@ msgstr ""
 msgid "Download subnet generic image"
 msgstr ""
 
+msgid "Ensure %{path} contains grubx64.efi and shimx64.efi: install TFTP module or copy those files into /var/lib/foreman/bootdisk (Grub2 directory setting)"
+msgstr ""
+
 msgid "Failed to attach ISO image to CDROM drive of instance %{name}: %{message}"
 msgstr ""
 
+msgid "Failed to create a directory within the ESP image"
+msgstr ""
+
+msgid "Failed to detach ISO image from CDROM drive of instance %{name}: %{message}"
+msgstr ""
+
+msgid "Failed to format the ESP image via mkfs.msdos"
+msgstr ""
+
 msgid "Failed to generate ISO image for instance %{name}: %{message}"
 msgstr ""
 
@@ -81,6 +99,9 @@ msgstr ""
 msgid "Generating ISO image for %s"
 msgstr ""
 
+msgid "Generic Grub2 EFI image template"
+msgstr ""
+
 msgid "Generic image"
 msgstr ""
 
@@ -90,6 +111,12 @@ msgstr ""
 msgid "Generic images are a reusable disk image that works for any host registered in Foreman.  It requires a basic DHCP and DNS service to function and contact the server, but does not require DHCP reservations or static IP addresses."
 msgstr ""
 
+msgid "Grub2 directory"
+msgstr ""
+
+msgid "Grub2 template to use for generic EFI host boot disks"
+msgstr ""
+
 msgid "Help"
 msgstr ""
 
@@ -126,7 +153,7 @@ msgstr ""
 msgid "ISO generation command"
 msgstr ""
 
-msgid "ISO hybrid conversion failed"
+msgid "ISO hybrid conversion failed: %s"
 msgstr ""
 
 msgid "ISOLINUX directory"
@@ -147,6 +174,9 @@ msgstr ""
 msgid "Once chainloaded, the OS bootloader and installer are downloaded directly from the installation media configured in Foreman, and the provisioning script (kickstart/preseed) is downloaded from Foreman."
 msgstr ""
 
+msgid "Path to directory containing grubx64.efi and shimx64.efi"
+msgstr ""
+
 msgid "Path to directory containing iPXE images"
 msgstr ""
 
@@ -204,10 +234,13 @@ msgstr ""
 msgid "Unable to find template specified by %s setting"
 msgstr ""
 
-msgid "Unable to generate disk PXELinux template: %s"
+msgid "Unable to generate disk %{kind} template: %{error}"
+msgstr ""
+
+msgid "Unable to generate disk template, %{kind} template not found."
 msgstr ""
 
-msgid "Unable to generate disk template, PXELinux template not found."
+msgid "Unable to mcopy %{path}"
 msgstr ""
 
 msgid "Upload ISO image to datastore for %s"