starlingx/docs
Code Issues Proposed changes

Update needed to remove the intel multi-driver support section (dsR10 100/200)

Browse Source 
Remove section from customer documentation as it is not applicable.
Remove occurrences of "multi-drivers-switch"

Change-Id: I3b538fd4df2dbd331f9b1ed56ee2d809adcacd58
Signed-off-by: Elisamara Aoki Gonçalves <elisamaraaoki.goncalves@windriver.com>
This commit is contained in:
Elisamara Aoki Gonçalves 2025-02-13 19:08:10 +00:00
parent 2ea2ea395c
commit 414493ce3d
5 changed files with 2 additions and 182 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/_vendor/rl-strings.txt
View File

@ -415,7 +415,6 @@
.. |validate-existing-registry-and-new-url| replace:: :ref:`Display Updated Registries' URLs and Auth-Secrets <validate-existing-registry-and-new-url>`
.. |add-the-ca-certificate-for-new-registry| replace:: :ref:`Add the CA Certificate for New Registry <add-the-ca-certificate-for-new-registry>`
.. |resynchronizing-a-host-to-the-ntp-server| replace:: :ref:`Resynchronize a Host to the NTP Server <resynchronizing-a-host-to-the-ntp-server>`
.. |intel-multi-driver-version-5e23e989daf5| replace:: :ref:`Intel Multi-driver Version <intel-multi-driver-version-5e23e989daf5>`
.. |converting-a-duplex-system-to-direct-connection| replace:: :ref:`Convert a Duplex System to Direct Connection <converting-a-duplex-system-to-direct-connection>`
.. |branding-the-login-banner-on-a-commissioned-system| replace:: :ref:`Brand the Login Banner on a Commissioned System <branding-the-login-banner-on-a-commissioned-system>`
.. |instance-specific-considerations-d9d9509c79dd| replace:: :ref:`Instance Specific Considerations <instance-specific-considerations-d9d9509c79dd>`

2
doc/source/dist_cloud/kubernetes/install-a-subcloud-in-phases-0ce5f6fbf696.rst
View File

@ -218,7 +218,7 @@ controllers (for example, ``/home/sysadmin/docker-registry-ca-cert.pem``).
# Configure custom arguments applied at boot within the installed subcloud.
# Multiple boot arguments can be provided by separating each argument by a
# single comma. Spaces are not allowed.
# Example: extra_boot_params: multi-drivers-switch=cvl-2.54
# Example: extra_boot_params: out-of-tree-drivers=none
# extra_boot_params:
.. _increase-subcloud-platform-backup-size:

2
doc/source/dist_cloud/kubernetes/installing-a-subcloud-using-redfish-platform-management-service.rst
View File

@ -215,7 +215,7 @@ subcloud, the subcloud installation has these phases:
# Configure custom arguments applied at boot within the installed subcloud.
# Multiple boot arguments can be provided by separating each argument by a
# single comma. Spaces are not allowed.
# Example: extra_boot_params: multi-drivers-switch=cvl-2.54
# Example: extra_boot_params: out-of-tree-drivers=none
# extra_boot_params:
.. _increase-subcloud-platform-backup-size:

10
doc/source/system_configuration/kubernetes/index-sysconf-kub-78f0e1e9ca5a.rst
View File

@ -110,16 +110,6 @@ collectd Configuration
configure-collectd-to-store-host-performance-data-caf7802851bc
---------------------------------
Change Intel Multi-Driver Version
---------------------------------
.. toctree::
:maxdepth: 1
intel-multi-driver-version-5e23e989daf5
----------------------------
Switch Intel Driver Versions
----------------------------

169
doc/source/system_configuration/kubernetes/intel-multi-driver-version-5e23e989daf5.rst
View File

