From 7365864b075054444e8429630925694cd5fc7da4 Mon Sep 17 00:00:00 2001 From: Xavier Date: Tue, 13 Sep 2016 19:32:27 -0300 Subject: [PATCH] OneView driver docs explaining hardware inspection Once patch 367065 (Add inspection feature for the OneView drivers) lands, we need to explain in the OneView drivers docs what hardware inspection is and how to set up ironic-inspector. This patch change the OneView driver docs explaining what changes with the addition of hardware inspection capacity. Change-Id: Iae591831230cb0b9cdedff2cdd9a3dec4e324012 Closes-Bug: 1621530 Depends-On: I77ebf4b9175c2c1df1baa6d58714ff54c97c17ff --- doc/source/drivers/oneview.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/doc/source/drivers/oneview.rst b/doc/source/drivers/oneview.rst index 2970a36660..35e679e2e6 100644 --- a/doc/source/drivers/oneview.rst +++ b/doc/source/drivers/oneview.rst @@ -28,6 +28,7 @@ To provide a bare metal instance there are four components involved in the process: * The ironic service +* The ironic-inspector service (if using hardware inspection) * The ironic driver for OneView, which can be: * `iscsi_pxe_oneview` or * `agent_pxe_oneview` @@ -76,6 +77,8 @@ The following requirements apply for both ``iscsi_pxe_oneview`` and $ pip install "python-oneviewclient<3.0.0,>=2.4.0" +* ``ironic-inspector`` if using hardware inspection. + Tested platforms ================ @@ -212,6 +215,20 @@ Here is an overview of the deploy process for this driver: 11. Driver powers on the machine. 12. Baremetal node is active and ready to be used. +Hardware inspection +=================== + +OneView drivers for ironic have the ability to do hardware inspection. +Hardware inspection is the process of discovering hardware properties like +memory size, CPU cores, processor architecture and disk size, of a given +hardware. OneView drivers do in-band inspection, that involves booting a +ramdisk on the hardware and fetching information directly from it. For that, +your cloud controller needs to have the ``ironic-inspector`` component +[10]_ running and properly enabled in ironic's configuration file. + +See [11]_ for more information on how to install and configure +``ironic-inspector``. + Registering a OneView node in ironic ==================================== @@ -429,3 +446,5 @@ References .. [7] ironic-oneviewd - https://pypi.python.org/pypi/ironic-oneviewd/ .. [8] ironic-oneview-cli - https://pypi.python.org/pypi/ironic-oneview-cli/ .. [9] :ref:`states` +.. [10] ironic-inspector - http://docs.openstack.org/developer/ironic-inspector/ +.. [11] ironic-inspector install - http://docs.openstack.org/developer/ironic-inspector/install.html