starlingx/docs
Code Issues Proposed changes

Merge "Intel Device Plugins Operator Application uninstall"

Browse Source
This commit is contained in:
Zuul 2024-08-29 20:16:25 +00:00 committed by Gerrit Code Review
commit eb7899ed20
9 changed files with 82 additions and 89 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/admintasks/kubernetes/index-admintasks-kub-ebc55fefc368.rst
View File

@ -49,18 +49,6 @@ Optimize application performance
kubernetes-topology-manager-policies
---------------------------------
QAT Device and GPU Device Plugins
---------------------------------
.. toctree::
:maxdepth: 1
intel-device-plugins-operator-application-overview-c5de2a6212ae
qat-device-plugin-configuration-616551306371
gpu-device-plugin-configuration-615e2f6edfba
uninstall-intel-device-plugins-operator-application-e712eabc1e49
--------------
Metrics Server
--------------

32
doc/source/admintasks/kubernetes/intel-device-plugins-operator-application-overview-c5de2a6212ae.rst
View File

@ -1,32 +0,0 @@
.. WARNING: Add no lines of text between the label immediately following
.. and the title.
.. _intel-device-plugins-operator-application-overview-c5de2a6212ae:
==================================================
Intel Device Plugins Operator Application Overview
==================================================
This application provides a set of plugins developed by Intel to facilitate the
use of Intel hardware features in Kubernetes clusters. These plugins are
designed to enable and optimize the use of Intel-specific hardware capabilities
in a Kubernetes environment.
The following plugins are supported:
* Intel |QAT| device plugin 0.26.0
* Intel |GPU| device plugin 0.26.0
Install Intel Device Plugins Operator Application
-------------------------------------------------
Intel device plugin Operator application is required to be installed for
configuring the Intel |QAT| device plugin and the Intel |GPU| device plugin.
Installation steps are mentioned in the respective device plugin configuration
sections below.
:ref:`qat-device-plugin-configuration-616551306371`
:ref:`gpu-device-plugin-configuration-615e2f6edfba`

23
doc/source/admintasks/kubernetes/uninstall-intel-device-plugins-operator-application-e712eabc1e49.rst
View File

@ -1,23 +0,0 @@
.. WARNING: Add no lines of text between the label immediately following
.. and the title.
.. _uninstall-intel-device-plugins-operator-application-e712eabc1e49:
===================================================
Uninstall Intel Device Plugins Operator Application
===================================================
Use the following steps to uninstall the Intel Device Plugins operator
application:
#. Remove the application using the following command:
.. code-block::
~(keystone_admin)]$ system application-remove intel-device-plugins-operator
#. Delete application using the following command:
.. code-block::
~(keystone_admin)]$ system application-delete intel-device-plugins-operator

0
doc/source/usertasks/kubernetes/data-streaming-accelerator-db88a67c930c.rst → doc/source/node_management/kubernetes/data-streaming-accelerator-db88a67c930c.rst
View File

6
doc/source/admintasks/kubernetes/gpu-device-plugin-configuration-615e2f6edfba.rst → doc/source/node_management/kubernetes/gpu-device-plugin-configuration-615e2f6edfba.rst
View File

@ -27,9 +27,11 @@ in |prod|.
.. code-block::
~(keystone_admin)]$ system application-upload /usr/local/share/applications/helm/node-feature-discovery*.tgz
~(keystone_admin)]$ system application-upload /usr/local/share/applications/helm/node-feature-discovery-<version>.tgz
~(keystone_admin)]$ system application-apply node-feature-discovery
Replace ``<version>`` with the latest version number.
Enable Intel GPU Device Plugin
------------------------------
@ -56,7 +58,7 @@ Enable Intel GPU Device Plugin
.. code-block::
~(keystone_admin)]$ system helm-override-list intel-device-plugins-operator-long
~(keystone_admin)]$ system helm-override-list intel-device-plugins-operator --long
#. Enable |GPU| Helm chart using the following command:

10
doc/source/node_management/kubernetes/index-node-mgmt-kub-5ff5993b9c60.rst
View File

@ -401,6 +401,16 @@ Intel Ethernet Operator |prod| Application
configure-intel-e810-nics-using-intel-ethernet-operator
-----------------------------------------
Intel Device Plugins Operator Application
-----------------------------------------
.. toctree::
:maxdepth: 1
intel-device-plugins-operator-application-overview-c5de2a6212ae
-------------
Provision BMC
-------------

56
doc/source/node_management/kubernetes/intel-device-plugins-operator-application-overview-c5de2a6212ae.rst Normal file
View File

