iRMC drivers¶

Enabling the driver¶

• Add pxe_irmc to the list of enabled_drivers in [DEFAULT] section of /etc/ironic/ironic.conf.
• Ironic Conductor must be restarted for the new driver to be loaded.

Node configuration¶

• Each node is configured for iRMC with PXE deploy by setting the following ironic node object’s properties:
  • driver property to be pxe_irmc
  • driver_info/irmc_address property to be IP address or hostname of the iRMC.
  • driver_info/irmc_username property to be username for the iRMC with administrator privileges.
  • driver_info/irmc_password property to be password for irmc_username.
  • properties/capabilities property to be boot_mode:uefi if UEFI boot is required.
  • properties/capabilities property to be secure_boot:true if UEFI Secure Boot is required. Please refer to UEFI Secure Boot Support for more information.
• All of nodes are configured by setting the following configuration options in [irmc] section of /etc/ironic/ironic.conf:
  • port: Port to be used for iRMC operations; either 80 or 443. The default value is 443. Optional.
  • auth_method: Authentication method for iRMC operations; either basic or digest. The default value is basic. Optional.
  • client_timeout: Timeout (in seconds) for iRMC operations. The default value is 60. Optional.
  • sensor_method: Sensor data retrieval method; either ipmitool or scci. The default value is ipmitool. Optional.
• The following options are only required for inspection:
  • snmp_version: SNMP protocol version; either v1, v2c or v3. The default value is v2c. Optional.
  • snmp_port: SNMP port. The default value is 161. Optional.
  • snmp_community: SNMP community required for versions v1 and v2c. The default value is public. Optional.
  • snmp_security: SNMP security name required for version v3. Optional.
• Each node can be further configured by setting the following ironic node object’s properties which override the parameter values in [irmc] section of /etc/ironic/ironic.conf:
  • driver_info/irmc_port property overrides port.
  • driver_info/irmc_auth_method property overrides auth_method.
  • driver_info/irmc_client_timeout property overrides client_timeout.
  • driver_info/irmc_sensor_method property overrides sensor_method.
  • driver_info/irmc_snmp_version property overrides snmp_version.
  • driver_info/irmc_snmp_port property overrides snmp_port.
  • driver_info/irmc_snmp_community property overrides snmp_community.
  • driver_info/irmc_snmp_security property overrides snmp_security.

Enabling the driver¶

• Add iscsi_irmc to the list of enabled_drivers in [DEFAULT] section of /etc/ironic/ironic.conf.
• Ironic Conductor must be restarted for the new driver to be loaded.

Node configuration¶

• Each node is configured for iRMC with PXE deploy by setting the followings ironic node object’s properties:
  • driver property to be iscsi_irmc
  • driver_info/irmc_address property to be IP address or hostname of the iRMC.
  • driver_info/irmc_username property to be username for the iRMC with administrator privileges.
  • driver_info/irmc_password property to be password for irmc_username.
  • properties/capabilities property to be boot_mode:uefi if UEFI boot is required.
  • properties/capabilities property to be secure_boot:true if Secure Boot is required. Please refer to UEFI Secure Boot Support for more information.
  • driver_info/irmc_deploy_iso property to be either deploy iso file name, Glance UUID, or Image Service URL.
  • instance info/irmc_boot_iso property to be either boot iso file name, Glance UUID, or Image Service URL. This is optional property when boot_option is set to netboot.
• All of nodes are configured by setting the following configuration options in [irmc] section of /etc/ironic/ironic.conf:
  • port: Port to be used for iRMC operations; either 80 or 443. The default value is 443. Optional.
  • auth_method: Authentication method for iRMC operations; either basic or digest. The default value is basic. Optional.
  • client_timeout: Timeout (in seconds) for iRMC operations. The default value is 60. Optional.
  • sensor_method: Sensor data retrieval method; either ipmitool or scci. The default value is ipmitool. Optional.
  • remote_image_share_root: Ironic conductor node’s NFS or CIFS root path. The default value is /remote_image_share_root.
  • remote_image_server: IP of remote image server.
  • remote_image_share_type: Share type of virtual media, either NFS or CIFS. The default is CIFS.
  • remote_image_share_name: share name of remote_image_server. The default value is share.
  • remote_image_user_name: User name of remote_image_server.
  • remote_image_user_password: Password of remote_image_user_name.
  • remote_image_user_domain: Domain name of remote_image_user_name.
