diff options
| author | Dmitry Tantsur <divius.inside@gmail.com> | 2017-11-03 15:33:59 +0100 |
|---|---|---|
| committer | Dmitry Tantsur <divius.inside@gmail.com> | 2017-11-22 14:59:57 +0100 |
| commit | f02ef8ad7a8d993bbd62780a8da6e66a6a0a1cf6 (patch) | |
| tree | 7478dab92d3c3f526bffcf4518468db76859ce11 /doc/source/admin/drivers/ipa.rst | |
| parent | de7911b2cc289399e5ae8a030b703c69baca1d25 (diff) | |
| download | ironic-f02ef8ad7a8d993bbd62780a8da6e66a6a0a1cf6.tar.gz | |
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
Diffstat (limited to 'doc/source/admin/drivers/ipa.rst')
| -rw-r--r-- | doc/source/admin/drivers/ipa.rst | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/doc/source/admin/drivers/ipa.rst b/doc/source/admin/drivers/ipa.rst index 500a7b05d..19f751da1 100644 --- a/doc/source/admin/drivers/ipa.rst +++ b/doc/source/admin/drivers/ipa.rst @@ -1,5 +1,3 @@ -.. _IPA: - =================== Ironic Python Agent =================== @@ -23,16 +21,16 @@ Starting with the Kilo release all drivers (except for fake ones) are using IPA for deployment. There are two types of them, which can be distinguished by prefix: -* For drivers with ``pxe_`` or ``iscsi_`` prefix IPA exposes the root hard +* For nodes using the :ref:`iscsi-deploy` interface, IPA exposes the root hard drive as an iSCSI share and calls back to the ironic conductor. The conductor mounts the share and copies an image there. It then signals back to IPA for post-installation actions like setting up a bootloader for local boot support. -* For drivers with ``agent_`` prefix the conductor prepares a swift temporary - URL for an image. IPA then handles the whole deployment process: - downloading an image from swift, putting it on the machine and doing any - post-deploy actions. +* For nodes using the :ref:`direct-deploy` interface, the conductor prepares + a swift temporary URL for an image. IPA then handles the whole deployment + process: downloading an image from swift, putting it on the machine and doing + any post-deploy actions. Which one to choose depends on your environment. iSCSI-based drivers put higher load on conductors, agent-based drivers currently require the whole |