ironic/doc/source/admin/drivers/redfish.rst

Redfish driver

Overview

The redfish driver enables managing servers compliant with the Redfish protocol.

Prerequisites

• The Sushy library should be installed on the ironic conductor node(s).

  For example, it can be installed with pip:

  sudo pip install sushy

Enabling the Redfish driver

1. Add redfish to the list of enabled_hardware_types, enabled_power_interfaces, enabled_management_interfaces and enabled_inspect_interfaces as well as redfish-virtual-media to enabled_boot_interfaces in /etc/ironic/ironic.conf. For example:

   [DEFAULT]
   ...
   enabled_hardware_types = ipmi,redfish
   enabled_boot_interfaces = ipmitool,redfish-virtual-media
   enabled_power_interfaces = ipmitool,redfish
   enabled_management_interfaces = ipmitool,redfish
   enabled_inspect_interfaces = inspector,redfish

2. Restart the ironic conductor service:

   sudo service ironic-conductor restart
   
   # Or, for RDO:
   sudo systemctl restart openstack-ironic-conductor

Registering a node with the Redfish driver

Nodes configured to use the driver should have the driver property set to redfish.

The following properties are specified in the node's driver_info field:

• redfish_address: The URL address to the Redfish controller. It must

  include the authority portion of the URL, and can optionally include the scheme. If the scheme is missing, https is assumed. For example: https://mgmt.vendor.com. This is required.

• redfish_system_id: The canonical path to the ComputerSystem resource

  that the driver will interact with. It should include the root service, version and the unique resource path to the ComputerSystem. This property is only required if target BMC manages more than one ComputerSystem. Otherwise ironic will pick the only available ComputerSystem automatically. For example: /redfish/v1/Systems/1.

• redfish_username: User account with admin/server-profile access

  privilege. Although not required, it is highly recommended.

• redfish_password: User account password. Although not required, it is

  highly recommended.

• redfish_verify_ca: If redfish_address has the https scheme, the

  driver will use a secure (TLS) connection when talking to the Redfish controller. By default (if this is not set or set to True), the driver will try to verify the host certificates. This can be set to the path of a certificate file or directory with trusted certificates that the driver will use for verification. To disable verifying TLS, set this to False. This is optional.

• redfish_auth_type: Redfish HTTP client authentication method. Can be

  "basic", "session" or "auto". The "auto" mode first tries "session" and falls back to "basic" if session authentication is not supported by the Redfish BMC. Default is set in ironic config as [redfish]auth_type.

The openstack baremetal node create command can be used to enroll a node with the redfish driver. For example:

openstack baremetal node create --driver redfish --driver-info \
  redfish_address=https://example.com --driver-info \
  redfish_system_id=/redfish/v1/Systems/CX34R87 --driver-info \
  redfish_username=admin --driver-info redfish_password=password \
  --name node-0

For more information about enrolling nodes see enrollment in the install guide.

Features of the redfish hardware type

Boot mode support

The redfish hardware type can read current boot mode from the bare metal node as well as set it to either Legacy BIOS or UEFI.

Note

Boot mode management is the optional part of the Redfish specification. Not all Redfish-compliant BMCs might implement it. In that case it remains the responsibility of the operator to configure proper boot mode to their bare metal nodes.

Out-Of-Band inspection

The redfish hardware type can inspect the bare metal node by querying Redfish compatible BMC. This process is quick and reliable compared to the way the inspector hardware type works i.e. booting bare metal node into the introspection ramdisk.

Note

The redfish inspect interface relies on the optional parts of the Redfish specification. Not all Redfish-compliant BMCs might serve the required information, in which case bare metal node inspection will fail.

Note

The local_gb property cannot always be discovered, for example, when a node does not have local storage or the Redfish implementation does not support the required schema. In this case the property will be set to 0.

Virtual media boot

The idea behind virtual media boot is that BMC gets hold of the boot image one way or the other (e.g. by HTTP GET, other methods are defined in the standard), then "inserts" it into node's virtual drive as if it was burnt on a physical CD/DVD. The node can then boot from that virtual drive into the operating system residing on the image.

The major advantage of virtual media boot feature is that potentially unreliable TFTP image transfer phase of PXE protocol suite is fully eliminated.

Hardware types based on the redfish fully support booting deploy/rescue and user images over virtual media. Ironic builds bootable ISO images, for either UEFI or BIOS (Legacy) boot modes, at the moment of node deployment out of kernel and ramdisk images associated with the ironic node.

To boot a node managed by redfish hardware type over virtual media using BIOS boot mode, it suffice to set ironic boot interface to redfish-virtual-media, as opposed to ipmitool.

openstack baremetal node set --boot-interface redfish-virtual-media node-0

If UEFI boot mode is desired, the user should additionally supply EFI System Partition image (ESP) via [driver-info]/bootloader ironic node property or ironic configuration file in form of Glance image UUID or a URL.

openstack baremetal node set --driver-info bootloader=<glance-uuid> node-0

If [driver_info]/config_via_floppy boolean property of the node is set to true, ironic will create a file with runtime configuration parameters, place into on a FAT image, then insert the image into node's virtual floppy drive.

When booting over PXE or virtual media, and user instance requires some specific kernel configuration, [instance_info]/kernel_append_params property can be used to pass user-specified kernel command line parameters. For ramdisk kernel, [instance_info]/kernel_append_params property serves the same purpose.