@ -0,0 +1,56 @@
.. WARNING: Add no lines of text between the label immediately following
.. and the title.
.. _intel-device-plugins-operator-application-overview-c5de2a6212ae:
=========================================
Intel Device Plugins Operator Application
=========================================
This application provides a set of plugins developed by Intel to facilitate the
use of Intel hardware features in Kubernetes clusters. These plugins are
designed to enable and optimize the use of Intel-specific hardware capabilities
in a Kubernetes environment.
The following plugins are supported:
* Intel |QAT| device plugin
* Intel |GPU| device plugin
* Intel |DSA| device plugin
Install Intel Device Plugins Operator Application
-------------------------------------------------
Intel device plugin Operator application is required to be installed for
configuring the Intel |QAT| device plugin, the Intel |GPU| device plugin and
the Intel |DSA| device plugin. Installation steps are mentioned in the
respective device plugin configuration sections below.
.. toctree::
:maxdepth: 1
qat-device-plugin-configuration-616551306371
gpu-device-plugin-configuration-615e2f6edfba
data-streaming-accelerator-db88a67c930c
Uninstall Intel Device Plugins Operator Application
---------------------------------------------------
Use the following steps to uninstall the Intel Device Plugins operator
application:
#. Remove the application using the following command:
.. code-block::
~(keystone_admin)]$ system application-remove intel-device-plugins-operator
#. Delete application using the following command:
.. code-block::
~(keystone_admin)]$ system application-delete intel-device-plugins-operator

23
doc/source/admintasks/kubernetes/qat-device-plugin-configuration-616551306371.rst → doc/source/node_management/kubernetes/qat-device-plugin-configuration-616551306371.rst
View File

@ -24,13 +24,13 @@ in |prod|.
.. code-block::
$ for i in 4942 4940; do lspci -d** **8086:$i; done
$ for i in 4942 4940; do lspci -d 8086:$i; done
- Verify |QAT| |SRIOV| virtual functions are configured.
.. code-block::
$ for i in 4943 4941; do lspci -d** **8086:$i; done
$ for i in 4943 4941; do lspci -d 8086:$i; done
$ sudo /etc/init.d/qat_service status # Must list all the virtual functions
@ -58,7 +58,7 @@ in |prod|.
vfio_pci 69632 0
vfio_virqfd 16384 1 vfio_pci
vfio 45056 4 intel_qat,vfio_mdev,vfio_iommu_type1,\ **vfio_pci**
fio 45056 4 intel_qat,vfio_mdev,vfio_iommu_type1,vfio_pci
irqbypass 16384 3 intel_qat,vfio_pci,kvm
- Node Feature Discovery application must be installed, using the following
@ -66,9 +66,10 @@ in |prod|.
.. code-block::
~(keystone_admin)]$ system application-upload /usr/local/share/applications/helm/node-feature-discovery*.tgz
~(keystone_admin)]$ system application-upload /usr/local/share/applications/helm/node-feature-discovery-<version>.tgz
~(keystone_admin)]$ system application-apply node-feature-discovery
Replace ``<version>`` with the latest version number.
Enable Intel QAT Device Plugin
------------------------------
@ -86,7 +87,7 @@ Kubernetes host.
.. code-block::
~(keystone_admin**\ **)]$ system application-upload intel-device-plugins-operator-<version>.tgz
~(keystone_admin)]$ system application-upload intel-device-plugins-operator-<version>.tgz
Replace ``<version>`` with the latest version number.
@ -94,13 +95,13 @@ Kubernetes host.
.. code-block::
~(keystone_admin**\ **)]$ system application-list
~(keystone_admin)]$ system application-list
#. Check the Hellm chart status.
#. Check the Helm chart status.
.. code-block::
~(keystone_admin*)]$ system helm-override-list intel-device-plugins-operator -long**
~(keystone_admin)]$ system helm-override-list intel-device-plugins-operator --long
#. Enable QAT helm chart.
@ -118,7 +119,7 @@ Kubernetes host.
.. code-block::
~(keystone_admin*)]$ watch -n 5 system application-list
~(keystone_admin)]$ watch -n 5 system application-list
OR
@ -144,7 +145,7 @@ Kubernetes host.
.. code-block::
$ kubectl describe node <node name> \| grep qat.intel.com/asym-dc
$ kubectl describe node <node name> | grep qat.intel.com/asym-dc
Capacity:
---
@ -231,7 +232,7 @@ This section describes the steps for using |QAT| device plugin.
NAME READY STATUS RESTARTS AGE
dpdk-test-crypto-perf 1/1 Running 0 27m
$ kubectl describe pod dpdk-test-crypto-perf**
$ kubectl describe pod dpdk-test-crypto-perf
Requests:
---

9
doc/source/usertasks/kubernetes/index-usertasks-kub-1291759aa985.rst
View File

@ -195,12 +195,3 @@ Tools
:maxdepth: 1
vran-tools-2c3ee49f4b0b
--------------------------
Data Streaming Accelerator
--------------------------
.. toctree::
:maxdepth: 1
data-streaming-accelerator-db88a67c930c