@ -1,169 +0,0 @@
.. _intel-multi-driver-version-5e23e989daf5:
==========================
Intel Multi-driver Version
==========================
.. rubric:: |context|
.. contents:: |minitoc|
:local:
:depth: 1
This sections describes how to change the Intel driver bundle version.
Currently there are 3 CVL versions available:
.. warning::
The |NIC| firmware (NVM) has to align with one of the selected driver
bundles listed below.
- ``cvl-4.0.1`` (default)
- ice: 1.9.11 / Required NVM/firmware: 4.20 or 4.22 (Intel E810)
- i40e: 2.20.12 / Required NVM/firmware: 8.70 or 9.20
- iavf: 4.5.3.2
.. Reverted ice driver to 1.5.8
- ``cvl-2.54`` (legacy)
- ice: 1.5.8 / Required NVM/firmware: 2.54
- i40e: 2.14.13 / Required NVM/firmware: 8.21 or 8.24
- iavf: 4.0.1
- ``cvl-4.10`` (latest)
- ice driver: 1.10.1.2 / Required NVM/firmware: 4.10 (Silicom STS2) / 4.10 (Intel E810)
- i40e driver: 2.21.12 / Required NVM/firmware: 9.10
- iavf driver: 4.6.1
.. note::
`cvl-4.10`` is only recommended if the Silicom STS2 card is used.
---------------------------------
Change Intel Multi-driver Version
---------------------------------
On initial installation, the system will use the default driver bundle version
which is ``cvl-4.0.1``. The chosen driver bundle will be applied subsequently
as part of the deployment configuration, if specified.
When there is no driver bundle specified as part of the deployment, the system
will continue to use the default driver bundle.
For example to change the driver bundle to the legacy version, add the system
service parameter ``intel_nic_driver_version`` to ``cvl-2.54``.
.. code-block:: none
~(keystone_admin)$ system service-parameter-add platform config intel_nic_driver_version=cvl-2.54
To change the driver bundle back to the default version, there are two options:
#. Modify the system service parameter ``intel_nic_driver_version`` to
``cvl-4.0.1``.
.. code-block:: none
~(keystone_admin)$ system service-parameter-modify platform config intel_nic_driver_version=cvl-4.0.1
#. Apply the service parameter change.
.. code-block:: none
~(keystone_admin)$ system service-parameter-apply platform
Applying platform service parameters
#. Remove the system service parameter ``intel_nic_driver_version``.
.. code-block:: none
~(keystone_admin)$ system service-parameter-list --service platform --section config --name intel_nic_driver_version
+--------------------------------------+------------+---------+---------------------------+-----------+-------------+----------+
| uuid | service | section | name | value | personality | resource |
+--------------------------------------+------------+---------+---------------------------+-----------+-------------+----------+
| 84306212-d96d-4a2a-8cc0-2d48781e006c | platform | config | intel_nic_driver_version | cvl-2.54 | None | None |
+--------------------------------------+------------+---------+---------------------------+-----------+-------------+----------+
~(keystone_admin)$ system service-parameter-delete 84306212-d96d-4a2a-8cc0-2d48781e006c
To apply the service parameter change, all hosts need to be locked and
unlocked for each host depending on the deployed configuration, using the
following commands.
For |AIO-SX| deployments:
.. code-block:: none
~(keystone_admin)$ system host-lock controller-0
~(keystone_admin)$ system host-unlock controller-0
For |AIO-DX| and Standards deployments, after controller-1 is locked/unlocked
swact controller-0 to make controller-1 the active node. The next set of
commands are executed on controller-0 node:
.. code-block:: none
~(keystone_admin)$ system host-lock controller-1
~(keystone_admin)$ system host-unlock controller-1
~(keystone_admin)$ system host-swact controller-0
On controller-1, after controller-0 is locked/unlocked swact controller-1 to go
back to controller-0 as the active node. The next set of commands are executed
on controller-1 node:
.. code-block:: none
~(keystone_admin)$ system host-lock controller-0
~(keystone_admin)$ system host-unlock controller-0
~(keystone_admin)$ system host-swact controller-1
For each worker node in the configuration execute the commands from
controller-0:
.. code-block:: none
~(keystone_admin)$ system host-lock worker-0
~(keystone_admin)$ system host-unlock worker-0
To verify the current Intel driver version use ``ethtool -i`` on the desired
Intel network interface. For example:
.. code-block:: none
~(keystone_admin)$ ethtool -i ens785f0 | egrep '^(driver|version):'
driver: i40e
version: 2.20.12
Upgrades
--------
For an upgrade, the default drivers will be configured after the upgrade.
To set the non-default drivers for an upgrade, set the driver bundle on
controller-0 prior to the upgrade. For example, to set legacy drivers use the
following commands:
.. code-block:: none
~(keystone_admin)$ system service-parameter-add platform config intel_nic_driver_version=cvl-2.54 --resource platform::compute::grub::params::g_intel_nic_driver_version
~(keystone_admin)$ system service-parameter-apply platform
.. note::
After the upgrade is completed, all hosts need to be locked and unlocked to
load the non-default drivers.
Backup and Restore
------------------
In case a Backup and Restore is performed, after unlocking the host during a
restore operation, the system will be configured with the correct multi-driver
version, but the drivers will be loaded to the default version.
To load the drivers to the correct configured version a second host-unlock will
be needed.
.. only:: partner
.. include:: /_includes/intel-multi-driver-version.rest