From 472ffca2694e1a772d93f7a11da8c16aeb69eaeb Mon Sep 17 00:00:00 2001 From: Dmitry Tantsur Date: Mon, 8 Mar 2021 17:57:30 +0100 Subject: [PATCH] docs: move overriding interfaces to the standalone documentation 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 --- doc/source/admin/index.rst | 1 - doc/source/admin/node-interface-override.rst | 22 -------------------- doc/source/install/standalone.rst | 20 ++++++++++++++++++ 3 files changed, 20 insertions(+), 23 deletions(-) delete mode 100644 doc/source/admin/node-interface-override.rst diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst index de260385eb..3ca6ec26ea 100644 --- a/doc/source/admin/index.rst +++ b/doc/source/admin/index.rst @@ -30,7 +30,6 @@ the services. Node Multi-Tenancy Fast-Track Deployment Booting a Ramdisk or an ISO - Node Interface Override Drivers, Hardware Types and Hardware Interfaces ----------------------------------------------- diff --git a/doc/source/admin/node-interface-override.rst b/doc/source/admin/node-interface-override.rst deleted file mode 100644 index 907c8a00cf..0000000000 --- a/doc/source/admin/node-interface-override.rst +++ /dev/null @@ -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. diff --git a/doc/source/install/standalone.rst b/doc/source/install/standalone.rst index 7aa5ecd134..cea515ec9b 100644 --- a/doc/source/install/standalone.rst +++ b/doc/source/install/standalone.rst @@ -307,6 +307,26 @@ Populating instance_info baremetal node set $NODE_UUID \ --instance-info image_rootfs_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 ----------