Puppet Class: ironic::drivers::pxe

Inherits:
ironic::params
Defined in:
manifests/drivers/pxe.pp

Overview

Configure the PXE driver in Ironic

Parameters

kernel_append_params

(optional) Additional append parameters for baremetal PXE boot. Should be valid pxe parameters Defaults to $facts.

pxe_bootfile_name

(optional) Bootfile DHCP parameter. If not set, its value is detected. Defaults to $facts.

pxe_config_template

(optional) Template file for PXE configuration. If set, should be an valid template file. Otherwise, its value is detected. Defaults to $facts.

ipxe_bootfile_name

(optional) Bootfile DHCP parameter when the ipxe boot interface is set for a baremetal node. If not set, its value is detected. Defaults to $facts.

ipxe_config_template

(optional) Template file for PXE configuration with the iPXE boot interface. If set, should be an valid template file. Otherwise, its value is detected. Defaults to $facts.

tftp_server

(optional) IP address of Ironic compute node’s tftp server. Should be an valid IP address Defaults to $facts.

tftp_root

(optional) Ironic compute node’s tftp root path. Should be an valid path Defaults to ‘/tftpboot’.

images_path

(optional) Directory where images are stored on disk. Should be an valid directory Defaults to $facts.

tftp_master_path

(optional) Directory where master tftp images are stored on disk. Should be an valid directory Defaults to $facts.

instance_master_path

(optional) Directory where master tftp images are stored on disk. Should be an valid directory Defaults to $facts.

uefi_pxe_bootfile_name

(optional) Bootfile DHCP parameter for UEFI boot mode for the pxe boot interface. No separate configuration template is required when using ipxe. Defaults to bootx64.efi, which will be the signed shim that loads grub for a network boot.

uefi_pxe_config_template

(optional) Template file for PXE configuration for UEFI boot loader. Defaults to $facts.

uefi_ipxe_bootfile_name

(optional) Bootfile DHCP parameter for UEFI boot mode for the ipxe boot interface. No separate configuration template is required when using ipxe. Defaults to $::ironic::params::uefi_ipxe_bootfile_name

ipxe_timeout

(optional) ipxe timeout in second. Should be an valid integer Defaults to $facts.

enable_ppc64le

(optional) Boolean value to dtermine if ppc64le support should be enabled Defaults to false (no ppc64le support)

boot_retry_timeout

(optional) Timeout (in seconds) after which PXE boot should be retried. Defaults to $facts.

boot_retry_check_interval

(optional) How often (in seconds) to check for PXE boot status. Defaults to $facts.

dir_permission

(optional) THe permission that will be applied to the TFTP folders upon creation. Defaults to $facts.

file_permission

(optional) The permission which is used on files created as part of configuration and setup of file assets for PXE based operations. Defaults to $facts.

loader_file_paths

(optional) Dictionary describing the bootloaders to load into conductor PXE/iXPE boot folders values from the host operating system. Defaults to $facts.

DEPRECATED PARAMETERS

ip_version

DEPRECATED: (optional) The IP version that will be used for PXE booting. Ironic presently attempts both IPv4 and IPv6, this option is effectively ignored by ironic, and should anticipate being removed in a future release. Defaults to $facts.

Parameters:

  • kernel_append_params (Any) (defaults to: $facts['os_service_default'])
  • pxe_bootfile_name (Any) (defaults to: $facts['os_service_default'])
  • pxe_config_template (Any) (defaults to: $facts['os_service_default'])
  • ipxe_bootfile_name (Any) (defaults to: $facts['os_service_default'])
  • ipxe_config_template (Any) (defaults to: $facts['os_service_default'])
  • tftp_server (Any) (defaults to: $facts['os_service_default'])
  • tftp_root (Any) (defaults to: '/tftpboot')
  • images_path (Any) (defaults to: $facts['os_service_default'])
  • tftp_master_path (Any) (defaults to: $facts['os_service_default'])
  • instance_master_path (Any) (defaults to: $facts['os_service_default'])
  • uefi_pxe_bootfile_name (Any) (defaults to: $::ironic::params::uefi_pxe_bootfile_name)
  • uefi_pxe_config_template (Any) (defaults to: $facts['os_service_default'])
  • uefi_ipxe_bootfile_name (Any) (defaults to: $::ironic::params::uefi_ipxe_bootfile_name)
  • ipxe_timeout (Any) (defaults to: $facts['os_service_default'])
  • enable_ppc64le (Boolean) (defaults to: false)
  • boot_retry_timeout (Any) (defaults to: $facts['os_service_default'])
  • boot_retry_check_interval (Any) (defaults to: $facts['os_service_default'])
  • dir_permission (Any) (defaults to: $facts['os_service_default'])
  • file_permission (Any) (defaults to: $facts['os_service_default'])
  • loader_file_paths (Any) (defaults to: $facts['os_service_default'])
  • ip_version (Any) (defaults to: undef) 


131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'manifests/drivers/pxe.pp', line 131

class ironic::drivers::pxe (
  $kernel_append_params      = $facts['os_service_default'],
  $pxe_bootfile_name         = $facts['os_service_default'],
  $pxe_config_template       = $facts['os_service_default'],
  $ipxe_bootfile_name        = $facts['os_service_default'],
  $ipxe_config_template      = $facts['os_service_default'],
  $tftp_server               = $facts['os_service_default'],
  $tftp_root                 = '/tftpboot',
  $images_path               = $facts['os_service_default'],
  $tftp_master_path          = $facts['os_service_default'],
  $instance_master_path      = $facts['os_service_default'],
  $uefi_pxe_bootfile_name    = $::ironic::params::uefi_pxe_bootfile_name,
  $uefi_pxe_config_template  = $facts['os_service_default'],
  $uefi_ipxe_bootfile_name   = $::ironic::params::uefi_ipxe_bootfile_name,
  $ipxe_timeout              = $facts['os_service_default'],
  Boolean $enable_ppc64le    = false,
  $boot_retry_timeout        = $facts['os_service_default'],
  $boot_retry_check_interval = $facts['os_service_default'],
  $dir_permission            = $facts['os_service_default'],
  $file_permission           = $facts['os_service_default'],
  $loader_file_paths         = $facts['os_service_default'],
  # DEPRECATED PARAMETERS
  $ip_version                = undef,
) inherits ironic::params {

  include ironic::deps

  include ironic::pxe::common
  $tftp_root_real               = pick($::ironic::pxe::common::tftp_root, $tftp_root)
  $ipxe_timeout_real            = pick($::ironic::pxe::common::ipxe_timeout, $ipxe_timeout)
  $uefi_ipxe_bootfile_name_real = pick($::ironic::pxe::common::uefi_ipxe_bootfile_name, $uefi_ipxe_bootfile_name)
  $uefi_pxe_bootfile_name_real = pick($::ironic::pxe::common::uefi_pxe_bootfile_name, $uefi_pxe_bootfile_name)

  if $ip_version != undef {
    warning('The ironic::drivers::pxe:ip_version parameter is deprecated and will be removed in the future.')
  }
  $ip_version_real = pick($ip_version, $facts['os_service_default'])

  # Configure ironic.conf
  ironic_config {
    'pxe/kernel_append_params': value      => $kernel_append_params;
    'pxe/pxe_bootfile_name': value         => $pxe_bootfile_name;
    'pxe/pxe_config_template': value       => $pxe_config_template;
    'pxe/ipxe_bootfile_name': value        => $ipxe_bootfile_name;
    'pxe/ipxe_config_template': value      => $ipxe_config_template;
    'pxe/tftp_server': value               => $tftp_server;
    'pxe/tftp_root': value                 => $tftp_root_real;
    'pxe/images_path': value               => $images_path;
    'pxe/tftp_master_path': value          => $tftp_master_path;
    'pxe/instance_master_path': value      => $instance_master_path;
    'pxe/uefi_pxe_bootfile_name': value    => $uefi_pxe_bootfile_name_real;
    'pxe/uefi_pxe_config_template': value  => $uefi_pxe_config_template;
    'pxe/uefi_ipxe_bootfile_name': value   => $uefi_ipxe_bootfile_name_real;
    'pxe/ipxe_timeout': value              => $ipxe_timeout_real;
    'pxe/boot_retry_timeout': value        => $boot_retry_timeout;
    'pxe/boot_retry_check_interval': value => $boot_retry_check_interval;
    'pxe/dir_permission': value            => $dir_permission;
    'pxe/file_permission': value           => $file_permission;
    'pxe/loader_file_paths': value         => join(any2array($loader_file_paths), ',');
    'pxe/ipxe_enabled': ensure             => absent;
    'pxe/ip_version': value                => $ip_version_real;
  }

  if $enable_ppc64le {
    # FXIME(tonyb): As these are really hash values it would be better to model
    # them that way.  We can do that later, probably when we add another
    # architecture
    ironic_config {
      # NOTE(tonyb): This first value shouldn't be needed but seems to be?
      # NOTE(TheJulia): Likely not needed as this just points to the default,
      # and when the explicit pxe driver is used everything should fall to
      # it but in the interest of minimizing impact, the output result
      # is preserved as we now just allow the default for normal template
      # operation to be used.
      'pxe/pxe_config_template_by_arch': value => 'ppc64le:$pybasedir/drivers/modules/pxe_config.template';
      'pxe/pxe_bootfile_name_by_arch': value   => 'ppc64le:config';
    }
  }

}