foreman_bootdisk 3.1.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24ff51f73764abf0b48731a7c2d4018a5dd59cf6
-  data.tar.gz: c5414e2c0ff9241370135e860dd01d23cb613e6d
+  metadata.gz: 6e2545c008aab7752ca6a9a396bb6f07c247872c
+  data.tar.gz: 7f99466c2e65a501e9d4e851c185f3f246e18e15
 SHA512:
-  metadata.gz: a7faca8fbfe243f267fc11b8ebdc44d81710f27e96f91ff3d766fc603630d8bffbeb50b278fd2be15f97a84360018631e3be1723b04f45488861db162b56ae44
-  data.tar.gz: a2101a383d14e19352074004d42bce2ba2c4519951a042820281eea2fc93504e70cc466d3e7f6e0c6220742a7dafdbf683595f0a244384b4e5136c090d0430d7
+  metadata.gz: 769076ee4275b5199c9d42a56deb210f07f2e3979e145bd2ad467334e0f2da1289e02cbe607fc14677dd844c2d1200291cacf1718278f7df7cbc179ad157cb0f
+  data.tar.gz: 2f0b7e4043d7207b335ca985dbd72c4b4400dcdf7a1c61be52bfac8f837564a0dd6d9064cccb44fbbc6f7377eebe481bc3b70ec2fbee53a40b1963fb656843ca

data/CHANGES.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v3.1.2
+* add help page
+* rearrange README to be clearer about basic vs advanced config
+* fix safemode error when IP/subnet details were nil, not empty strings
+* disable debug logging of disk download responses
+
 ## v3.1.1
 * package .mo files for i18n support (#7153)
 

data/README.md

@@ -81,27 +81,6 @@ this:
 
 Foreman's default kickstart and preseed files are ready to use.
 
-### Customising boot disk templates
-
-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 Administer>Settings>Bootdisk.
-
-* `bootdisk_host_template` is the name of the per-host boot disk template
-* `bootdisk_generic_host_template` is the name of the generic boot disk template
-
-These templates are baked into the downloaded ISO files and generally don't
-need to be modified.
-
-## Settings
-
-Some more advanced settings are available 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
-* `bootdisk_mkiso_command` is the name of genisoimage/mkisofs on your OS
-
 ## Available images
 
 The image types have trade-offs, but are all meant for environments without
@@ -194,6 +173,29 @@ as disks too, suitable for copying to a USB device.
 Use `dd if=fqdn.iso of=/dev/sdb` or similar to copy the image to a USB disk.
 Ensure the device name is correct to avoid writing over the wrong disk.
 
+## Advanced configuration
+
+### Customising boot disk templates
+
+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 Administer>Settings>Bootdisk.
+
+* `bootdisk_host_template` is the name of the per-host boot disk template
+* `bootdisk_generic_host_template` is the name of the generic boot disk template
+
+These templates are baked into the downloaded ISO files and generally don't
+need to be modified.
+
+### Settings
+
+Some more advanced settings are available 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
+* `bootdisk_mkiso_command` is the name of genisoimage/mkisofs on your OS
+
 # Issues
 
 Report issues on the Redmine project: [foreman_bootdisk](http://projects.theforeman.org/projects/bootdisk/issues/new)

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

@@ -11,6 +11,7 @@ module ForemanBootdisk
         end
 
         before_filter :find_host, :only => :host
+        skip_after_filter :log_response_body
 
         # no-op, but required for apipie documentation
         api :GET, '', N_('Boot disks')

data/app/controllers/foreman_bootdisk/disks_controller.rb

@@ -33,6 +33,9 @@ module ForemanBootdisk
       end
     end
 
+    def help
+    end
+
     private
 
     def resource_base

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

@@ -10,7 +10,8 @@ module ForemanBootdisk::HostsHelperExt
       button_group(
         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(_("Generic image"), {:controller => 'foreman_bootdisk/disks', :action => 'generic'}, :class=>'btn')
+          display_bootdisk_link_if_authorized(_("Generic image"), {:controller => 'foreman_bootdisk/disks', :action => 'generic'}, :class=>'btn'),
+          display_bootdisk_link_if_authorized(_("Help"), {:controller => 'foreman_bootdisk/disks', :action => 'help'}, :class=>'btn')
         )
       )
     )

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