• The following options are only required for inspection:
  • snmp_version: SNMP protocol version; either v1, v2c or v3. The default value is v2c. Optional.
  • snmp_port: SNMP port. The default value is 161. Optional.
  • snmp_community: SNMP community required for versions v1 and v2c. The default value is public. Optional.
  • snmp_security: SNMP security name required for version v3. Optional.
• Each node can be further configured by setting the following ironic node object’s properties which override the parameter values in [irmc] section of /etc/ironic/ironic.conf:
  • driver_info/irmc_port property overrides port.
  • driver_info/irmc_auth_method property overrides auth_method.
  • driver_info/irmc_client_timeout property overrides client_timeout.
  • driver_info/irmc_sensor_method property overrides sensor_method.
  • driver_info/irmc_snmp_version property overrides snmp_version.
  • driver_info/irmc_snmp_port property overrides snmp_port.
  • driver_info/irmc_snmp_community property overrides snmp_community.
  • driver_info/irmc_snmp_security property overrides snmp_security.

Enabling the driver¶

• Add agent_irmc to the list of enabled_drivers in [DEFAULT] section of /etc/ironic/ironic.conf.
• Ironic Conductor must be restarted for the new driver to be loaded.

Node configuration¶

• Each node is configured for iRMC with PXE deploy by setting the followings ironic node object’s properties:
  • driver property to be agent_irmc
  • driver_info/irmc_address property to be IP address or hostname of the iRMC.
  • driver_info/irmc_username property to be username for the iRMC with administrator privileges.
  • driver_info/irmc_password property to be password for irmc_username.
  • properties/capabilities property to be boot_mode:uefi if UEFI boot is required.
  • properties/capabilities property to be secure_boot:true if Secure Boot is required. Please refer to UEFI Secure Boot Support for more information.
  • driver_info/irmc_deploy_iso property to be either deploy iso file name, Glance UUID, or Image Service URL.
  • instance info/irmc_boot_iso property to be either boot iso file name, Glance UUID, or Image Service URL. This is optional property when boot_option is set to netboot.
• All of nodes are configured by setting the following configuration options in [irmc] section of /etc/ironic/ironic.conf:
  • port: Port to be used for iRMC operations; either 80 or 443. The default value is 443. Optional.
  • auth_method: Authentication method for iRMC operations; either basic or digest. The default value is basic. Optional.
  • client_timeout: Timeout (in seconds) for iRMC operations. The default value is 60. Optional.
  • sensor_method: Sensor data retrieval method; either ipmitool or scci. The default value is ipmitool. Optional.
  • remote_image_share_root: Ironic conductor node’s NFS or CIFS root path. The default value is /remote_image_share_root.
  • remote_image_server: IP of remote image server.
  • remote_image_share_type: Share type of virtual media, either NFS or CIFS. The default is CIFS.
  • remote_image_share_name: share name of remote_image_server. The default value is share.
  • remote_image_user_name: User name of remote_image_server.
  • remote_image_user_password: Password of remote_image_user_name.
  • remote_image_user_domain: Domain name of remote_image_user_name.
• The following options are only required for inspection:
  • snmp_version: SNMP protocol version; either v1, v2c or v3. The default value is v2c. Optional.
  • snmp_port: SNMP port. The default value is 161. Optional.
  • snmp_community: SNMP community required for versions v1 and v2c. The default value is public. Optional.
  • snmp_security: SNMP security name required for version v3. Optional.
• Each node can be further configured by setting the following ironic node object’s properties which override the parameter values in [irmc] section of /etc/ironic/ironic.conf:
  • driver_info/irmc_port property overrides port.
  • driver_info/irmc_auth_method property overrides auth_method.
  • driver_info/irmc_client_timeout property overrides client_timeout.
  • driver_info/irmc_sensor_method property overrides sensor_method.
  • driver_info/irmc_snmp_version property overrides snmp_version.
  • driver_info/irmc_snmp_port property overrides snmp_port.
  • driver_info/irmc_snmp_community property overrides snmp_community.
  • driver_info/irmc_snmp_security property overrides snmp_security.

Supported Automated Cleaning Operations¶

The automated cleaning operations supported are:

