starlingx/docs
Code Issues Proposed changes

Merge "Node feature discovery. This review is opened for editorial changes made in upstream. (dsr8)."

Browse Source
This commit is contained in:
Zuul 2023-08-25 16:06:51 +00:00 committed by Gerrit Code Review
commit 0df05f304c
2 changed files with 36 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
doc/source/node_management/kubernetes/install-node-feature-discovery-nfd-starlingx-application-70f6f940bb4a.rst
View File

@ -1,42 +1,40 @@
.. _install-node-feature-discovery-nfd-starlingx-application-70f6f940bb4a: .. _install-node-feature-discovery-nfd-starlingx-application-70f6f940bb4a:
====================================================================== ==========================================
Install Node Feature Discovery (NFD) |prod| Application Install Node Feature Discovery Application
====================================================================== ==========================================
Node Feature Discovery (NFD) detects hardware features available on each node Node Feature Discovery (NFD) detects hardware features available on each node
in a kubernetes cluster and advertises those features using Kubernetes node in a kubernetes cluster and advertises those features using kubernetes node
labels. This procedure walks you through the process of installing the |NFD| labels. Use the following procedure to install the |NFD| application.
|prod| Application.
.. rubric:: |prereq| .. rubric:: |prereq|
Before attempting to install the |NFD| |prod| application, ensure that your Before attempting to install the |NFD| application, ensure that your
system meets the following requirements: system meets the following requirements:
#. Ensure that you have Kubernetes version v1.24.4 installed. If not, follow #. Ensure that you have at least kubernetes version v1.24.4 installed. If
the steps to upgrade the Kubernetes components. For detailed instructions on kubernetes v1.24.4 is not installed, see
how to upgrade, see :ref:`manual-kubernetes-components-upgrade`. :ref:`manual-kubernetes-components-upgrade` for more details.
#. If you have previously installed the |NFD| Helm Chart, you need to uninstall #. If you have previously installed the |NFD| Helm chart, you need to uninstall
it before proceeding with the new installation. To uninstall, use the it before proceeding with the new installation. To uninstall, use the
following command: following command:
.. code-block:: none .. code-block:: none
helm uninstall node-feature-discovery -n <namespace> ~(keystone_admin)]$ helm uninstall node-feature-discovery -n <namespace>
Replace <namespace> with the namespace where you have the |NFD| Helm Chart <namespace> is the location, where you installed the |NFD| Helm chart.
installed.
.. rubric:: |proc| .. rubric:: |proc|
Follow these steps to install the |NFD| |prod| Application: Use the following steps to install the |NFD| application:
#. Locate the |NFD| |prod| App tarball in the #. Locate the |NFD| tarball in the ``/usr/local/share/applications/helm``
``/usr/local/share/applications/helm`` directory. directory.
For example: For example:
@ -54,13 +52,13 @@ Follow these steps to install the |NFD| |prod| Application:
Replace <version> with the latest version number. Replace <version> with the latest version number.
#. Verify that the |NFD| |prod| application has been uploaded successfully. #. Verify that the |NFD| application has been uploaded successfully.
.. code-block:: none .. code-block:: none
~(keystone_admin)]$ system application-list ~(keystone_admin)]$ system application-list
#. Apply the application using the following command. #. Apply the updates using the following command.
.. code-block:: none .. code-block:: none
@ -72,30 +70,27 @@ Follow these steps to install the |NFD| |prod| Application:
~(keystone_admin)]$ watch system application-list ~(keystone_admin)]$ watch system application-list
OR or
~(keystone_admin)]$ watch kubectl get pods -n node-feature-discovery ~(keystone_admin)]$ watch kubectl get pods -n node-feature-discovery
.. rubric:: |result| .. rubric:: |result|
After a successful installation, the |NFD| |prod| deploys as the follows: - A worker pod is created for each node in the kubernetes cluster. These worker
pods gather information about node features periodically and updates the
- A worker pod is created for each node in the Kubernetes cluster. These worker labels associated with the nodes.
pods gather information about node features periodically and update the
labels associated with the nodes based on the detected features.
- Additionally, there is one master pod that gathers all the updated data from - Additionally, there is one master pod that gathers all the updated data from
worker pods and reporting it to Kubernetes for efficient feature management. worker pods and reports it for efficient feature management.
The |NFD| |prod| application is now installed on your system, and the hardware The |NFD| application is now installed on your system, and the hardware
features available on each node in the Kubernetes cluster will be detected and features available on each node in the kubernetes cluster will be detected and
advertised using Kubernetes node labels. You can check the labels using the advertised using kubernetes node labels. To check the label for any
following command for any configuration: configuration, use the following command:
.. code-block:: none .. code-block:: none
kubectl label node/<node's name> --list | grep "feature.node.kubernetes.io" ~(keystone_admin)]$ kubectl label node/<node's name> --list | grep "feature.node.kubernetes.io"
Replace <node's name> with the specific node name such as controller-0, Where <node's name> is name of the node.
controller-1, and so on.

19
doc/source/node_management/kubernetes/uninstall-node-feature-discovery-nfd-starlingx-application-a582bfdadfb8.rst
View File

@ -1,30 +1,27 @@
.. _uninstall-node-feature-discovery-nfd-starlingx-application-a582bfdadfb8: .. _uninstall-node-feature-discovery-nfd-starlingx-application-a582bfdadfb8:
====================================================================== ============================================
Uninstall Node Feature Discovery (NFD) |prod| Application Uninstall Node Feature Discovery Application
====================================================================== ============================================
Follow these steps to remove the Node Feature Discovery (NFD) |prod| Use the following procedure to uninstall the |NFD| application.
Application.
.. rubric:: |proc| .. rubric:: |proc|
#. Remove |NFD| pods and resources using the following command: #. Remove the |NFD| pods and resources using the following command:
.. code-block:: none .. code-block:: none
~(keystone_admin)]$ system application-remove node-feature-discovery ~(keystone_admin)]$ system application-remove node-feature-discovery
#. Remove |NFD| helm chart and application using the following command: #. Remove the |NFD| helm chart and application using the following command:
.. code-block:: none .. code-block:: none
~(keystone_admin)]$ system application-delete node-feature-discovery ~(keystone_admin)]$ system application-delete node-feature-discovery
After completion of the uninstallation process, the |NFD| application will be Once uninstallation is complete, all related pods, resources and configurations
completely removed from your system. All related pods, resources, and will be removed from the system.
configurations associated with |NFD| will no longer be present, ensuring a
clean removal of the application.