Merge pull request CCI-MOC#154 from tzumainn/phase2-update

Update docs with functional test and boot-from-volume info

Author: tzumainn

docs/source/install/index.rst

@@ -48,12 +48,24 @@ Two additional ESI add-ons provide additional functionality:
 
 Instructions for installing these add-ons can be found within the linked repositories.
 
+Functional Tests
+----------------
+
+The functional tests in `python-esiclient`_ and `python-esileapclient`_ may be useful in
+ensuring that your OpenStack installation is configured properly for ESI. Documentation for running
+these tests can be found within their respecitive repositories:
+
+* `ESI Functional Tests`_
+* `ESI Leap Functional Tests`_
+
 .. _install OpenStack: https://docs.openstack.org/install-guide/
 .. _Ironic node multi-tenancy: https://docs.openstack.org/ironic/latest/admin/node-multitenancy.html
 .. _here: https://github.com/CCI-MOC/esi/blob/master/etc/ironic/policy.yaml.sample
 .. _ESI Leap: https://github.com/CCI-MOC/esi-leap
 .. _python-esileapclient: https://github.com/CCI-MOC/python-esileapclient
 .. _python-esiclient: https://github.com/CCI-MOC/python-esiclient
+.. _ESI Functional Tests: https://github.com/CCI-MOC/python-esiclient/tree/master/esiclient/tests/functional
+.. _ESI Leap Functional Tests: https://github.com/CCI-MOC/python-esileapclient/tree/master/esileapclient/tests/functional
 .. _Allow node lessee to see node's ports: https://review.opendev.org/c/openstack/ironic/+/730366
 .. _Allow node vif attach to specify port_uuid: https://review.opendev.org/#/c/731780/
 .. _Add port-uuid parameter to node vif attach: https://review.opendev.org/#/c/737585/

docs/source/usage/index.rst

@@ -195,7 +195,7 @@ Image-based provisioning can be accomplished through the use of `Metalsmith`_. I
 Volume
 ~~~~~~
 
-The process for booting a node from a volume is described in the `Ironic boot-from-volume documentation`_. There are two things to note for non-admin deployments:
+In order to boot a node from a volume, two node attributes must be set as follows:
 
 * The node owner or admin should set the `iscsi_boot` node capability prior to leasing the node.
 * The node lessee should not be allowed to edit the `storage_interface` node attribute. Instead, they can run the following command to temporarily override that value (until the node is cleaned):
@@ -206,6 +206,14 @@ The process for booting a node from a volume is described in the `Ironic boot-fr
 | Override Storage Interface | ``openstack baremetal node set --instance-info storage_interface=cinder <node>`` |
 +----------------------------+----------------------------------------------------------------------------------+
 
+The process for booting a node from a volume is described in the `Ironic boot-from-volume documentation`_. You can also use `python-esiclient`_ to run that workflow with a single command:
+
++-----------------------+--------------------------------------------------------------------------------------------+
+|                       | **Actions**                                                                                |
++-----------------------+--------------------------------------------------------------------------------------------+
+| Boot Node from Volume | ``openstack esi node volume attach (--network <network> | --port <port>) <node> <volume>`` |
++-----------------------+--------------------------------------------------------------------------------------------+
+
 External Provisioning
 ~~~~~~~~~~~~~~~~~~~~~
 
@@ -244,6 +252,15 @@ Node/Network Management
 | Detach Network from Node      | ``openstack esi node network detach <node> <port>``                                |
 +-------------------------------+------------------------------------------------------------------------------------+
 
+Boot Node from Volume
+~~~~~~~~~~~~~~~~~~~~~
+
++-----------------------+--------------------------------------------------------------------------------------------+
+|                       | **Actions**                                                                                |
++-----------------------+--------------------------------------------------------------------------------------------+
+| Boot Node from Volume | ``openstack esi node volume attach (--network <network> | --port <port>) <node> <volume>`` |
++-----------------------+--------------------------------------------------------------------------------------------+
+
 Trunk Ports
 ~~~~~~~~~~~