openstack/ironic
Code Issues Proposed changes

docs: move overriding interfaces to the standalone documentation

Browse Source 
Chances are much higher the users will find it there. Also correct some
wording (node interfaces -> hardware interfaces), use double ticks for
field names and mention the Wallaby release.

Story: #2008652
Task: #42015
Change-Id: I33956976a9420ade836ab8d37a9488b9a207cef0
This commit is contained in:
Dmitry Tantsur 2021-03-08 17:57:30 +01:00
parent 4865511ad2
commit 472ffca269
3 changed files with 20 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/admin/index.rst
View File

@ -30,7 +30,6 @@ the services.
Node Multi-Tenancy <node-multitenancy>
Fast-Track Deployment <fast-track>
Booting a Ramdisk or an ISO <ramdisk-boot>
Node Interface Override <node-interface-override>
Drivers, Hardware Types and Hardware Interfaces
-----------------------------------------------

22
doc/source/admin/node-interface-override.rst
View File

@ -1,22 +0,0 @@
=======================
Node Interface Override
=======================
Non-admins with temporary access to a node, may wish to specify different
node interfaces. However, allowing them to set these interface values is
problematic, as there is no automated way to ensure that the original
interface values are restored.
This guide details a method for temporarily overriding a node interface
value.
Overriding a Node Interface
===========================
In order to temporarily override a node interface, simply set the
appropriate value in `instance_info`. For example, if you'd like to
override a node's storage interface, run the following::
baremetal node set --instance-info storage_interface=cinder node-1
`instance_info` values persist until after a node is cleaned.

20
doc/source/install/standalone.rst
View File

@ -307,6 +307,26 @@ Populating instance_info
baremetal node set $NODE_UUID \
--instance-info image_rootfs_uuid=<uuid>
Overriding a hardware interface
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Non-admins with temporary access to a node, may wish to specify different node
interfaces. However, allowing them to set these interface values directly on
the node is problematic, as there is no automated way to ensure that the
original interface values are restored.
In order to temporarily override a hardware interface, simply set the
appropriate value in ``instance_info``. For example, if you'd like to
override a node's storage interface, run the following::
baremetal node set $NODE_UUID \
--instance-info storage_interface=cinder
``instance_info`` values persist until after a node is cleaned.
.. note::
This feature is available starting with the Wallaby release.
Deployment
----------