• restore_irmc_bios_config: Restores BIOS settings on a baremetal node from backup data. If this clean step is enabled, the BIOS settings of a baremetal node will be backed up automatically before the deployment. By default, this clean step is disabled with priority 0. Set its priority to a positive integer to enable it. The recommended value is 10.

  Warning

  pxe boot interface, when used with irmc hardware type, does not support this clean step. If uses irmc hardware type, it is required to select irmc-pxe or irmc-virtual-media as the boot interface in order to make this clean step work.

Configuration options for the automated cleaning steps are listed under [irmc] section in ironic.conf

clean_priority_restore_irmc_bios_config = 0

For more information on node automated cleaning, see Automated cleaning

Configuration¶

In addition to the configuration for generic drivers to remote volume boot, the iRMC drivers require the following configuration:

• It is necessary to set physical port IDs to network ports and volume connectors. All cards including those not used for volume boot should be registered.

  The format of a physical port ID is: <Card Type><Slot No>-<Port No> where:

  • <Card Type>: could be LAN, FC or CNA
  • <Slot No>: 0 indicates onboard slot. Use 1 to 9 for add-on slots.
  • <Port No>: A port number starting from 1.

  These IDs are specified in a node’s driver_info[irmc_pci_physical_ids]. This value is a dictionary. The key is the UUID of a resource (Port or Volume Connector) and its value is the physical port ID. For example:

  {
    "1ecd14ee-c191-4007-8413-16bb5d5a73a2":"LAN0-1",
    "87f6c778-e60e-4df2-bdad-2605d53e6fc0":"CNA1-1"
  }
  

  It can be set with the following command:

  openstack baremetal node set $NODE_UUID \
  --driver-info irmc_pci_physical_ids={} \
  --driver-info irmc_pci_physical_ids/$PORT_UUID=LAN0-1 \
  --driver-info irmc_pci_physical_ids/$VOLUME_CONNECTOR_UUID=CNA1-1
  

• For iSCSI boot, volume connectors with both types iqn and ip are required. The configuration with DHCP is not supported yet.

• For iSCSI, the size of the storage network is needed. This value should be specified in a node’s driver_info[irmc_storage_network_size]. It must be a positive integer < 32. For example, if the storage network is 10.2.0.0/22, use the following command:

  openstack baremetal node set $NODE_UUID --driver-info irmc_storage_network_size=22
  

Supported hardware¶

The drivers support the PCI controllers, Fibrechannel Cards, Converged Network Adapters supported by Fujitsu ServerView Virtual-IO Manager.

Configuration¶

The Hardware Inspection Support in the iRMC drivers requires the following configuration:

• It is necessary to set ironic configuration with gpu_ids option in [irmc] section.

  gpu_ids is a list of <vendorID>/<deviceID> where:

  • <vendorID>: 4 hexadecimal digits starts with ‘0x’.
  • <deviceID>: 4 hexadecimal digits starts with ‘0x’.

  Here is a sample value for gpu_ids:

  gpu_ids = 0x1000/0x0079,0x2100/0x0080
  

• The python-scciclient package requires pyghmi version >= 1.0.22 and pysnmp version >= 4.2.3. They are used by the conductor service on the conductor. The latest version of pyghmi can be downloaded from here and pysnmp can be downloaded from here.

Supported properties¶

The inspection process will discover the following essential properties (properties required for scheduling deployment):

• memory_mb: memory size
• cpus: number of cpus
• cpu_arch: cpu architecture
• local_gb: disk size

Inspection can also discover the following extra capabilities for iRMC drivers:

• irmc_firmware_version: iRMC firmware version
• rom_firmware_version: ROM firmware version
• trusted_boot: The flag whether TPM(Trusted Platform Module) is supported by the server. The possible values are ‘True’ or ‘False’.
• server_model: server model
• pci_gpu_devices: number of gpu devices connected to the bare metal.

The operator can specify these capabilities in compute service flavor, for example:

openstack flavor set baremetal-flavor-name --property capabilities:irmc_firmware_version="iRMC S4-8.64F"

openstack flavor set baremetal-flavor-name --property capabilities:server_model="TX2540M1F5"

openstack flavor set baremetal-flavor-name --property capabilities:pci_gpu_devices="1"

See Capabilities discovery for more details and examples.