From 9d84a37b4cb234d9d5273761feb289d0aed67c01 Mon Sep 17 00:00:00 2001 From: Dinesh Neelapu Date: Tue, 22 Aug 2023 09:51:44 +0000 Subject: [PATCH] Node feature discovery. This review is opened for editorial changes made in upstream. (dsr8). This review is created for the new changes requested. The initial review: https://review.opendev.org/c/starlingx/docs/+/890635 Change-Id: I8999f86e4d7d1cbcd6528fe832bd06d035289f17 Signed-off-by: Dinesh Neelapu --- ...nfd-starlingx-application-70f6f940bb4a.rst | 61 +++++++++---------- ...nfd-starlingx-application-a582bfdadfb8.rst | 19 +++--- 2 files changed, 36 insertions(+), 44 deletions(-) diff --git a/doc/source/node_management/kubernetes/install-node-feature-discovery-nfd-starlingx-application-70f6f940bb4a.rst b/doc/source/node_management/kubernetes/install-node-feature-discovery-nfd-starlingx-application-70f6f940bb4a.rst index 4aad3c735..7d3ca02d9 100644 --- a/doc/source/node_management/kubernetes/install-node-feature-discovery-nfd-starlingx-application-70f6f940bb4a.rst +++ b/doc/source/node_management/kubernetes/install-node-feature-discovery-nfd-starlingx-application-70f6f940bb4a.rst @@ -1,42 +1,40 @@ .. _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 -in a kubernetes cluster and advertises those features using Kubernetes node -labels. This procedure walks you through the process of installing the |NFD| -|prod| Application. +in a kubernetes cluster and advertises those features using kubernetes node +labels. Use the following procedure to install the |NFD| application. .. 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: -#. Ensure that you have Kubernetes version v1.24.4 installed. If not, follow - the steps to upgrade the Kubernetes components. For detailed instructions on - how to upgrade, see :ref:`manual-kubernetes-components-upgrade`. +#. Ensure that you have at least kubernetes version v1.24.4 installed. If + kubernetes v1.24.4 is not installed, see + :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 following command: .. code-block:: none - helm uninstall node-feature-discovery -n + ~(keystone_admin)]$ helm uninstall node-feature-discovery -n - Replace with the namespace where you have the |NFD| Helm Chart - installed. + is the location, where you installed the |NFD| Helm chart. .. 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 - ``/usr/local/share/applications/helm`` directory. +#. Locate the |NFD| tarball in the ``/usr/local/share/applications/helm`` + directory. For example: @@ -54,13 +52,13 @@ Follow these steps to install the |NFD| |prod| Application: Replace 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 ~(keystone_admin)]$ system application-list -#. Apply the application using the following command. +#. Apply the updates using the following command. .. code-block:: none @@ -72,30 +70,27 @@ Follow these steps to install the |NFD| |prod| Application: ~(keystone_admin)]$ watch system application-list - OR + or ~(keystone_admin)]$ watch kubectl get pods -n node-feature-discovery .. 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 update the - labels associated with the nodes based on the detected features. +- A worker pod is created for each node in the kubernetes cluster. These worker + pods gather information about node features periodically and updates the + labels associated with the nodes. - 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 -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 -following command for any configuration: +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 +advertised using kubernetes node labels. To check the label for any +configuration, use the following command: .. code-block:: none - kubectl label node/ --list | grep "feature.node.kubernetes.io" + ~(keystone_admin)]$ kubectl label node/ --list | grep "feature.node.kubernetes.io" -Replace with the specific node name such as controller-0, -controller-1, and so on. +Where is name of the node. diff --git a/doc/source/node_management/kubernetes/uninstall-node-feature-discovery-nfd-starlingx-application-a582bfdadfb8.rst b/doc/source/node_management/kubernetes/uninstall-node-feature-discovery-nfd-starlingx-application-a582bfdadfb8.rst index 94338aea3..96d5f6b4d 100644 --- a/doc/source/node_management/kubernetes/uninstall-node-feature-discovery-nfd-starlingx-application-a582bfdadfb8.rst +++ b/doc/source/node_management/kubernetes/uninstall-node-feature-discovery-nfd-starlingx-application-a582bfdadfb8.rst @@ -1,30 +1,27 @@ .. _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| -Application. +Use the following procedure to uninstall the |NFD| application. .. rubric:: |proc| -#. Remove |NFD| pods and resources using the following command: +#. Remove the |NFD| pods and resources using the following command: .. code-block:: none ~(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 ~(keystone_admin)]$ system application-delete node-feature-discovery -After completion of the uninstallation process, the |NFD| application will be -completely removed from your system. All related pods, resources, and -configurations associated with |NFD| will no longer be present, ensuring a -clean removal of the application. +Once uninstallation is complete, all related pods, resources and configurations +will be removed from the system.