From d964b0e62822601bc7c078987a94ba93bb887f2b Mon Sep 17 00:00:00 2001 From: Ron Stone Date: Fri, 29 Oct 2021 12:30:47 -0400 Subject: [PATCH] nic-replacement-without-host-reinstall editorial updates Some minor corrections to files related to this feature. Patchset 1 review updates Signed-off-by: Ron Stone Change-Id: I5a41b1a6653e7c72547b95ead75ce50f1c672dfc Signed-off-by: Ron Stone --- ...erent-vendor-or-device-id-b1ab1440e15f.rst | 26 +++++++++---------- ...same-vendor-and-device-id-cccabcdc5d43.rst | 16 ++++++------ ...same-vendor-and-device-id-32942b7b05e5.rst | 25 +++++++++--------- ...erent-vendor-or-device-id-b406c1c190a9.rst | 26 +++++++++---------- 4 files changed, 47 insertions(+), 46 deletions(-) diff --git a/doc/source/node_management/kubernetes/hardware_acceleration_devices/fec-replacement-with-different-vendor-or-device-id-b1ab1440e15f.rst b/doc/source/node_management/kubernetes/hardware_acceleration_devices/fec-replacement-with-different-vendor-or-device-id-b1ab1440e15f.rst index e3f4cc6db..4739fec09 100644 --- a/doc/source/node_management/kubernetes/hardware_acceleration_devices/fec-replacement-with-different-vendor-or-device-id-b1ab1440e15f.rst +++ b/doc/source/node_management/kubernetes/hardware_acceleration_devices/fec-replacement-with-different-vendor-or-device-id-b1ab1440e15f.rst @@ -1,15 +1,15 @@ .. _fec-replacement-with-different-vendor-or-device-id-b1ab1440e15f: -=============================================================== -N3000 and ACC100 replacement with different vendor or device-id -=============================================================== +============================================================== +Replace N3000 and ACC100 with a different vendor and device-id +============================================================== .. rubric:: |context| -The following procedure allows the replacement of a N3000 or ACC100 device on a -host, without requiring a host or system (in case of |AIO-SX|) re-install and +The following procedure allows the replacement of an N3000 or ACC100 device on +a host, without requiring a host or system (in case of |AIO-SX|) re-install and re-configuration, in the case of the replaced device having different vendor or -device id info. +device ID information. The normal approach to doing such a change would be to do a ``system host-delete``, a ``system host-add`` (re-install) and a re-configure of the @@ -68,7 +68,7 @@ For information on replacing an N3000 or ACC100 with the same model, see | pci_0000_da_00_0 | 0000:da:00.0 | 0b4000 | 8086 | 37c8 | Co-processor | Intel Corporation | C62x Chipset QuickAssist Technology | 1 | True | +------------------+--------------+----------+-----------+-----------+---------------------------+-------------------------+-------------------------------------+-----------+---------+ - N3000 has vendor ID 8086 and device IDs 0b30 and 0d8f ACC100 has vendor ID + N3000 has vendor ID 8086 and device IDs 0b30 and 0d8f. ACC100 has vendor ID 8086 and device ID 0d5c. #. Record the current device configuration. @@ -96,14 +96,14 @@ For information on replacing an N3000 or ACC100 with the same model, see +-----------------------+---------------------------------------------------------------------------------------------------------+ -#. Remove the |VF| configuration (if any) for device 0d8f (N3000) or 0d5c +#. Remove the |VF| configuration, if any, for device 0d8f (N3000) or 0d5c (ACC100). .. code-block:: ~(keystone_admin)]$ system host-device-modify --vf-driver none -N 0 -#. Remove the driver configuration (if any) for device 0d8f (N3000) or 0d5c +#. Remove the driver configuration, if any, for device 0d8f (N3000) or 0d5c (ACC100). .. code-block:: @@ -122,7 +122,7 @@ For information on replacing an N3000 or ACC100 with the same model, see #. Reconfigure the device 0d8f (N3000) or 0d5c (ACC100). - The new device’s number of |VFs| is limited by the parameter + The new device's number of |VFs| is limited by the parameter ``sriov_totalvfs``. .. code-block:: @@ -130,7 +130,7 @@ For information on replacing an N3000 or ACC100 with the same model, see ~(keystone_admin)]$ system host-device-modify --driver --vf-driver -N --enable true #. If the replaced |PCI| card is an N3000 and its |FPGA| was not - pre-loaded with an updated image, follow the steps described + pre-loaded with an updated image, follow the steps described in :ref:`index-intel-n3000-support`. #. Unlock the host. @@ -139,8 +139,8 @@ For information on replacing an N3000 or ACC100 with the same model, see ~(keystone_admin)]$ system host-unlock -#. If the host in question is the single host of an |AIO-SX| subcloud deployment, - set the subcloud as managed. +#. If the host in question is the single host of an |AIO-SX| subcloud + deployment, set the subcloud as managed. .. code-block:: diff --git a/doc/source/node_management/kubernetes/hardware_acceleration_devices/n3000-and-acc100-replacement-with-the-same-vendor-and-device-id-cccabcdc5d43.rst b/doc/source/node_management/kubernetes/hardware_acceleration_devices/n3000-and-acc100-replacement-with-the-same-vendor-and-device-id-cccabcdc5d43.rst index c2cdb7e1b..683b6b99b 100644 --- a/doc/source/node_management/kubernetes/hardware_acceleration_devices/n3000-and-acc100-replacement-with-the-same-vendor-and-device-id-cccabcdc5d43.rst +++ b/doc/source/node_management/kubernetes/hardware_acceleration_devices/n3000-and-acc100-replacement-with-the-same-vendor-and-device-id-cccabcdc5d43.rst @@ -1,13 +1,13 @@ .. _n3000-and-acc100-replacement-with-the-same-vendor-and-device-id-cccabcdc5d43: -=============================================================== -N3000 and ACC100 replacement with the same vendor and device-id -=============================================================== +=========================================================== +Replace N3000 and ACC100 with the same vendor and device-id +=========================================================== -The following procedure allows the replacement of a N3000 or ACC100 device on a -host, without requiring a host or system (in case of |AIO-SX|) re-install and +The following procedure allows the replacement of an N3000 or ACC100 device on +a host, without requiring a host or system (in case of |AIO-SX|) re-install and re-configuration, in the case of the replaced device having the same vendor and -device id info. +device ID information. The normal approach to doing such a change would be to do a ``system host-delete``, a ``system host-add`` (re-install) and a re-configure of the @@ -20,8 +20,8 @@ result in a full system re-install and full system re-configuration. .. rubric:: |prereq| -The vendor and device-id of currently installed |PCI| card can be -obtained with: +The vendor and device-id of currently installed |PCI| card can be obtained +with: .. code-block:: none diff --git a/doc/source/node_management/kubernetes/node_interfaces/nic-replacement-with-the-same-vendor-and-device-id-32942b7b05e5.rst b/doc/source/node_management/kubernetes/node_interfaces/nic-replacement-with-the-same-vendor-and-device-id-32942b7b05e5.rst index ec373e251..4ebd8a502 100644 --- a/doc/source/node_management/kubernetes/node_interfaces/nic-replacement-with-the-same-vendor-and-device-id-32942b7b05e5.rst +++ b/doc/source/node_management/kubernetes/node_interfaces/nic-replacement-with-the-same-vendor-and-device-id-32942b7b05e5.rst @@ -1,23 +1,24 @@ .. _nic-replacement-with-the-same-vendor-and-device-id-32942b7b05e5: -================================================== -NIC replacement with the same vendor and device-id -================================================== +================================================ +Replace a NIC with the same vendor and device-id +================================================ The following procedure allows the replacement of a NIC on a host, without -requiring a host or system (in case of |AIO-SX|) re-install and re-configuration, -in the case of the replaced NIC having the same vendor or device id info. +requiring a host or system (in case of |AIO-SX|) re-install and +re-configuration, in the case of the replaced NIC having the same vendor or +device ID information. The normal approach to doing such a change would be to do a ``system host-delete``, a ``system host-add`` (re-install) and a re-configure of the -host. In the case of an |AIO-SX| deployment, with only one host, this would +host. In the case of an |AIO-SX| deployment, with only one host, this would result in a full system re-install and full system re-configuration. -Since this procedure reuses same vendor and device id information and +Since this procedure reuses same vendor and device ID information and capabilities, the interface's new |MAC| will be updated internally and no reconfiguration is required. Assuming that the replacement will occur on the same |PCI| slot of the previous card, the procedure can be executed for all -types of NIC classes (``pci-sriov``, ``data``, ``pci-passthrough``, +types of NIC classes (``pci-sriov``, ``data``, ``pci-passthrough``, and ``platform``). .. rubric:: |proc| @@ -34,7 +35,7 @@ types of NIC classes (``pci-sriov``, ``data``, ``pci-passthrough``, #. Power up the host. -#. Unock the host. +#. Unlock the host. .. code-block:: none @@ -42,6 +43,6 @@ types of NIC classes (``pci-sriov``, ``data``, ``pci-passthrough``, .. rubric:: |result| -The host is rebooted, and its Availability State is reported as In-Test. After -a few minutes, it is reported as Unlocked, Enabled, and Available. - +The host is rebooted, and its Availability State is reported as ``In-Test``. +After a few minutes, it is reported as ``Unlocked``, ``Enabled``, and +``Available``. diff --git a/doc/source/node_management/kubernetes/node_interfaces/replace-a-nic-with-a-different-vendor-or-device-id-b406c1c190a9.rst b/doc/source/node_management/kubernetes/node_interfaces/replace-a-nic-with-a-different-vendor-or-device-id-b406c1c190a9.rst index e4ffe1b8e..589310a22 100644 --- a/doc/source/node_management/kubernetes/node_interfaces/replace-a-nic-with-a-different-vendor-or-device-id-b406c1c190a9.rst +++ b/doc/source/node_management/kubernetes/node_interfaces/replace-a-nic-with-a-different-vendor-or-device-id-b406c1c190a9.rst @@ -9,7 +9,7 @@ Replace a NIC with a different vendor or device-id The following procedure allows the replacement of a NIC on a host, without requiring a host or system (in case of |AIO-SX|) re-install and re-configuration, in the case of the replaced NIC having the different vendor -or device id info. +or device ID information. The normal approach to making such a change would be to do a ``system host-delete``, a ``system host-add`` (re-install) and a re-configure of the @@ -37,20 +37,21 @@ reapply it after replacing the NIC card. to take effect. After doing so, you must lock the host again to reconfigure the interface with the desired or previous configuration. -* If the affected interfaces are unconfigured (class is none and “used by i/f” - is empty) the procedure described in +* If the affected interfaces are unconfigured (class is ``none`` and the + :guilabel:`used by i/f` column of :command:`host-if-list` output is empty), + then the procedure described in :ref:`nic-replacement-with-the-same-vendor-and-device-id-32942b7b05e5` can be followed. .. rubric:: |proc| .. note:: - UUID values in the output shown below have been truncated for display - purposes. When using a UUID value as input to a command, use the entire 36 + |UUID| values in the output shown below have been truncated for display + purposes. When using a |UUID| value as input to a command, use the entire 36 character string. -#. If the host in question is the single host of an |AIO-SX| subcloud deployment, - set the subcloud as managed +#. If the host in question is the single host of an |AIO-SX| subcloud + deployment, set the subcloud as unmanaged. .. code-block:: none @@ -292,10 +293,11 @@ reapply it after replacing the NIC card. ~(keystone_admin)]$ system host-if-add -#. Reconnect the sub-interface with desired network (if it was previously +#. Reconnect the sub-interface with the desired network (if it was previously connected). - #. For a platform class interface, select the respective network that supports the desired new sub-interface. + #. For a platform class interface, select the respective network that + supports the desired new sub-interface. .. code-block:: none @@ -332,11 +334,9 @@ reapply it after replacing the NIC card. ~(keystone_admin)]$ system host-unlock -#. If the host in question is the single host of an |AIO-SX| subcloud deployment, - set the subcloud as managed +#. If the host in question is the single host of an |AIO-SX| subcloud + deployment, set the subcloud as managed. .. code-block:: none ~(keystone_admin)]$ dcmanager subcloud manage - -