From 20886329e7f212af10de4a9f1247bd04781644e0 Mon Sep 17 00:00:00 2001 From: "Michelle (Shelly) Mutu-Grigg" Date: Thu, 22 Oct 2020 21:58:48 +1300 Subject: [PATCH] Update .rst files This commit follows up the observations in review 756708, updates `$node_ident`, `$uuid` & `${node_uuid}` to . Story: 2008194 Task: 40964 Change-Id: I7cd08a37071ce330b4c254595d0745ca154ced2b --- doc/source/admin/drivers/idrac.rst | 22 +++++++++---------- doc/source/admin/node-deployment.rst | 8 +++---- .../admin/upgrade-to-hardware-types.rst | 2 +- doc/source/install/configure-nova-flavors.rst | 4 ++-- 4 files changed, 18 insertions(+), 18 deletions(-) diff --git a/doc/source/admin/drivers/idrac.rst b/doc/source/admin/drivers/idrac.rst index aa6503215d..41b2dd392d 100644 --- a/doc/source/admin/drivers/idrac.rst +++ b/doc/source/admin/drivers/idrac.rst @@ -384,7 +384,7 @@ The following command can be used to create a RAID configuration: .. code-block:: bash baremetal node clean --clean-steps \ - '[{"interface": "raid", "step": "create_configuration"}]' ${node_uuid} + '[{"interface": "raid", "step": "create_configuration"}]' When the physical disk names or controller names are not known, the @@ -459,7 +459,7 @@ Get BIOS Config .. code-block:: bash - baremetal node passthru call --http-method GET ${node_uuid} get_bios_config + baremetal node passthru call --http-method GET get_bios_config Snippet of output showing virtualization enabled: @@ -491,7 +491,7 @@ Set BIOS Config .. code-block:: bash - baremetal node passthru call ${node_uuid} set_bios_config --arg "name=value" + baremetal node passthru call set_bios_config --arg "name=value" Walkthrough of perfoming a BIOS configuration change: @@ -505,7 +505,7 @@ two properties that are being changed are: .. code-block:: bash - baremetal node passthru call ${node_uuid} set_bios_config \ + baremetal node passthru call set_bios_config \ --arg "ProcVirtualization=Enabled" \ --arg "SriovGlobalEnable=Enabled" @@ -532,7 +532,7 @@ Ironic power API. .. code-block:: bash - baremetal node passthru call ${node_uuid} commit_bios_config \ + baremetal node passthru call commit_bios_config \ --arg "reboot=true" .. code-block:: json @@ -546,7 +546,7 @@ The state of any executing job can be queried: .. code-block:: bash - baremetal node passthru call --http-method GET ${node_uuid} list_unfinished_jobs + baremetal node passthru call --http-method GET list_unfinished_jobs .. code-block:: json @@ -568,7 +568,7 @@ Instead of committing, a pending change can be abandoned: .. code-block:: bash - baremetal node passthru call --http-method DELETE ${node_uuid} abandon_bios_config + baremetal node passthru call --http-method DELETE abandon_bios_config The abandon command does not provide a response body. @@ -609,18 +609,18 @@ The boot mode can be changed via the vendor passthru interface as follows: .. code-block:: bash - baremetal node passthru call ${node_uuid} set_bios_config \ + baremetal node passthru call set_bios_config \ --arg "BootMode=Uefi" - baremetal node passthru call ${node_uuid} commit_bios_config \ + baremetal node passthru call commit_bios_config \ --arg "reboot=true" .. code-block:: bash - baremetal node passthru call ${node_uuid} set_bios_config \ + baremetal node passthru call set_bios_config \ --arg "BootMode=Bios" - baremetal node passthru call ${node_uuid} commit_bios_config \ + baremetal node passthru call commit_bios_config \ --arg "reboot=true" Known Issues diff --git a/doc/source/admin/node-deployment.rst b/doc/source/admin/node-deployment.rst index 4a1a3310cb..0e6e6966c7 100644 --- a/doc/source/admin/node-deployment.rst +++ b/doc/source/admin/node-deployment.rst @@ -103,7 +103,7 @@ To check what deploy step the node is performing or attempted to perform and failed, run the following command; it will return the value in the node's ``driver_internal_info`` field:: - baremetal node show $node_ident -f value -c driver_internal_info + baremetal node show -f value -c driver_internal_info The ``deploy_steps`` field will contain a list of all remaining steps with their priorities, and the first one listed is the step currently in progress or @@ -261,11 +261,11 @@ Example of use with the Compute service .. note:: The deploy steps used in this example are for example purposes only. In the following example, we first add the trait ``CUSTOM_HYPERTHREADING_ON`` -to the node represented by ``$node_ident``: +to the node represented by ````: .. code-block:: console - baremetal node add trait $node_ident CUSTOM_HYPERTHREADING_ON + baremetal node add trait CUSTOM_HYPERTHREADING_ON We also update the flavor ``bm-hyperthreading-on`` in the Compute service with the following property: @@ -311,7 +311,7 @@ To make this example more dynamic, let's add a second trait .. code-block:: console - baremetal node add trait $node_ident CUSTOM_HYPERTHREADING_OFF + baremetal node add trait CUSTOM_HYPERTHREADING_OFF We could also update a second flavor, ``bm-hyperthreading-off``, with the following property: diff --git a/doc/source/admin/upgrade-to-hardware-types.rst b/doc/source/admin/upgrade-to-hardware-types.rst index 1a47575249..93d2931425 100644 --- a/doc/source/admin/upgrade-to-hardware-types.rst +++ b/doc/source/admin/upgrade-to-hardware-types.rst @@ -93,7 +93,7 @@ set new values for some or all interfaces: export OS_BAREMETAL_API_VERSION=1.31 for uuid in $(baremetal node list --driver pxe_ipmitool -f value -c UUID); do - baremetal node set $uuid --driver ipmi --deploy-interface iscsi + baremetal node set --driver ipmi --deploy-interface iscsi done for uuid in $(baremetal node list --driver agent_ipmitool -f value -c UUID); do diff --git a/doc/source/install/configure-nova-flavors.rst b/doc/source/install/configure-nova-flavors.rst index 76cfbf3e93..d35748bcee 100644 --- a/doc/source/install/configure-nova-flavors.rst +++ b/doc/source/install/configure-nova-flavors.rst @@ -66,7 +66,7 @@ with tagging some nodes with it: .. code-block:: console - $ baremetal node set $NODE_UUID --resource-class baremetal.with-GPU + $ baremetal node set --resource-class baremetal.with-GPU .. warning:: It is possible to **add** a resource class to ``active`` nodes, but it is @@ -118,7 +118,7 @@ To add the standard trait ``HW_CPU_X86_VMX`` and a custom trait .. code-block:: console - $ baremetal node add trait $NODE_UUID CUSTOM_TRAIT1 HW_CPU_X86_VMX + $ baremetal node add trait CUSTOM_TRAIT1 HW_CPU_X86_VMX Then, update the flavor to require these traits: