starlingx/docs
Code Issues Proposed changes

nic-replacement-without-host-reinstall editorial updates

Browse Source 
Some minor corrections to files related to this feature.
Patchset 1 review updates

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I5a41b1a6653e7c72547b95ead75ce50f1c672dfc
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
This commit is contained in:
Ron Stone 2021-10-29 12:30:47 -04:00
parent 4a2a067e32
commit d964b0e628
4 changed files with 47 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/source/node_management/kubernetes/hardware_acceleration_devices/fec-replacement-with-different-vendor-or-device-id-b1ab1440e15f.rst
View File

@ -1,15 +1,15 @@
.. _fec-replacement-with-different-vendor-or-device-id-b1ab1440e15f: .. _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| .. rubric:: |context|
The following procedure allows the replacement of a N3000 or ACC100 device on a The following procedure allows the replacement of an N3000 or ACC100 device on
host, without requiring a host or system (in case of |AIO-SX|) re-install and 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 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 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-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 | | 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. 8086 and device ID 0d5c.
#. Record the current device configuration. #. 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). (ACC100).
.. code-block:: .. code-block::
~(keystone_admin)]$ system host-device-modify <hostname> <device-name-or-address> --vf-driver none -N 0 ~(keystone_admin)]$ system host-device-modify <hostname> <device-name-or-address> --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). (ACC100).
.. code-block:: .. 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). #. 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``. ``sriov_totalvfs``.
.. code-block:: .. 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 <hostname> <name-or-address> --driver <vf-driver> --vf-driver <vf driver> -N <number-of-vfs> --enable true ~(keystone_admin)]$ system host-device-modify <hostname> <name-or-address> --driver <vf-driver> --vf-driver <vf driver> -N <number-of-vfs> --enable true
#. If the replaced |PCI| card is an N3000 and its |FPGA| was not #. 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`. :ref:`index-intel-n3000-support`.
#. Unlock the host. #. 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 <hostname> ~(keystone_admin)]$ system host-unlock <hostname>
#. If the host in question is the single host of an |AIO-SX| subcloud deployment, #. If the host in question is the single host of an |AIO-SX| subcloud
set the subcloud as managed. deployment, set the subcloud as managed.
.. code-block:: .. code-block::

16
doc/source/node_management/kubernetes/hardware_acceleration_devices/n3000-and-acc100-replacement-with-the-same-vendor-and-device-id-cccabcdc5d43.rst
View File

@ -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-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 The following procedure allows the replacement of an N3000 or ACC100 device on
host, without requiring a host or system (in case of |AIO-SX|) re-install and 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 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 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-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| .. rubric:: |prereq|
The vendor and device-id of currently installed |PCI| card can be The vendor and device-id of currently installed |PCI| card can be obtained
obtained with: with:
.. code-block:: none .. code-block:: none

25
doc/source/node_management/kubernetes/node_interfaces/nic-replacement-with-the-same-vendor-and-device-id-32942b7b05e5.rst
View File

@ -1,23 +1,24 @@
.. _nic-replacement-with-the-same-vendor-and-device-id-32942b7b05e5: .. _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 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, requiring a host or system (in case of |AIO-SX|) re-install and
in the case of the replaced NIC having the same vendor or device id info. 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 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-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. 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 capabilities, the interface's new |MAC| will be updated internally and no
reconfiguration is required. Assuming that the replacement will occur on 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 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``). ``platform``).
.. rubric:: |proc| .. rubric:: |proc|
@ -34,7 +35,7 @@ types of NIC classes (``pci-sriov``, ``data``, ``pci-passthrough``,
#. Power up the host. #. Power up the host.
#. Unock the host. #. Unlock the host.
.. code-block:: none .. code-block:: none
@ -42,6 +43,6 @@ types of NIC classes (``pci-sriov``, ``data``, ``pci-passthrough``,
.. rubric:: |result| .. rubric:: |result|
The host is rebooted, and its Availability State is reported as In-Test. After The host is rebooted, and its Availability State is reported as ``In-Test``.
a few minutes, it is reported as Unlocked, Enabled, and Available. After a few minutes, it is reported as ``Unlocked``, ``Enabled``, and
``Available``.

26
doc/source/node_management/kubernetes/node_interfaces/replace-a-nic-with-a-different-vendor-or-device-id-b406c1c190a9.rst
View File

@ -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 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 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 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 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 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 to take effect. After doing so, you must lock the host again to reconfigure
the interface with the desired or previous configuration. the interface with the desired or previous configuration.
* If the affected interfaces are unconfigured (class is none and “used by i/f” * If the affected interfaces are unconfigured (class is ``none`` and the
is empty) the procedure described in :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 :ref:`nic-replacement-with-the-same-vendor-and-device-id-32942b7b05e5` can be
followed. followed.
.. rubric:: |proc| .. rubric:: |proc|
.. note:: .. note::
UUID values in the output shown below have been truncated for display |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 purposes. When using a |UUID| value as input to a command, use the entire 36
character string. character string.
#. If the host in question is the single host of an |AIO-SX| subcloud deployment, #. If the host in question is the single host of an |AIO-SX| subcloud
set the subcloud as managed deployment, set the subcloud as unmanaged.
.. code-block:: none .. code-block:: none
@ -292,10 +293,11 @@ reapply it after replacing the NIC card.
~(keystone_admin)]$ system host-if-add <hostname> <previous-sub-interface-name> <iftype [ae,vlan,vf,ethernet]> <interface-name> <previous-parameters> ~(keystone_admin)]$ system host-if-add <hostname> <previous-sub-interface-name> <iftype [ae,vlan,vf,ethernet]> <interface-name> <previous-parameters>
#. Reconnect the sub-interface with desired network (if it was previously #. Reconnect the sub-interface with the desired network (if it was previously
connected). 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 .. code-block:: none
@ -332,11 +334,9 @@ reapply it after replacing the NIC card.
~(keystone_admin)]$ system host-unlock <hostname> ~(keystone_admin)]$ system host-unlock <hostname>
#. If the host in question is the single host of an |AIO-SX| subcloud deployment, #. If the host in question is the single host of an |AIO-SX| subcloud
set the subcloud as managed deployment, set the subcloud as managed.
.. code-block:: none .. code-block:: none
~(keystone_admin)]$ dcmanager subcloud manage <subcloud-name> ~(keystone_admin)]$ dcmanager subcloud manage <subcloud-name>