openstack/ironic
Code Issues Proposed changes

Merge "[docs] update irmc boot-from-volume"

Browse Source
This commit is contained in:
Jenkins 2017-08-17 13:44:32 +00:00 committed by Gerrit Code Review
commit c662bad3e1
1 changed files with 30 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
doc/source/admin/drivers/irmc.rst
View File

@ -290,57 +290,64 @@ For more information on node automated cleaning, see :ref:`automated_cleaning`
Boot from Remote Volume Boot from Remote Volume
^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^
The iRMC driver supports the generic iPXE based remote volume booting when The iRMC driver supports the generic iPXE-based remote volume booting when
you use ``pxe_irmc`` classic driver or the following boot interfaces with using the ``pxe_irmc`` classic driver or the following boot interfaces with
the ``irmc`` hardware type. the ``irmc`` hardware type:
* ``irmc-pxe`` * ``irmc-pxe``
* ``pxe`` * ``pxe``
The iRMC driver also supports a remote volume booting without iPXE. How to use this iRMC In addition, the iRMC driver also supports remote volume booting without iPXE.
specific remote volume booting is described here. This is available when using the ``irmc-virtual-media`` boot interface with the
``irmc`` hardware type. It is also supported with the following classic
The ``irmc-virtual-media`` boot interface supports this feature for the
``irmc`` hardware type. This feature is also supported with following classic
drivers: drivers:
* ``iscsi_irmc`` * ``iscsi_irmc``
* ``agent_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. iRMC. It supports iSCSI and FibreChannel.
Configuration Configuration
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
In addition to configuration for generic drivers for the remote volume boot, In addition to the configuration for generic drivers to
the drivers require the following configuration. :ref:`remote volume boot <boot-from-volume>`,
the iRMC drivers require the following configuration:
* It is necessary to set physical port IDs to network ports and volume * 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 connectors. All cards including those not used for volume boot should be
registered. registered.
- A physical ID format is: ``<Card Type><Slot No>-<Port No>`` where: The format of a physical port ID is: ``<Card Type><Slot No>-<Port No>`` where:
- ``<Card Type>``: could be a ``LAN``, ``FC`` or ``CNA`` - ``<Card Type>``: could be ``LAN``, ``FC`` or ``CNA``
- ``<Slot No>``: 0 indicates onboard slot. Use 1 to 9 for add-on slots. - ``<Slot No>``: 0 indicates onboard slot. Use 1 to 9 for add-on slots.
- ``<Port No>``: A port number. It starts from 1. - ``<Port No>``: A port number starting from 1.
- Set the IDs to ``driver_info/irmc_pci_physical_ids`` of a Node. This These IDs are specified in a node's ``driver_info[irmc_pci_physical_ids]``.
parameter is a dictionary of pair of UUID of a resource (Port or Volume This value is a dictionary. The key is the UUID of a resource (Port or Volume
connector) and a physical ID. This parameter can be set with the following Connector) and its value is the physical port ID. For example::
command::
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/$PORT_UUID=LAN0-1 \
--driver-info irmc_pci_physical_ids/$VOLUME_CONNECTOR_UUID=CNA1-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. required. The configuration with DHCP is not supported yet.
* For iSCSI, the size of the storage network is needed. This value should be * 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. specified in a node's ``driver_info[irmc_storage_network_size]``. It must be
For example, if your storage network is 10.2.0.0/22, use the following a positive integer < 32.
For example, if the storage network is 10.2.0.0/22, use the following
command:: command::
openstack baremetal node set $NODE_UUID --driver-info irmc_storage_network_size=22 openstack baremetal node set $NODE_UUID --driver-info irmc_storage_network_size=22