From 3aad5d8128521ce91231558b5386360ca238dd68 Mon Sep 17 00:00:00 2001 From: Ruby Loo Date: Wed, 16 Aug 2017 17:40:23 -0400 Subject: [PATCH] [docs] update irmc boot-from-volume This updates the boot-from-volume documentation for the iRMC driver. Change-Id: I06eac109807e8e05b92fb976c335ef4b2f3851ad Partial-Bug: #1677436 --- doc/source/admin/drivers/irmc.rst | 53 +++++++++++++++++-------------- 1 file changed, 30 insertions(+), 23 deletions(-) diff --git a/doc/source/admin/drivers/irmc.rst b/doc/source/admin/drivers/irmc.rst index 015c0731ad..c08e1d8d12 100644 --- a/doc/source/admin/drivers/irmc.rst +++ b/doc/source/admin/drivers/irmc.rst @@ -290,57 +290,64 @@ For more information on node automated cleaning, see :ref:`automated_cleaning` Boot from Remote Volume ^^^^^^^^^^^^^^^^^^^^^^^ -The iRMC driver supports the generic iPXE based remote volume booting when -you use ``pxe_irmc`` classic driver or the following boot interfaces with -the ``irmc`` hardware type. +The iRMC driver supports the generic iPXE-based remote volume booting when +using the ``pxe_irmc`` classic driver or the following boot interfaces with +the ``irmc`` hardware type: * ``irmc-pxe`` * ``pxe`` -The iRMC driver also supports a remote volume booting without iPXE. How to use this iRMC -specific remote volume booting is described here. - -The ``irmc-virtual-media`` boot interface supports this feature for the -``irmc`` hardware type. This feature is also supported with following classic +In addition, the iRMC driver also supports remote volume booting without iPXE. +This is available when using the ``irmc-virtual-media`` boot interface with the +``irmc`` hardware type. It is also supported with the following classic drivers: * ``iscsi_irmc`` * ``agent_irmc`` -This feature configures a node to boot from a remote volume by using API of +This feature configures a node to boot from a remote volume by using the API of iRMC. It supports iSCSI and FibreChannel. Configuration ~~~~~~~~~~~~~ -In addition to configuration for generic drivers for the remote volume boot, -the drivers require the following configuration. +In addition to the configuration for generic drivers to +:ref:`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. - - A physical ID format is: ``-`` where: + The format of a physical port ID is: ``-`` where: - - ````: could be a ``LAN``, ``FC`` or ``CNA`` - - ````: 0 indicates onboard slot. Use 1 to 9 for add-on slots. - - ````: A port number. It starts from 1. + - ````: could be ``LAN``, ``FC`` or ``CNA`` + - ````: 0 indicates onboard slot. Use 1 to 9 for add-on slots. + - ````: A port number starting from 1. - - Set the IDs to ``driver_info/irmc_pci_physical_ids`` of a Node. This - parameter is a dictionary of pair of UUID of a resource (Port or Volume - connector) and a physical ID. This parameter can be set with the following - command:: + 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:: - openstack baremetal node set $NODE_UUID --driver-info irmc_pci_physical_ids={} \ + { + "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 type ``iqn`` and ``ip`` are +* 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 - set to ``driver_info/irmc_storage_network_size`` of a Node as an integer. - For example, if your storage network is 10.2.0.0/22, use the following + 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