@@ -0,0 +1,27 @@
+<% title _("Boot disks") %>
+<%= title_actions link_to(_('Back'), :back) %>
+
+<div id="welcome">
+  <p>
+    <%= _('Various types of boot disks can be created to provision hosts without the need for PXE services.  Boot disks can be attached to the host (physical or virtual) which boots from the disk, contacts Foreman and begins the OS installation.') %>
+  </p>
+  <p>
+    <%= _('All images are usable as either ISOs or as disk images, including being written to a USB disk with `dd`.') %>
+  </p>
+
+  <h2><%= _('Host image') %></h2>
+  <p>
+    <%= _("Per-host images contain data about a particular host registered in Foreman and set up fully static networking, avoiding the requirement for DHCP.  After networking is configured, they chainload from Foreman, picking up the current OS configuration and build state from the server.") %>
+  </p>
+  <p>
+    <%= _("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.") %>
+  </p>
+
+  <h2><%= _('Generic image') %></h2>
+  <p>
+    <%= _('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.') %>
+  </p>
+  <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>
+</div>

data/app/views/foreman_bootdisk/host.erb

@@ -5,11 +5,11 @@
 # Copy this template to customize it, the original is read-only.
 
 <%
-bootdisk_raise(N_('Host has no IP address defined')) if @host.ip.empty?
+bootdisk_raise(N_('Host has no IP address defined')) if @host.ip.nil? || @host.ip.empty?
 bootdisk_raise(N_('Host has no subnet defined')) unless @host.subnet
 bootdisk_raise(N_('Host has no domain defined')) unless @host.domain
-bootdisk_raise(N_('Subnet (%s) has no gateway defined'), @host.subnet) if @host.subnet.gateway.empty?
-bootdisk_raise(N_('Subnet (%s) has no primary DNS server defined'), @host.subnet) if @host.subnet.dns_primary.empty?
+bootdisk_raise(N_('Subnet (%s) has no gateway defined'), @host.subnet) if @host.subnet.gateway.nil? || @host.subnet.gateway.empty?
+bootdisk_raise(N_('Subnet (%s) has no primary DNS server defined'), @host.subnet) if @host.subnet.dns_primary.nil? || @host.subnet.dns_primary.empty?
 %>
 
 # loop over net* until the host's MAC matches

data/config/routes.rb

@@ -1,6 +1,7 @@
 ForemanBootdisk::Engine.routes.draw do
   resources :disks, :only => [] do
     get 'generic', :on => :collection
+    get 'help', :on => :collection
     constraints(:id => /[^\/]+/) do
       get 'hosts/:id', :on => :collection, :to => 'disks#host'
     end

data/lib/foreman_bootdisk/engine.rb

@@ -32,7 +32,7 @@ module ForemanBootdisk
         requires_foreman '>= 1.6'
 
         security_block :bootdisk do |map|
