openstack/ironic
Code Issues Proposed changes
ironic/doc/source/admin/interfaces/deploy.rst
Dmitry Tantsur f02ef8ad7a Rework drivers page in the admin documentation 
First, "Enabling Drivers" is a really confusing title, since this page
links to complete driver documentation. It also links to IPA docs and
the PXE driver interface.

Next, our documentation is full of remarks about e.g. "pxe_* family of
drivers", which are misleading in the presence of hardware types and
the pxe_agent_cimc driver. We also have mentions of "iscsi deploy method"
without detailed explanation of how this method relates to hardware types
and classic drivers.

This change consolidates drivers and interfaces documentation under
the more clearly named root page. A new page is created with sections for
both deploy interfaces to use for linking from wherever a link to
a particular deploy interface is required.

Change-Id: Ifb8328ccaaac443fac276873e2c375ebcf983f03
2017-11-22 14:59:57 +01:00

2.2 KiB
Raw Blame History

Deploy Interfaces

A deploy interface plays a critical role in the provisioning process. It orchestrates the whole deployment and defines how the image gets transferred to the target disk.

iSCSI deploy

With iscsi deploy interface (and also oneview-iscsi, specific to the oneview hardware type) the deploy ramdisk publishes the node's hard drive as an iSCSI share. The ironic-conductor then copies the image to this share. See iSCSI deploy diagram <iscsi-deploy-example> for a detailed explanation of how this deploy interface works.

This interface is used by default, if enabled (see enable-hardware-interfaces). You can specify it explicitly when creating or updating a node:

openstack baremetal node create --driver ipmi --deploy-interface iscsi
openstack baremetal node set <NODE> --deploy-interface iscsi

The iscsi deploy interface is also used in all of the classic drivers with names starting with pxe_ (except for pxe_agent_cimc) and iscsi_.

Direct deploy

With direct deploy interface (and also oneview-direct, specific to the oneview hardware type), the deploy ramdisk fetches the image from an HTTP location. It can be an object storage (swift or RadosGW) temporary URL or a user-provided HTTP URL. The deploy ramdisk then copies the image to the target disk. See direct deploy diagram <direct-deploy-example> for a detailed explanation of how this deploy interface works.

You can specify this deploy interface when creating or updating a node:

openstack baremetal node create --driver ipmi --deploy-interface direct
openstack baremetal node set <NODE> --deploy-interface direct

The direct deploy interface is also used in all classic drivers whose names include agent.

Note

For historical reasons the direct deploy interface is sometimes called agent, and some classic drivers using it are called agent_*. This is because before the Kilo release ironic-python-agent used to only support this deploy interface.