Merge "Allow instance_info to override node interface"

2 files changed, 23 insertions, 0 deletions

diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst
index 3ca6ec26e..de260385e 100644
--- a/doc/source/admin/index.rst
+++ b/doc/source/admin/index.rst
@@ -30,6 +30,7 @@ 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
 -----------------------------------------------
diff --git a/doc/source/admin/node-interface-override.rst b/doc/source/admin/node-interface-override.rst
new file mode 100644
index 000000000..907c8a00c
--- /dev/null
+++ b/doc/source/admin/node-interface-override.rst
@@ -0,0 +1,22 @@
+=======================
+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.