-          permission :download_bootdisk, {:'foreman_bootdisk/disks' => [:generic, :host],
+          permission :download_bootdisk, {:'foreman_bootdisk/disks' => [:generic, :host, :help],
                                           :'foreman_bootdisk/api/v2/disks' => [:generic, :host]}
         end
 

data/lib/foreman_bootdisk/version.rb

@@ -1,3 +1,3 @@
 module ForemanBootdisk
-  VERSION = '3.1.1'
+  VERSION = '3.1.2'
 end

data/locale/de/foreman_bootdisk.po

@@ -7,7 +7,7 @@
 # simon11 <simon.stieger.98@live.de>, 2014
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_bootdisk 3.1.0\n"
+"Project-Id-Version: foreman_bootdisk 3.1.1\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2014-08-08 13:53+0100\n"
 "PO-Revision-Date: 2014-08-09 08:59+0000\n"

data/locale/en/foreman_bootdisk.po

@@ -5,9 +5,9 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_bootdisk 3.1.0\n"
+"Project-Id-Version: foreman_bootdisk 3.1.1\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2014-08-08 13:53+0100\n"
+"POT-Creation-Date: 2014-09-03 12:20+0100\n"
 "PO-Revision-Date: 2014-02-13 12:09+0000\n"
 "Last-Translator: Dominic Cleal <dcleal@redhat.com>\n"
 "Language-Team: Foreman Team <foreman-dev@googlegroups.com>\n"
@@ -17,6 +17,12 @@ msgstr ""
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n"
 
+msgid "All images are usable as either ISOs or as disk images, including being written to a USB disk with `dd`."
+msgstr ""
+
+msgid "Back"
+msgstr ""
+
 msgid "Boot disk"
 msgstr ""
 
@@ -41,6 +47,12 @@ msgstr ""
 msgid "Generic image"
 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 "Help"
+msgstr ""
+
 msgid "Host '%s' image"
 msgstr ""
 
@@ -53,18 +65,27 @@ msgstr ""
 msgid "Host has no subnet defined"
 msgstr ""
 
+msgid "Host image"
+msgstr ""
+
 msgid "ISO build failed"
 msgstr ""
 
 msgid "ISO hybrid conversion failed"
 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 iPXE images"
 msgstr ""
 
 msgid "Path to directory containing syslinux images"
 msgstr ""
 
+msgid "Per-host images contain data about a particular host registered in Foreman and set up fully static networking, avoiding the requirement for DHCP.  After networking is configured, they chainload from Foreman, picking up the current OS configuration and build state from the server."
+msgstr ""
+
 msgid "Please ensure the ipxe-bootimgs and syslinux packages are installed."
 msgstr ""
 
@@ -77,9 +98,15 @@ msgstr ""
 msgid "Subnet (%s) has no primary DNS server defined"
 msgstr ""
 
+msgid "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."
+msgstr ""
+
 msgid "Unable to find template specified by %s setting"
 msgstr ""
 
+msgid "Various types of boot disks can be created to provision hosts without the need for PXE services.  Boot disks can be attached to the host (physical or virtual) which boots from the disk, contacts Foreman and begins the OS installation."
+msgstr ""
+
 msgid "iPXE template to use for generic host boot disks"
 msgstr ""
 

data/locale/en_GB/foreman_bootdisk.po

@@ -6,7 +6,7 @@
 # Dominic Cleal <dcleal@redhat.com>, 2014
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_bootdisk 3.1.0\n"
+"Project-Id-Version: foreman_bootdisk 3.1.1\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2014-08-08 13:53+0100\n"
 "PO-Revision-Date: 2014-08-09 08:59+0000\n"

data/locale/es/foreman_bootdisk.po

@@ -6,11 +6,11 @@
 # Sergio Ocón <sergio@redhat.com>, 2014
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_bootdisk 3.1.0\n"
+"Project-Id-Version: foreman_bootdisk 3.1.1\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2014-08-08 13:53+0100\n"
-"PO-Revision-Date: 2014-08-09 08:59+0000\n"
-"Last-Translator: Lukáš Zapletal\n"
+"PO-Revision-Date: 2014-08-28 10:12+0000\n"
+"Last-Translator: Sergio Ocón <sergio@redhat.com>\n"
 "Language-Team: Spanish (http://www.transifex.com/projects/p/foreman/language/es/)\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
@@ -22,7 +22,7 @@ msgid "Boot disk"
 msgstr "Disco de arranque"
 
 msgid "Boot disks"
-msgstr ""
+msgstr "Discos de arranque"
 
 msgid ""
 "Bootdisk is not supported with safemode rendering, please disable "
@@ -33,10 +33,10 @@ msgid "Command to generate ISO image, use genisoimage or mkisofs"
 msgstr "Comando para generar una imagen ISO, use genisoimage o mkisofs"
 
 msgid "Download generic image"
-msgstr ""
+msgstr "Descargar imagen genérica"
 
 msgid "Download host image"
-msgstr ""
+msgstr "Descargar imagen de host"
 
 msgid "Failed to render boot disk template: %s"
 msgstr "Fallo en la entrega de la plantilla del disco de arranque: %s"

data/locale/foreman_bootdisk.pot

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: version 0.0.1\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2014-08-08 13:53+0100\n"
+"POT-Creation-Date: 2014-09-03 12:20+0100\n"
 "PO-Revision-Date: 2014-02-13 12:09+0000\n"
 "Last-Translator: Dominic Cleal <dcleal@redhat.com>\n"
 "Language-Team: Foreman Team <foreman-dev@googlegroups.com>\n"
@@ -17,6 +17,12 @@ msgstr ""
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n"
 
+msgid "All images are usable as either ISOs or as disk images, including being written to a USB disk with `dd`."
+msgstr ""
+
+msgid "Back"
+msgstr ""
+
 msgid "Boot disk"
 msgstr ""
 
@@ -41,6 +47,12 @@ msgstr ""
 msgid "Generic image"
 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 "Help"
+msgstr ""
+
 msgid "Host '%s' image"
 msgstr ""
 
@@ -53,18 +65,27 @@ msgstr ""
 msgid "Host has no subnet defined"
 msgstr ""
 
+msgid "Host image"
+msgstr ""
+
 msgid "ISO build failed"
 msgstr ""
 
 msgid "ISO hybrid conversion failed"
 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 iPXE images"
 msgstr ""
 
 msgid "Path to directory containing syslinux images"
 msgstr ""
 
+msgid "Per-host images contain data about a particular host registered in Foreman and set up fully static networking, avoiding the requirement for DHCP.  After networking is configured, they chainload from Foreman, picking up the current OS configuration and build state from the server."
+msgstr ""
+
 msgid "Please ensure the ipxe-bootimgs and syslinux packages are installed."
 msgstr ""
 
@@ -77,9 +98,15 @@ msgstr ""
 msgid "Subnet (%s) has no primary DNS server defined"
 msgstr ""
 
+msgid "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."
+msgstr ""
+
 msgid "Unable to find template specified by %s setting"
 msgstr ""
 
+msgid "Various types of boot disks can be created to provision hosts without the need for PXE services.  Boot disks can be attached to the host (physical or virtual) which boots from the disk, contacts Foreman and begins the OS installation."
+msgstr ""
+
 msgid "iPXE template to use for generic host boot disks"
 msgstr ""
 

data/locale/fr/foreman_bootdisk.po

@@ -7,7 +7,7 @@
 # Pierre-Emmanuel Dutang <dutangp@gmail.com>, 2014
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_bootdisk 3.1.0\n"
+"Project-Id-Version: foreman_bootdisk 3.1.1\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2014-08-08 13:53+0100\n"
 "PO-Revision-Date: 2014-08-19 15:21+0000\n"

data/locale/pt_BR/foreman_bootdisk.po

@@ -5,7 +5,7 @@
 # Translators:
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_bootdisk 3.1.0\n"
+"Project-Id-Version: foreman_bootdisk 3.1.1\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2014-08-08 13:53+0100\n"
 "PO-Revision-Date: 2014-08-09 08:59+0000\n"

data/locale/sv_SE/foreman_bootdisk.po

@@ -6,11 +6,11 @@
 # johnny.westerlund <johnny.westerlund@gmail.com>, 2014
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_bootdisk 3.1.0\n"
+"Project-Id-Version: foreman_bootdisk 3.1.1\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2014-08-08 13:53+0100\n"
-"PO-Revision-Date: 2014-08-09 08:59+0000\n"
-"Last-Translator: Lukáš Zapletal\n"
+"PO-Revision-Date: 2014-08-26 11:41+0000\n"
+"Last-Translator: johnny.westerlund <johnny.westerlund@gmail.com>\n"
 "Language-Team: Swedish (Sweden) (http://www.transifex.com/projects/p/foreman/language/sv_SE/)\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
@@ -22,7 +22,7 @@ msgid "Boot disk"
 msgstr "Startdisk"
 
 msgid "Boot disks"
-msgstr ""
+msgstr "Startdiskar"
 
 msgid ""
 "Bootdisk is not supported with safemode rendering, please disable "
@@ -33,10 +33,10 @@ msgid "Command to generate ISO image, use genisoimage or mkisofs"
 msgstr "Kommando för att generera ISO-avbildningar, använd genisoimage eller mkisofs"
 
 msgid "Download generic image"
-msgstr ""
+msgstr "Ladda ner generisk avbildning"
 
 msgid "Download host image"
-msgstr ""
+msgstr "Ladda ner värd avbildning"
 
 msgid "Failed to render boot disk template: %s"
 msgstr "Misslyckades att tolka startdiskmallen: %s"
@@ -74,7 +74,7 @@ msgstr "Vär vänlig och säkerställ att ipxe-startavbildningarna och syslinux
 msgid ""
 "Plugin for Foreman that creates iPXE-based boot disks to provision hosts "
 "without the need for PXE infrastructure."
-msgstr ""
+msgstr "Plugin för Foreman som skapar iPXE-baserad start disk för att provisionera värdar utan en existerande PXE-infrastruktur."
 
 msgid "Subnet (%s) has no gateway defined"
 msgstr "Subnät (%s) har ingen nätsluss definierad"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_bootdisk
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.2
 platform: ruby
 authors:
 - Dominic Cleal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-20 00:00:00.000000000 Z
+date: 2014-09-03 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.
@@ -33,6 +33,7 @@ files:
 - app/models/setting/bootdisk.rb
 - app/services/foreman_bootdisk/iso_generator.rb
 - app/services/foreman_bootdisk/renderer.rb
+- app/views/foreman_bootdisk/disks/help.html.erb
 - app/views/foreman_bootdisk/generic_host.erb
 - app/views/foreman_bootdisk/host.erb
 - config/routes.rb