From e836e07414c64fa8b227bff4966832806a8fc25d Mon Sep 17 00:00:00 2001 From: Github Actions Date: Wed, 10 Jul 2024 10:40:10 +0000 Subject: [PATCH] Update documentation for v0.15 Auto-generated from v0.15.6 by 'update-gh-pages.sh' --- v0.15/404.html | 2 +- v0.15/contributing/index.html | 2 +- v0.15/deployment/helm.html | 2 +- v0.15/deployment/image-variants.html | 2 +- v0.15/deployment/index.html | 2 +- v0.15/deployment/kustomize.html | 2 +- v0.15/deployment/metrics.html | 2 +- v0.15/deployment/operator.html | 2 +- v0.15/deployment/tls.html | 2 +- v0.15/deployment/uninstallation.html | 2 +- v0.15/developer-guide/index.html | 2 +- v0.15/get-started/index.html | 2 +- v0.15/get-started/introduction.html | 2 +- v0.15/get-started/quick-start.html | 2 +- v0.15/reference/gc-commandline-reference.html | 2 +- v0.15/reference/index.html | 2 +- v0.15/reference/master-commandline-reference.html | 2 +- v0.15/reference/master-configuration-reference.html | 2 +- v0.15/reference/plugin-commandline-reference.html | 2 +- v0.15/reference/topology-updater-commandline-reference.html | 2 +- v0.15/reference/topology-updater-configuration-reference.html | 2 +- v0.15/reference/versions.html | 2 +- v0.15/reference/worker-commandline-reference.html | 2 +- v0.15/reference/worker-configuration-reference.html | 2 +- v0.15/search.html | 2 +- v0.15/sitemap.xml | 2 +- v0.15/usage/custom-resources.html | 2 +- v0.15/usage/customization-guide.html | 2 +- v0.15/usage/examples-and-demos.html | 2 +- v0.15/usage/features.html | 2 +- v0.15/usage/index.html | 2 +- v0.15/usage/kubectl-plugin.html | 2 +- v0.15/usage/nfd-gc.html | 2 +- v0.15/usage/nfd-master.html | 2 +- v0.15/usage/nfd-topology-updater.html | 2 +- v0.15/usage/nfd-worker.html | 2 +- v0.15/usage/using-labels.html | 2 +- 37 files changed, 37 insertions(+), 37 deletions(-) diff --git a/v0.15/404.html b/v0.15/404.html index a155781ec..a94b644bb 100644 --- a/v0.15/404.html +++ b/v0.15/404.html @@ -1 +1 @@ - 404 · Node Feature Discovery

404

Not Found


Node Feature Discovery
v0.15
Versions
GitHub
Homepage
Issues
Download

This Software is under the terms of Apache License 2.0.
\ No newline at end of file + 404 · Node Feature Discovery

404

Not Found


Node Feature Discovery
v0.15
Versions
GitHub
Homepage
Issues
Download

This Software is under the terms of Apache License 2.0.
\ No newline at end of file diff --git a/v0.15/contributing/index.html b/v0.15/contributing/index.html index 6178346e2..39398bb5c 100644 --- a/v0.15/contributing/index.html +++ b/v0.15/contributing/index.html @@ -1 +1 @@ - Contributing · Node Feature Discovery

Contributing


Community

You can reach us via the following channels:

Governance

This is a SIG-node subproject, hosted under the Kubernetes SIGs organization in Github. The project was established in 2016 and was migrated to Kubernetes SIGs in 2018.

License

This is open source software released under the Apache 2.0 License.


Node Feature Discovery
v0.15
Versions
GitHub
Homepage
Issues
Download

This Software is under the terms of Apache License 2.0.
\ No newline at end of file + Contributing · Node Feature Discovery

Contributing


Community

You can reach us via the following channels:

Governance

This is a SIG-node subproject, hosted under the Kubernetes SIGs organization in Github. The project was established in 2016 and was migrated to Kubernetes SIGs in 2018.

License

This is open source software released under the Apache 2.0 License.


Node Feature Discovery
v0.15
Versions
GitHub
Homepage
Issues
Download

This Software is under the terms of Apache License 2.0.
\ No newline at end of file diff --git a/v0.15/deployment/helm.html b/v0.15/deployment/helm.html index 49992f239..da950b6db 100644 --- a/v0.15/deployment/helm.html +++ b/v0.15/deployment/helm.html @@ -1,4 +1,4 @@ - Helm · Node Feature Discovery

Deployment with Helm

Table of contents

  1. Prerequisites
  2. Deployment
  3. Configuration
  4. Uninstalling the chart
  5. Chart parameters
    1. General parameters
    2. Master pod parameters
    3. Worker pod parameters
    4. Topology updater parameters
    5. Garbage collector parameters

Node Feature Discovery provides a Helm chart to manage its deployment.

NOTE: NFD is not ideal for other Helm charts to depend on as that may result in multiple parallel NFD deployments in the same cluster which is not fully supported by the NFD Helm chart.

Prerequisites

Helm package manager should be installed.

Deployment

To install the latest stable version:

export NFD_NS=node-feature-discovery
+        Helm · Node Feature Discovery                      

Deployment with Helm

Table of contents

  1. Prerequisites
  2. Deployment
  3. Configuration
  4. Uninstalling the chart
  5. Chart parameters
    1. General parameters
    2. Master pod parameters
    3. Worker pod parameters
    4. Topology updater parameters
    5. Garbage collector parameters

Node Feature Discovery provides a Helm chart to manage its deployment.

NOTE: NFD is not ideal for other Helm charts to depend on as that may result in multiple parallel NFD deployments in the same cluster which is not fully supported by the NFD Helm chart.

Prerequisites

Helm package manager should be installed.

Deployment

To install the latest stable version:

export NFD_NS=node-feature-discovery
 helm repo add nfd https://kubernetes-sigs.github.io/node-feature-discovery/charts
 helm repo update
 helm install nfd/node-feature-discovery --namespace $NFD_NS --create-namespace --generate-name
diff --git a/v0.15/deployment/image-variants.html b/v0.15/deployment/image-variants.html
index ccce77f8e..b9f94dcfb 100644
--- a/v0.15/deployment/image-variants.html
+++ b/v0.15/deployment/image-variants.html
@@ -1 +1 @@
-        Image variants · Node Feature Discovery                      

Image variants


NFD offers two variants of the container image. Released container images are available for x86_64 and Arm64 architectures.

Default

The default is a minimal image based on scratch and only supports running statically linked binaries.

For backwards compatibility a container image tag with suffix -minimal (e.g. registry.k8s.io/nfd/node-feature-discovery:v0.15.6-minimal) is provided.

Full

This image is based on debian:bookworm-slim and contains a full Linux system for running shell-based nfd-worker hooks and doing live debugging and diagnosis of the NFD images.

The container image tag has suffix -full (e.g. registry.k8s.io/nfd/node-feature-discovery:v0.15.6-full).


Node Feature Discovery
v0.15
Versions
GitHub
Homepage
Issues
Download

This Software is under the terms of Apache License 2.0.
\ No newline at end of file + Image variants · Node Feature Discovery

Image variants


NFD offers two variants of the container image. Released container images are available for x86_64 and Arm64 architectures.

Default

The default is a minimal image based on scratch and only supports running statically linked binaries.

For backwards compatibility a container image tag with suffix -minimal (e.g. registry.k8s.io/nfd/node-feature-discovery:v0.15.6-minimal) is provided.

Full

This image is based on debian:bookworm-slim and contains a full Linux system for running shell-based nfd-worker hooks and doing live debugging and diagnosis of the NFD images.

The container image tag has suffix -full (e.g. registry.k8s.io/nfd/node-feature-discovery:v0.15.6-full).


Node Feature Discovery
v0.15
Versions
GitHub
Homepage
Issues
Download

This Software is under the terms of Apache License 2.0.
\ No newline at end of file diff --git a/v0.15/deployment/index.html b/v0.15/deployment/index.html index 54d22c8f5..2760bbc6c 100644 --- a/v0.15/deployment/index.html +++ b/v0.15/deployment/index.html @@ -1 +1 @@ - Deployment · Node Feature Discovery

Deployment

Node Feature Discovery can be deployed on any recent version of Kubernetes (v1.21+).

See Image variants for description of the different NFD container images available.

Using Kustomize provides straightforward deployment with kubectl integration and declarative customization.

Using Helm provides easy management of NFD deployments with nice configuration management and easy upgrades.

Using Operator provides deployment and configuration management via CRDs.


Node Feature Discovery
v0.15
Versions
GitHub
Homepage
Issues
Download

This Software is under the terms of Apache License 2.0.
\ No newline at end of file + Deployment · Node Feature Discovery

Deployment

Node Feature Discovery can be deployed on any recent version of Kubernetes (v1.21+).

See Image variants for description of the different NFD container images available.

Using Kustomize provides straightforward deployment with kubectl integration and declarative customization.

Using Helm provides easy management of NFD deployments with nice configuration management and easy upgrades.

Using Operator provides deployment and configuration management via CRDs.


Node Feature Discovery
v0.15
Versions
GitHub
Homepage
Issues
Download

This Software is under the terms of Apache License 2.0.
\ No newline at end of file diff --git a/v0.15/deployment/kustomize.html b/v0.15/deployment/kustomize.html index fe06c83d8..7182f7112 100644 --- a/v0.15/deployment/kustomize.html +++ b/v0.15/deployment/kustomize.html @@ -1,4 +1,4 @@ - Kustomize · Node Feature Discovery

Deployment with Kustomize

Table of contents

  1. Overlays
    1. Worker one-shot
    2. Master Worker Topologyupdater
    3. Topologyupdater
    4. Metrics
  2. Uninstallation

Kustomize can be used to deploy NFD. Customization of the deployment is done by maintaining declarative overlays on top of the base overlays in NFD.

To follow the deployment instructions here, kubectl v1.21 or later is required.

The kustomize overlays provided in the repo can be used directly:

kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref=v0.15.6
+        Kustomize · Node Feature Discovery                      

Deployment with Kustomize

Table of contents

  1. Overlays
    1. Worker one-shot
    2. Master Worker Topologyupdater
    3. Topologyupdater
    4. Metrics
  2. Uninstallation

Kustomize can be used to deploy NFD. Customization of the deployment is done by maintaining declarative overlays on top of the base overlays in NFD.

To follow the deployment instructions here, kubectl v1.21 or later is required.

The kustomize overlays provided in the repo can be used directly:

kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref=v0.15.6
 

This will required RBAC rules and deploy nfd-master (as a deployment) and nfd-worker (as daemonset) in the node-feature-discovery namespace.

NOTE: nfd-topology-updater is not deployed as part of the default overlay. Refer to the Master Worker Topologyupdater and Topologyupdater below.

Alternatively you can clone the repository and customize the deployment by creating your own overlays. See kustomize for more information about managing deployment configurations.

Overlays

The NFD repository hosts a set of overlays for different usages and deployment scenarios under deployment/overlays

Worker one-shot

Feature discovery can alternatively be configured as a one-shot job. The default-job overlay may be used to achieve this:

NUM_NODES=$(kubectl get no -o jsonpath='{.items[*].metadata.name}' | wc -w)
 kubectl kustomize https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default-job?ref=v0.15.6 | \
     sed s"/NUM_NODES/$NUM_NODES/" | \
diff --git a/v0.15/deployment/metrics.html b/v0.15/deployment/metrics.html
index 40c2c706b..7de7a1af0 100644
--- a/v0.15/deployment/metrics.html
+++ b/v0.15/deployment/metrics.html
@@ -1,2 +1,2 @@
-        Metrics · Node Feature Discovery                      

Metrics

Metrics are configured to be exposed using prometheus operator API's by default. If you want to expose metrics using the prometheus operator API's you need to install the prometheus operator in your cluster. By default NFD Master and Worker expose metrics on port 8081.

The exposed metrics are

Metric Type Description
nfd_master_build_info Gauge Version from which nfd-master was built
nfd_worker_build_info Gauge Version from which nfd-worker was built
nfd_gc_build_info Gauge Version from which nfd-gc was built
nfd_topology_updater_build_info Gauge Version from which nfd-topology-updater was built
nfd_node_update_requests_total Counter Number of node update requests received by the master over gRPC
nfd_node_updates_total Counter Number of nodes updated
nfd_node_update_failures_total Counter Number of nodes update failures
nfd_node_labels_rejected_total Counter Number of nodes labels rejected by nfd-master
nfd_node_extendedresources_rejected_total Counter Number of nodes extended resources rejected by nfd-master
nfd_node_taints_rejected_total Counter Number of nodes taints rejected by nfd-master
nfd_nodefeaturerule_processing_duration_seconds Histogram Time taken to process NodeFeatureRule objects
nfd_nodefeaturerule_processing_errors_total Counter Number or errors encountered while processing NodeFeatureRule objects
nfd_feature_discovery_duration_seconds Histogram Time taken to discover features on a node
nfd_topology_updater_scan_errors_total Counter Number of errors in scanning resource allocation of pods.
nfd_gc_objects_deleted_total Counter Number of NodeFeature and NodeResourceTopology objects garbage collected.
nfd_gc_object_delete_failures_total Counter Number of errors in deleting NodeFeature and NodeResourceTopology objects.

Kustomize

To deploy NFD with metrics enabled using kustomize, you can use the prometheus overlay.

Helm

By default metrics are enabled when deploying NFD via Helm. To enable Prometheus to scrape metrics from NFD, you need to pass the following values to Helm:

--set prometheus.enable=true
+        Metrics · Node Feature Discovery                      

Metrics

Metrics are configured to be exposed using prometheus operator API's by default. If you want to expose metrics using the prometheus operator API's you need to install the prometheus operator in your cluster. By default NFD Master and Worker expose metrics on port 8081.

The exposed metrics are

Metric Type Description
nfd_master_build_info Gauge Version from which nfd-master was built
nfd_worker_build_info Gauge Version from which nfd-worker was built
nfd_gc_build_info Gauge Version from which nfd-gc was built
nfd_topology_updater_build_info Gauge Version from which nfd-topology-updater was built
nfd_node_update_requests_total Counter Number of node update requests received by the master over gRPC
nfd_node_updates_total Counter Number of nodes updated
nfd_node_update_failures_total Counter Number of nodes update failures
nfd_node_labels_rejected_total Counter Number of nodes labels rejected by nfd-master
nfd_node_extendedresources_rejected_total Counter Number of nodes extended resources rejected by nfd-master
nfd_node_taints_rejected_total Counter Number of nodes taints rejected by nfd-master
nfd_nodefeaturerule_processing_duration_seconds Histogram Time taken to process NodeFeatureRule objects
nfd_nodefeaturerule_processing_errors_total Counter Number or errors encountered while processing NodeFeatureRule objects
nfd_feature_discovery_duration_seconds Histogram Time taken to discover features on a node
nfd_topology_updater_scan_errors_total Counter Number of errors in scanning resource allocation of pods.
nfd_gc_objects_deleted_total Counter Number of NodeFeature and NodeResourceTopology objects garbage collected.
nfd_gc_object_delete_failures_total Counter Number of errors in deleting NodeFeature and NodeResourceTopology objects.

Kustomize

To deploy NFD with metrics enabled using kustomize, you can use the prometheus overlay.

Helm

By default metrics are enabled when deploying NFD via Helm. To enable Prometheus to scrape metrics from NFD, you need to pass the following values to Helm:

--set prometheus.enable=true
 

For more info on Helm deployment, see Helm.

It is recommended to specify --set prometheus.prometheusSpec.podMonitorSelectorNilUsesHelmValues=false when deploying prometheus-operator via Helm to enable the prometheus-operator to scrape metrics from any PodMonitor.

or setting labels on the PodMonitor via the helm parameter prometheus.labels to control which Prometheus instances will scrape this PodMonitor.

Grafana dashboard

NFD contains an example Grafana dashboard. You can import examples/grafana-dashboard.json to your Grafana instance to visualize the NFD metrics.


Node Feature Discovery
v0.15
Versions
GitHub
Homepage
Issues
Download

This Software is under the terms of Apache License 2.0.
\ No newline at end of file diff --git a/v0.15/deployment/operator.html b/v0.15/deployment/operator.html index 37dde21e5..aff5d3834 100644 --- a/v0.15/deployment/operator.html +++ b/v0.15/deployment/operator.html @@ -1,4 +1,4 @@ - NFD Operator · Node Feature Discovery

Deployment with NFD Operator

Table of contents

  1. Deployment
  2. Uninstallation

The Node Feature Discovery Operator automates installation, configuration and updates of NFD using a specific NodeFeatureDiscovery custom resource. This also provides good support for managing NFD as a dependency of other operators.

Deployment

Deployment using the Node Feature Discovery Operator is recommended to be done via operatorhub.io.

  1. You need to have OLM installed. If you don't, take a look at the latest release for detailed instructions.
  2. Install the operator:

    kubectl create -f https://operatorhub.io/install/nfd-operator.yaml
    +        NFD Operator · Node Feature Discovery                      

    Deployment with NFD Operator

    Table of contents

    1. Deployment
    2. Uninstallation

    The Node Feature Discovery Operator automates installation, configuration and updates of NFD using a specific NodeFeatureDiscovery custom resource. This also provides good support for managing NFD as a dependency of other operators.

    Deployment

    Deployment using the Node Feature Discovery Operator is recommended to be done via operatorhub.io.

    1. You need to have OLM installed. If you don't, take a look at the latest release for detailed instructions.
    2. Install the operator:

      kubectl create -f https://operatorhub.io/install/nfd-operator.yaml
       
    3. Create NodeFeatureDiscovery object (in nfd namespace here):

      cat << EOF | kubectl apply -f -
       apiVersion: v1
       kind: Namespace
      diff --git a/v0.15/deployment/tls.html b/v0.15/deployment/tls.html
      index 89368b83b..609599fc8 100644
      --- a/v0.15/deployment/tls.html
      +++ b/v0.15/deployment/tls.html
      @@ -1,4 +1,4 @@
      -        TLS authentication · Node Feature Discovery                      

      Communication security with TLS

      Table of contents

      1. Automated TLS certificate management using cert-manager
      2. Manual TLS certificate management

      DEPRECATED: this section only applies when the gRPC API is used, i.e. when the NodeFeature API is disabled via the -enable-nodefeature-api=false flag on both nfd-master and nfd-worker. The gRPC API is deprecated and will be removed in a future release.

      NFD supports mutual TLS authentication between the nfd-master and nfd-worker instances. That is, nfd-worker and nfd-master both verify that the other end presents a valid certificate.

      TLS authentication is enabled by specifying -ca-file, -key-file and -cert-file args, on both the nfd-master and nfd-worker instances. The template specs provided with NFD contain (commented out) example configuration for enabling TLS authentication.

      The Common Name (CN) of the nfd-master certificate must match the DNS name of the nfd-master Service of the cluster. By default, nfd-master only check that the nfd-worker has been signed by the specified root certificate (-ca-file).

      Additional hardening can be enabled by specifying -verify-node-name in nfd-master args, in which case nfd-master verifies that the NodeName presented by nfd-worker matches the Common Name (CN) or a Subject Alternative Name (SAN) of its certificate. Note that -verify-node-name complicates certificate management and is not yet supported in the helm or kustomize deployment methods.

      Automated TLS certificate management using cert-manager

      cert-manager can be used to automate certificate management between nfd-master and the nfd-worker pods.

      The NFD source code repository contains an example kustomize overlay and helm chart that can be used to deploy NFD with cert-manager supplied certificates enabled.

      To install cert-manager itself, you can run:

      kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.13.2/cert-manager.yaml
      +        TLS authentication · Node Feature Discovery                      

      Communication security with TLS

      Table of contents

      1. Automated TLS certificate management using cert-manager
      2. Manual TLS certificate management

      DEPRECATED: this section only applies when the gRPC API is used, i.e. when the NodeFeature API is disabled via the -enable-nodefeature-api=false flag on both nfd-master and nfd-worker. The gRPC API is deprecated and will be removed in a future release.

      NFD supports mutual TLS authentication between the nfd-master and nfd-worker instances. That is, nfd-worker and nfd-master both verify that the other end presents a valid certificate.

      TLS authentication is enabled by specifying -ca-file, -key-file and -cert-file args, on both the nfd-master and nfd-worker instances. The template specs provided with NFD contain (commented out) example configuration for enabling TLS authentication.

      The Common Name (CN) of the nfd-master certificate must match the DNS name of the nfd-master Service of the cluster. By default, nfd-master only check that the nfd-worker has been signed by the specified root certificate (-ca-file).

      Additional hardening can be enabled by specifying -verify-node-name in nfd-master args, in which case nfd-master verifies that the NodeName presented by nfd-worker matches the Common Name (CN) or a Subject Alternative Name (SAN) of its certificate. Note that -verify-node-name complicates certificate management and is not yet supported in the helm or kustomize deployment methods.

      Automated TLS certificate management using cert-manager

      cert-manager can be used to automate certificate management between nfd-master and the nfd-worker pods.

      The NFD source code repository contains an example kustomize overlay and helm chart that can be used to deploy NFD with cert-manager supplied certificates enabled.

      To install cert-manager itself, you can run:

      kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.13.2/cert-manager.yaml
       

      Alternatively, you can refer to cert-manager documentation for other installation methods such as the Helm chart they provide.

      To use the kustomize overlay to install node-feature-discovery with TLS enabled, you may use the following:

      kubectl apply -k deployment/overlays/samples/cert-manager
       

      To make use of the helm chart, override values.yaml to enable both the tls.enabled and tls.certManager options. Note that if you do not enable tls.certManager, helm will successfully install the application, but deployment will wait until certificates are manually created, as demonstrated below.

      See the sample installation commands in the Helm Deployment and Configuration sections above for how to either override individual values, or provide a yaml file with which to override default values.

      Manual TLS certificate management

      If you do not with to make use of cert-manager, the certificates can be manually created and stored as secrets within the NFD namespace.

      Create a CA certificate

      openssl req -x509 -newkey rsa:4096 -keyout ca.key -nodes \
               -subj "/CN=nfd-ca" -days 10000 -out ca.crt
      diff --git a/v0.15/deployment/uninstallation.html b/v0.15/deployment/uninstallation.html
      index f4fec2775..2aceed12c 100644
      --- a/v0.15/deployment/uninstallation.html
      +++ b/v0.15/deployment/uninstallation.html
      @@ -1,4 +1,4 @@
      -        Uninstallation · Node Feature Discovery                      

      Uninstallation


      Follow the uninstallation instructions of the deployment method used (kustomize, helm or operator).

      Removing feature labels

      NFD-Master has a special -prune command line flag for removing all nfd-related node labels, annotations, extended resources and taints from the cluster.

      kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prune?ref=v0.15.6
      +        Uninstallation · Node Feature Discovery                      

      Uninstallation


      Follow the uninstallation instructions of the deployment method used (kustomize, helm or operator).

      Removing feature labels

      NFD-Master has a special -prune command line flag for removing all nfd-related node labels, annotations, extended resources and taints from the cluster.

      kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prune?ref=v0.15.6
       kubectl -n node-feature-discovery wait job.batch/nfd-master --for=condition=complete && \
           kubectl delete -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prune?ref=v0.15.6
       

      NOTE: You must run prune before removing the RBAC rules (serviceaccount, clusterrole and clusterrolebinding).


      Node Feature Discovery
      v0.15
      Versions
      GitHub
      Homepage
      Issues
      Download

      This Software is under the terms of Apache License 2.0.
      \ No newline at end of file diff --git a/v0.15/developer-guide/index.html b/v0.15/developer-guide/index.html index 5309177f8..e95e4bd2f 100644 --- a/v0.15/developer-guide/index.html +++ b/v0.15/developer-guide/index.html @@ -1,4 +1,4 @@ - Developer guide · Node Feature Discovery

      Developer guide

      Table of contents

      1. Building from source
        1. Download the source code
        2. Docker build
        3. Docker multi-arch builds with buildx
        4. Deployment
        5. Building locally
        6. Customizing the build
        7. Testing
      2. Running locally
        1. NFD-Master
        2. NFD-Worker
        3. NFD-Topology-Updater
      3. Running with Tilt
        1. Prerequisites
        2. Environment variables
      4. Documentation

      Building from source

      Download the source code

      git clone https://github.com/kubernetes-sigs/node-feature-discovery
      +        Developer guide · Node Feature Discovery                      

      Developer guide

      Table of contents

      1. Building from source
        1. Download the source code
        2. Docker build
        3. Docker multi-arch builds with buildx
        4. Deployment
        5. Building locally
        6. Customizing the build
        7. Testing
      2. Running locally
        1. NFD-Master
        2. NFD-Worker
        3. NFD-Topology-Updater
      3. Running with Tilt
        1. Prerequisites
        2. Environment variables
      4. Documentation

      Building from source

      Download the source code

      git clone https://github.com/kubernetes-sigs/node-feature-discovery
       cd node-feature-discovery
       

      Docker build

      Build the container image

      See customizing the build below for altering the container image registry, for example.

      make
       

      Push the container image

      Optional, this example with Docker.

      docker push <IMAGE_TAG>
      diff --git a/v0.15/get-started/index.html b/v0.15/get-started/index.html
      index c05df7b01..425221e34 100644
      --- a/v0.15/get-started/index.html
      +++ b/v0.15/get-started/index.html
      @@ -1,4 +1,4 @@
      -        Get started · Node Feature Discovery                      

      Node Feature Discovery

      Welcome to Node Feature Discovery – a Kubernetes add-on for detecting hardware features and system configuration!

      Continue to:

      • Introduction for more details on the project.

      • Quick start for quick step-by-step instructions on how to get NFD running on your cluster.

      Quick-start – the short-short version

      $ kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref=v0.15.6
      +        Get started · Node Feature Discovery                      

      Node Feature Discovery

      Welcome to Node Feature Discovery – a Kubernetes add-on for detecting hardware features and system configuration!

      Continue to:

      • Introduction for more details on the project.

      • Quick start for quick step-by-step instructions on how to get NFD running on your cluster.

      Quick-start – the short-short version

      $ kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref=v0.15.6
         namespace/node-feature-discovery created
         serviceaccount/nfd-master created
         clusterrole.rbac.authorization.k8s.io/nfd-master created
      diff --git a/v0.15/get-started/introduction.html b/v0.15/get-started/introduction.html
      index 97a38ffe1..6d9a5608c 100644
      --- a/v0.15/get-started/introduction.html
      +++ b/v0.15/get-started/introduction.html
      @@ -1,4 +1,4 @@
      -        Introduction · Node Feature Discovery                      

      Introduction

      Table of contents

      1. NFD-Master
      2. NFD-Worker
      3. NFD-Topology-Updater
      4. NFD-GC
      5. Feature Discovery
      6. Node annotations
      7. Custom resources

      This software enables node feature discovery for Kubernetes. It detects hardware features available on each node in a Kubernetes cluster, and advertises those features using node labels and optionally node extended resources, annotations and node taints. Node Feature Discovery is compatible with any recent version of Kubernetes (v1.21+).

      NFD consists of four software components:

      1. nfd-master
      2. nfd-worker
      3. nfd-topology-updater
      4. nfd-gc

      NFD-Master

      NFD-Master is the daemon responsible for communication towards the Kubernetes API. That is, it receives labeling requests from the worker and modifies node objects accordingly.

      NFD-Worker

      NFD-Worker is a daemon responsible for feature detection. It then communicates the information to nfd-master which does the actual node labeling. One instance of nfd-worker is supposed to be running on each node of the cluster,

      NFD-Topology-Updater

      NFD-Topology-Updater is a daemon responsible for examining allocated resources on a worker node to account for resources available to be allocated to new pod on a per-zone basis (where a zone can be a NUMA node). It then creates or updates a NodeResourceTopology custom resource object specific to this node. One instance of nfd-topology-updater is supposed to be running on each node of the cluster.

      NFD-GC

      NFD-GC is a daemon responsible for cleaning obsolete NodeFeature and NodeResourceTopology objects.

      One instance of nfd-gc is supposed to be running in the cluster.

      Feature Discovery

      Feature discovery is divided into domain-specific feature sources:

      • CPU
      • Kernel
      • Memory
      • Network
      • PCI
      • Storage
      • System
      • USB
      • Custom (rule-based custom features)
      • Local (hooks for user-specific features)

      Each feature source is responsible for detecting a set of features which. in turn, are turned into node feature labels. Feature labels are prefixed with feature.node.kubernetes.io/ and also contain the name of the feature source. Non-standard user-specific feature labels can be created with the local and custom feature sources.

      An overview of the default feature labels:

      {
      +        Introduction · Node Feature Discovery                      

      Introduction

      Table of contents

      1. NFD-Master
      2. NFD-Worker
      3. NFD-Topology-Updater
      4. NFD-GC
      5. Feature Discovery
      6. Node annotations
      7. Custom resources

      This software enables node feature discovery for Kubernetes. It detects hardware features available on each node in a Kubernetes cluster, and advertises those features using node labels and optionally node extended resources, annotations and node taints. Node Feature Discovery is compatible with any recent version of Kubernetes (v1.21+).

      NFD consists of four software components:

      1. nfd-master
      2. nfd-worker
      3. nfd-topology-updater
      4. nfd-gc

      NFD-Master

      NFD-Master is the daemon responsible for communication towards the Kubernetes API. That is, it receives labeling requests from the worker and modifies node objects accordingly.

      NFD-Worker

      NFD-Worker is a daemon responsible for feature detection. It then communicates the information to nfd-master which does the actual node labeling. One instance of nfd-worker is supposed to be running on each node of the cluster,

      NFD-Topology-Updater

      NFD-Topology-Updater is a daemon responsible for examining allocated resources on a worker node to account for resources available to be allocated to new pod on a per-zone basis (where a zone can be a NUMA node). It then creates or updates a NodeResourceTopology custom resource object specific to this node. One instance of nfd-topology-updater is supposed to be running on each node of the cluster.

      NFD-GC

      NFD-GC is a daemon responsible for cleaning obsolete NodeFeature and NodeResourceTopology objects.

      One instance of nfd-gc is supposed to be running in the cluster.

      Feature Discovery

      Feature discovery is divided into domain-specific feature sources:

      • CPU
      • Kernel
      • Memory
      • Network
      • PCI
      • Storage
      • System
      • USB
      • Custom (rule-based custom features)
      • Local (hooks for user-specific features)

      Each feature source is responsible for detecting a set of features which. in turn, are turned into node feature labels. Feature labels are prefixed with feature.node.kubernetes.io/ and also contain the name of the feature source. Non-standard user-specific feature labels can be created with the local and custom feature sources.

      An overview of the default feature labels:

      {
         "feature.node.kubernetes.io/cpu-<feature-name>": "true",
         "feature.node.kubernetes.io/custom-<feature-name>": "true",
         "feature.node.kubernetes.io/kernel-<feature name>": "<feature value>",
      diff --git a/v0.15/get-started/quick-start.html b/v0.15/get-started/quick-start.html
      index 3c9afb595..7c85f12c2 100644
      --- a/v0.15/get-started/quick-start.html
      +++ b/v0.15/get-started/quick-start.html
      @@ -1,4 +1,4 @@
      -        Quick start · Node Feature Discovery                      

      Quick start

      Minimal steps to deploy latest released version of NFD in your cluster.

      Installation

      Deploy with kustomize – creates a new namespace, service and required RBAC rules and deploys nfd-master and nfd-worker daemons.

      kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref=v0.15.6
      +        Quick start · Node Feature Discovery                      

      Quick start

      Minimal steps to deploy latest released version of NFD in your cluster.

      Installation

      Deploy with kustomize – creates a new namespace, service and required RBAC rules and deploys nfd-master and nfd-worker daemons.

      kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref=v0.15.6
       

      Verify

      Wait until NFD master and NFD worker are running.

      $ kubectl -n node-feature-discovery get ds,deploy
       NAME                         DESIRED   CURRENT   READY   UP-TO-DATE   AVAILABLE   NODE SELECTOR   AGE
       daemonset.apps/nfd-worker    2         2         2       2            2           <none>          10s
      diff --git a/v0.15/reference/gc-commandline-reference.html b/v0.15/reference/gc-commandline-reference.html
      index 8af240c26..bb1d5a6d5 100644
      --- a/v0.15/reference/gc-commandline-reference.html
      +++ b/v0.15/reference/gc-commandline-reference.html
      @@ -1,4 +1,4 @@
      -        Garbage Collector Cmdline Reference · Node Feature Discovery                      

      NFD-GC Commandline Flags

      Table of Contents

      1. -h, -help
      2. -version
      3. -gc-interval

      To quickly view available command line flags execute nfd-gc -help. In a docker container:

      docker run registry.k8s.io/nfd/node-feature-discovery:v0.15.6 \
      +        Garbage Collector Cmdline Reference · Node Feature Discovery                      

      NFD-GC Commandline Flags

      Table of Contents

      1. -h, -help
      2. -version
      3. -gc-interval

      To quickly view available command line flags execute nfd-gc -help. In a docker container:

      docker run registry.k8s.io/nfd/node-feature-discovery:v0.15.6 \
       nfd-gc -help
       

      -h, -help

      Print usage and exit.

      -version

      Print version and exit.

      -gc-interval

      The -gc-interval specifies the interval between periodic garbage collector runs.

      Default: 1h

      Example:

      nfd-gc -gc-interval=1h
       

      Node Feature Discovery
      v0.15
      Versions
      GitHub
      Homepage
      Issues
      Download

      This Software is under the terms of Apache License 2.0.
      \ No newline at end of file diff --git a/v0.15/reference/index.html b/v0.15/reference/index.html index 05f77384d..12f4f1ae5 100644 --- a/v0.15/reference/index.html +++ b/v0.15/reference/index.html @@ -1 +1 @@ - Reference · Node Feature Discovery

      Reference

      Command line and configuration reference.


      Node Feature Discovery
      v0.15
      Versions
      GitHub
      Homepage
      Issues
      Download

      This Software is under the terms of Apache License 2.0.
      \ No newline at end of file + Reference · Node Feature Discovery

      Reference

      Command line and configuration reference.


      Node Feature Discovery
      v0.15
      Versions
      GitHub
      Homepage
      Issues
      Download

      This Software is under the terms of Apache License 2.0.
      \ No newline at end of file diff --git a/v0.15/reference/master-commandline-reference.html b/v0.15/reference/master-commandline-reference.html index e7557e08b..a980c9e04 100644 --- a/v0.15/reference/master-commandline-reference.html +++ b/v0.15/reference/master-commandline-reference.html @@ -1,4 +1,4 @@ - Master cmdline reference · Node Feature Discovery

      Commandline flags of nfd-master

      Table of contents

      1. -h, -help
      2. -version
      3. -prune
      4. -port
      5. -metrics
      6. -instance
      7. -ca-file
      8. -cert-file
      9. -key-file
      10. -verify-node-name
      11. -enable-nodefeature-api
      12. -enable-leader-election
      13. -enable-taints
      14. -no-publish
      15. -crd-controller
      16. -featurerules-controller
      17. -label-whitelist
      18. -extra-label-ns
      19. -deny-label-ns
      20. -resource-labels
      21. -config
      22. -options
      23. -nfd-api-parallelism
      24. Logging
      25. -resync-period

      To quickly view available command line flags execute nfd-master -help. In a docker container:

      docker run registry.k8s.io/nfd/node-feature-discovery:v0.15.6 nfd-master -help
      +        Master cmdline reference · Node Feature Discovery                      

      Commandline flags of nfd-master

      Table of contents

      1. -h, -help
      2. -version
      3. -prune
      4. -port
      5. -metrics
      6. -instance
      7. -ca-file
      8. -cert-file
      9. -key-file
      10. -verify-node-name
      11. -enable-nodefeature-api
      12. -enable-leader-election
      13. -enable-taints
      14. -no-publish
      15. -crd-controller
      16. -featurerules-controller
      17. -label-whitelist
      18. -extra-label-ns
      19. -deny-label-ns
      20. -resource-labels
      21. -config
      22. -options
      23. -nfd-api-parallelism
      24. Logging
      25. -resync-period

      To quickly view available command line flags execute nfd-master -help. In a docker container:

      docker run registry.k8s.io/nfd/node-feature-discovery:v0.15.6 nfd-master -help
       

      -h, -help

      Print usage and exit.

      -version

      Print version and exit.

      -prune

      The -prune flag is a sub-command like option for cleaning up the cluster. It causes nfd-master to remove all NFD related labels, annotations and extended resources from all Node objects of the cluster and exit.

      -port

      The -port flag specifies the TCP port that nfd-master listens for incoming requests.

      Default: 8080

      Example:

      nfd-master -port=443
       

      -metrics

      The -metrics flag specifies the port on which to expose Prometheus metrics. Setting this to 0 disables the metrics server on nfd-master.

      Default: 8081

      Example:

      nfd-master -metrics=12345
       

      -instance

      The -instance flag makes it possible to run multiple NFD deployments in parallel. In practice, it separates the node annotations between deployments so that each of them can store metadata independently. The instance name must start and end with an alphanumeric character and may only contain alphanumeric characters, -, _ or ..

      Default: empty

      Example:

      nfd-master -instance=network
      diff --git a/v0.15/reference/master-configuration-reference.html b/v0.15/reference/master-configuration-reference.html
      index ec4d50b04..380c8508e 100644
      --- a/v0.15/reference/master-configuration-reference.html
      +++ b/v0.15/reference/master-configuration-reference.html
      @@ -1,4 +1,4 @@
      -        Master config reference · Node Feature Discovery                      

      Configuration file reference of nfd-master

      Table of contents

      1. noPublish
      2. extraLabelNs
      3. denyLabelNs
      4. autoDefaultNs
      5. resourceLabels
      6. enableTaints
      7. labelWhiteList
      8. resyncPeriod
      9. leaderElection
        1. leaderElection.leaseDuration
        2. leaderElection.renewDeadline
        3. leaderElection.retryPeriod
      10. nfdApiParallelism
      11. klog
        1. klog.addDirHeader
        2. klog.alsologtostderr
        3. klog.logBacktraceAt
        4. klog.logDir
        5. klog.logFile
        6. klog.logFileMaxSize
        7. klog.logtostderr
        8. klog.skipHeaders
        9. klog.skipLogHeaders
        10. klog.stderrthreshold
        11. klog.v
        12. klog.vmodule

      See the sample configuration file for a full example configuration.

      noPublish

      noPublish option disables updates to the Node objects in the Kubernetes API server, making a "dry-run" flag for nfd-master. No Labels, Annotations, Taints or ExtendedResources of nodes are updated.

      Default: false

      Example:

      noPublish: true
      +        Master config reference · Node Feature Discovery                      

      Configuration file reference of nfd-master

      Table of contents

      1. noPublish
      2. extraLabelNs
      3. denyLabelNs
      4. autoDefaultNs
      5. resourceLabels
      6. enableTaints
      7. labelWhiteList
      8. resyncPeriod
      9. leaderElection
        1. leaderElection.leaseDuration
        2. leaderElection.renewDeadline
        3. leaderElection.retryPeriod
      10. nfdApiParallelism
      11. klog
        1. klog.addDirHeader
        2. klog.alsologtostderr
        3. klog.logBacktraceAt
        4. klog.logDir
        5. klog.logFile
        6. klog.logFileMaxSize
        7. klog.logtostderr
        8. klog.skipHeaders
        9. klog.skipLogHeaders
        10. klog.stderrthreshold
        11. klog.v
        12. klog.vmodule

      See the sample configuration file for a full example configuration.

      noPublish

      noPublish option disables updates to the Node objects in the Kubernetes API server, making a "dry-run" flag for nfd-master. No Labels, Annotations, Taints or ExtendedResources of nodes are updated.

      Default: false

      Example:

      noPublish: true
       

      extraLabelNs

      extraLabelNs specifies a list of allowed feature label namespaces. This option can be used to allow other vendor or application specific namespaces for custom labels from the local and custom feature sources, even though these labels were denied using the denyLabelNs parameter.

      The same namespace control and this option applies to Extended Resources (created with resourceLabels), too.

      Default: empty

      Example:

      extraLabelNs: ["added.ns.io","added.kubernets.io"]
       

      denyLabelNs

      denyLabelNs specifies a list of excluded label namespaces. By default, nfd-master allows creating labels in all namespaces, excluding kubernetes.io namespace and its sub-namespaces (i.e. *.kubernetes.io). However, you should note that kubernetes.io and its sub-namespaces are always denied. This option can be used to exclude some vendors or application specific namespaces.

      Default: empty

      Example:

      denyLabelNs: ["denied.ns.io","denied.kubernetes.io"]
       

      autoDefaultNs

      The autoDefaultNs option controls the automatic prefixing of names. When set to true (the default in NFD version v0.15) nfd-master automatically adds the default feature.node.kubernetes.io/ prefix to unprefixed labels, annotations and extended resources - this is also the default behavior in NFD v0.15 and earlier. When the option is set to false, no prefix will be prepended to unprefixed names, effectively causing them to be filtered out (as NFD does not allow unprefixed names of labels, annotations or extended resources). The default will be changed to false in a future release.

      For example, with the autoDefaultNs set to true, a NodeFeatureRule with

        labels:
      diff --git a/v0.15/reference/plugin-commandline-reference.html b/v0.15/reference/plugin-commandline-reference.html
      index b80c0da2c..8781ed2cb 100644
      --- a/v0.15/reference/plugin-commandline-reference.html
      +++ b/v0.15/reference/plugin-commandline-reference.html
      @@ -1 +1 @@
      -        Kubectl plugin cmdline reference · Node Feature Discovery                      

      Commandline flags of kubectl-nfd (plugin)

      Table of contents

      1. -h, -help
      2. Validate
        1. -f / –nodefeature-file
      3. Test
        1. -k, –kubeconfig
        2. -s, –namespace
        3. -n, –nodename
        4. -f, –nodefeaturerule-file
      4. DryRun
        1. -f, –nodefeaturerule-file
        2. -n, –nodefeature-file

      To quickly view available command line flags execute kubectl nfd -help.

      -h, -help

      Print usage and exit.

      Validate

      Validate a NodeFeatureRule file.

      -f / –nodefeature-file

      The --nodefeature-file flag specifies the path to the NodeFeatureRule file to validate.

      Test

      Test a NodeFeatureRule file against a node without applying it.

      -k, –kubeconfig

      The --kubeconfig flag specifies the path to the kubeconfig file to use for CLI requests.

      -s, –namespace

      The --namespace flag specifies the namespace to use for CLI requests. Default: default.

      -n, –nodename

      The --nodename flag specifies the name of the node to test the NodeFeatureRule against.

      -f, –nodefeaturerule-file

      The --nodefeaturerule-file flag specifies the path to the NodeFeatureRule file to test.

      DryRun

      Process a NodeFeatureRule file against a NodeFeature file.

      -f, –nodefeaturerule-file

      The --nodefeaturerule-file flag specifies the path to the NodeFeatureRule file to test.

      -n, –nodefeature-file

      The --nodefeature-file flag specifies the path to the NodeFeature file to test.


      Node Feature Discovery
      v0.15
      Versions
      GitHub
      Homepage
      Issues
      Download

      This Software is under the terms of Apache License 2.0.
      \ No newline at end of file + Kubectl plugin cmdline reference · Node Feature Discovery

      Commandline flags of kubectl-nfd (plugin)

      Table of contents

      1. -h, -help
      2. Validate
        1. -f / –nodefeature-file
      3. Test
        1. -k, –kubeconfig
        2. -s, –namespace
        3. -n, –nodename
        4. -f, –nodefeaturerule-file
      4. DryRun
        1. -f, –nodefeaturerule-file
        2. -n, –nodefeature-file

      To quickly view available command line flags execute kubectl nfd -help.

      -h, -help

      Print usage and exit.

      Validate

      Validate a NodeFeatureRule file.

      -f / –nodefeature-file

      The --nodefeature-file flag specifies the path to the NodeFeatureRule file to validate.

      Test

      Test a NodeFeatureRule file against a node without applying it.

      -k, –kubeconfig

      The --kubeconfig flag specifies the path to the kubeconfig file to use for CLI requests.

      -s, –namespace

      The --namespace flag specifies the namespace to use for CLI requests. Default: default.

      -n, –nodename

      The --nodename flag specifies the name of the node to test the NodeFeatureRule against.

      -f, –nodefeaturerule-file

      The --nodefeaturerule-file flag specifies the path to the NodeFeatureRule file to test.

      DryRun

      Process a NodeFeatureRule file against a NodeFeature file.

      -f, –nodefeaturerule-file

      The --nodefeaturerule-file flag specifies the path to the NodeFeatureRule file to test.

      -n, –nodefeature-file

      The --nodefeature-file flag specifies the path to the NodeFeature file to test.


      Node Feature Discovery
      v0.15
      Versions
      GitHub
      Homepage
      Issues
      Download

      This Software is under the terms of Apache License 2.0.
      \ No newline at end of file diff --git a/v0.15/reference/topology-updater-commandline-reference.html b/v0.15/reference/topology-updater-commandline-reference.html index 41c95f4d8..58d3d3d9b 100644 --- a/v0.15/reference/topology-updater-commandline-reference.html +++ b/v0.15/reference/topology-updater-commandline-reference.html @@ -1,4 +1,4 @@ - Topology Updater Cmdline Reference · Node Feature Discovery

      NFD-Topology-Updater Commandline Flags

      Table of Contents

      1. -h, -help
      2. -version
      3. -config
      4. -no-publish
      5. -oneshot
      6. -metrics
      7. -sleep-interval
      8. -watch-namespace
      9. -kubelet-config-uri
      10. -api-auth-token-file
      11. -podresources-socket
      12. -pods-fingerprint
      13. -kubelet-state-dir

      To quickly view available command line flags execute nfd-topology-updater -help. In a docker container:

      docker run registry.k8s.io/nfd/node-feature-discovery:v0.15.6 \
      +        Topology Updater Cmdline Reference · Node Feature Discovery                      

      NFD-Topology-Updater Commandline Flags

      Table of Contents

      1. -h, -help
      2. -version
      3. -config
      4. -no-publish
      5. -oneshot
      6. -metrics
      7. -sleep-interval
      8. -watch-namespace
      9. -kubelet-config-uri
      10. -api-auth-token-file
      11. -podresources-socket
      12. -pods-fingerprint
      13. -kubelet-state-dir

      To quickly view available command line flags execute nfd-topology-updater -help. In a docker container:

      docker run registry.k8s.io/nfd/node-feature-discovery:v0.15.6 \
       nfd-topology-updater -help
       

      -h, -help

      Print usage and exit.

      -version

      Print version and exit.

      -config

      The -config flag specifies the path of the nfd-topology-updater configuration file to use.

      Default: /etc/kubernetes/node-feature-discovery/nfd-topology-updater.conf

      Example:

      nfd-topology-updater -config=/opt/nfd/nfd-topology-updater.conf
       

      -no-publish

      The -no-publish flag disables all communication with the nfd-master, making it a "dry-run" flag for nfd-topology-updater. NFD-Topology-Updater runs resource hardware topology detection normally, but no CR requests are sent to nfd-master.

      Default: false

      Example:

      nfd-topology-updater -no-publish
      diff --git a/v0.15/reference/topology-updater-configuration-reference.html b/v0.15/reference/topology-updater-configuration-reference.html
      index baebea2f5..23d4e7a8f 100644
      --- a/v0.15/reference/topology-updater-configuration-reference.html
      +++ b/v0.15/reference/topology-updater-configuration-reference.html
      @@ -1,4 +1,4 @@
      -        Topology-Updater config reference · Node Feature Discovery                      

      Configuration file reference of nfd-topology-updater

      Table of contents

      1. excludeList
        1. excludeList.*

      See the sample configuration file for a full example configuration.

      excludeList

      The excludeList specifies a key-value map of allocated resources that should not be examined by the topology-updater agent per node. Each key is a node name with a value as a list of resources that should not be examined by the agent for that specific node.

      Default: empty

      Example:

      excludeList:
      +        Topology-Updater config reference · Node Feature Discovery                      

      Configuration file reference of nfd-topology-updater

      Table of contents

      1. excludeList
        1. excludeList.*

      See the sample configuration file for a full example configuration.

      excludeList

      The excludeList specifies a key-value map of allocated resources that should not be examined by the topology-updater agent per node. Each key is a node name with a value as a list of resources that should not be examined by the agent for that specific node.

      Default: empty

      Example:

      excludeList:
         nodeA: [hugepages-2Mi]
         nodeB: [memory]
         nodeC: [cpu, hugepages-2Mi]
      diff --git a/v0.15/reference/versions.html b/v0.15/reference/versions.html
      index a680c310a..39df48ad4 100644
      --- a/v0.15/reference/versions.html
      +++ b/v0.15/reference/versions.html
      @@ -1 +1 @@
      -        Versions · Node Feature Discovery                      

      Versions and deprecation


      Supported versions

      Node Feature Discovery follows semantic versioning where the version number consists of three components, i.e. MAJOR.MINOR.PATCH.

      The most recent two minor releases (or release branches) of Node Feature Discovery are supported. That is, with X being the latest release, X and X-1 are supported and X-1 reaches end-of-life when X+1 is released.

      Deprecation policy

      Feature labels

      Built-in feature labels and features are supported for 2 releases after being deprecated, at minimum. That is, if a feature label is deprecated in version X, it will be supported in X+1 and X+2 and may be dropped in X+3.

      Configuration options

      Command-line flags and configuration file options are supported for 1 more release after being deprecated, at minimum. That is, if option/flag is deprecated in version X, it will be supported in X+1 and may be removed in X+2.

      The same policy (support for 1 release after deprecation) also applies to Helm chart parameters.


      Node Feature Discovery
      v0.15
      Versions
      GitHub
      Homepage
      Issues
      Download

      This Software is under the terms of Apache License 2.0.
      \ No newline at end of file + Versions · Node Feature Discovery

      Versions and deprecation


      Supported versions

      Node Feature Discovery follows semantic versioning where the version number consists of three components, i.e. MAJOR.MINOR.PATCH.

      The most recent two minor releases (or release branches) of Node Feature Discovery are supported. That is, with X being the latest release, X and X-1 are supported and X-1 reaches end-of-life when X+1 is released.

      Deprecation policy

      Feature labels

      Built-in feature labels and features are supported for 2 releases after being deprecated, at minimum. That is, if a feature label is deprecated in version X, it will be supported in X+1 and X+2 and may be dropped in X+3.

      Configuration options

      Command-line flags and configuration file options are supported for 1 more release after being deprecated, at minimum. That is, if option/flag is deprecated in version X, it will be supported in X+1 and may be removed in X+2.

      The same policy (support for 1 release after deprecation) also applies to Helm chart parameters.


      Node Feature Discovery
      v0.15
      Versions
      GitHub
      Homepage
      Issues
      Download

      This Software is under the terms of Apache License 2.0.
      \ No newline at end of file diff --git a/v0.15/reference/worker-commandline-reference.html b/v0.15/reference/worker-commandline-reference.html index f46449d59..f7aa491ee 100644 --- a/v0.15/reference/worker-commandline-reference.html +++ b/v0.15/reference/worker-commandline-reference.html @@ -1,4 +1,4 @@ - Worker cmdline reference · Node Feature Discovery

      Commandline flags of nfd-worker

      Table of contents

      1. -h, -help
      2. -version
      3. -config
      4. -options
      5. -server
      6. -ca-file
      7. -cert-file
      8. -key-file
      9. -kubeconfig
      10. -server-name-override
      11. -feature-sources
      12. -label-sources
      13. -enable-nodefeature-api
      14. -metrics
      15. -no-publish
      16. -oneshot
      17. Logging

      To quickly view available command line flags execute nfd-worker -help. In a docker container:

      docker run registry.k8s.io/nfd/node-feature-discovery:v0.15.6 nfd-worker -help
      +        Worker cmdline reference · Node Feature Discovery                      

      Commandline flags of nfd-worker

      Table of contents

      1. -h, -help
      2. -version
      3. -config
      4. -options
      5. -server
      6. -ca-file
      7. -cert-file
      8. -key-file
      9. -kubeconfig
      10. -server-name-override
      11. -feature-sources
      12. -label-sources
      13. -enable-nodefeature-api
      14. -metrics
      15. -no-publish
      16. -oneshot
      17. Logging

      To quickly view available command line flags execute nfd-worker -help. In a docker container:

      docker run registry.k8s.io/nfd/node-feature-discovery:v0.15.6 nfd-worker -help
       

      -h, -help

      Print usage and exit.

      -version

      Print version and exit.

      -config

      The -config flag specifies the path of the nfd-worker configuration file to use.

      Default: /etc/kubernetes/node-feature-discovery/nfd-worker.conf

      Example:

      nfd-worker -config=/opt/nfd/worker.conf
       

      -options

      The -options flag may be used to specify and override configuration file options directly from the command line. The required format is the same as in the config file i.e. JSON or YAML. Configuration options specified via this flag will override those from the configuration file:

      Default: empty

      Example:

      nfd-worker -options='{"sources":{"cpu":{"cpuid":{"attributeWhitelist":["AVX","AVX2"]}}}}'
       

      -server

      NOTE the gRPC API is deprecated and will be removed in a future release. and this flag will be removed as well.

      The -server flag specifies the address of the nfd-master endpoint where to connect to.

      Default: localhost:8080

      Example:

      nfd-worker -server=nfd-master.nfd.svc.cluster.local:443
      diff --git a/v0.15/reference/worker-configuration-reference.html b/v0.15/reference/worker-configuration-reference.html
      index b72cfa329..95b4211c2 100644
      --- a/v0.15/reference/worker-configuration-reference.html
      +++ b/v0.15/reference/worker-configuration-reference.html
      @@ -1,4 +1,4 @@
      -        Worker config reference · Node Feature Discovery                      

      Configuration file reference of nfd-worker

      Table of contents

      1. core
        1. core.sleepInterval
        2. core.featureSources
        3. core.labelSources
        4. core.sources
        5. core.labelWhiteList
        6. core.noPublish
        7. core.klog
      2. sources
        1. sources.cpu
        2. sources.kernel
        3. sources.local
        4. sources.local.hooksEnabled
        5. sources.pci
        6. sources.usb
        7. sources.custom

      See the sample configuration file for a full example configuration.

      core

      The core section contains common configuration settings that are not specific to any particular feature source.

      core.sleepInterval

      core.sleepInterval specifies the interval between consecutive passes of feature (re-)detection, and thus also the interval between node re-labeling. A non-positive value implies infinite sleep interval, i.e. no re-detection or re-labeling is done.

      Default: 60s

      Example:

      core:
      +        Worker config reference · Node Feature Discovery                      

      Configuration file reference of nfd-worker

      Table of contents

      1. core
        1. core.sleepInterval
        2. core.featureSources
        3. core.labelSources
        4. core.sources
        5. core.labelWhiteList
        6. core.noPublish
        7. core.klog
      2. sources
        1. sources.cpu
        2. sources.kernel
        3. sources.local
        4. sources.local.hooksEnabled
        5. sources.pci
        6. sources.usb
        7. sources.custom

      See the sample configuration file for a full example configuration.

      core

      The core section contains common configuration settings that are not specific to any particular feature source.

      core.sleepInterval

      core.sleepInterval specifies the interval between consecutive passes of feature (re-)detection, and thus also the interval between node re-labeling. A non-positive value implies infinite sleep interval, i.e. no re-detection or re-labeling is done.

      Default: 60s

      Example:

      core:
         sleepInterval: 60s
       

      core.featureSources

      core.featureSources specifies the list of enabled feature sources. A special value all enables all sources. Prefixing a source name with - indicates that the source will be disabled instead - this is only meaningful when used in conjunction with all. This option allows completely disabling the feature detection so that neither standard feature labels are generated nor the raw feature data is available for custom rule processing.

      Default: [all]

      Example:

      core:
         # Enable all but cpu and local sources
      diff --git a/v0.15/search.html b/v0.15/search.html
      index bacb223dd..fd41caa42 100644
      --- a/v0.15/search.html
      +++ b/v0.15/search.html
      @@ -1 +1 @@
      -        Search · Node Feature Discovery                      

      Searching


        Node Feature Discovery
        v0.15
        Versions
        GitHub
        Homepage
        Issues
        Download

        This Software is under the terms of Apache License 2.0.
        \ No newline at end of file + Search · Node Feature Discovery

        Searching


          Node Feature Discovery
          v0.15
          Versions
          GitHub
          Homepage
          Issues
          Download

          This Software is under the terms of Apache License 2.0.
          \ No newline at end of file diff --git a/v0.15/sitemap.xml b/v0.15/sitemap.xml index 4a1a29d3a..26d12f8f1 100644 --- a/v0.15/sitemap.xml +++ b/v0.15/sitemap.xml @@ -1 +1 @@ - https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/deployment/image-variants.html 0.6 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/get-started/ 1.0 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/get-started/introduction.html 1.0 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/reference/master-commandline-reference.html 1.0 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/usage/features.html 1.0 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/deployment/ 0.5 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/deployment/kustomize.html 1.0 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/get-started/quick-start.html 1.0 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/reference/worker-commandline-reference.html 1.0 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/usage/using-labels.html 0.8 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/deployment/helm.html 1.0 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/reference/master-configuration-reference.html 1.0 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/usage/ 0.1 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/usage/nfd-master.html 1.0 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/deployment/operator.html 1.0 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/reference/ 0.1 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/reference/worker-configuration-reference.html 1.0 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/usage/nfd-worker.html 1.0 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/deployment/tls.html 1.0 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/developer-guide/ 1.0 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/reference/topology-updater-commandline-reference.html 1.0 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/usage/nfd-topology-updater.html 1.0 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/contributing/ 0.5 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/deployment/uninstallation.html 0.8 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/reference/topology-updater-configuration-reference.html 1.0 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/usage/nfd-gc.html 0.7 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/deployment/metrics.html 1.0 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/reference/gc-commandline-reference.html 0.7 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/usage/custom-resources.html 1.0 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/reference/plugin-commandline-reference.html 1.0 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/usage/customization-guide.html 1.0 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/reference/versions.html 0.8 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/usage/examples-and-demos.html 0.5 2024-07-10T09:45:34+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/usage/kubectl-plugin.html 1.0 2024-07-10T09:45:34+00:00 \ No newline at end of file + https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/deployment/image-variants.html 0.6 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/get-started/ 1.0 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/get-started/introduction.html 1.0 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/reference/master-commandline-reference.html 1.0 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/usage/features.html 1.0 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/deployment/ 0.5 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/deployment/kustomize.html 1.0 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/get-started/quick-start.html 1.0 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/reference/worker-commandline-reference.html 1.0 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/usage/using-labels.html 0.8 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/deployment/helm.html 1.0 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/reference/master-configuration-reference.html 1.0 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/usage/ 0.1 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/usage/nfd-master.html 1.0 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/deployment/operator.html 1.0 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/reference/ 0.1 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/reference/worker-configuration-reference.html 1.0 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/usage/nfd-worker.html 1.0 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/deployment/tls.html 1.0 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/developer-guide/ 1.0 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/reference/topology-updater-commandline-reference.html 1.0 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/usage/nfd-topology-updater.html 1.0 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/contributing/ 0.5 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/deployment/uninstallation.html 0.8 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/reference/topology-updater-configuration-reference.html 1.0 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/usage/nfd-gc.html 0.7 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/deployment/metrics.html 1.0 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/reference/gc-commandline-reference.html 0.7 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/usage/custom-resources.html 1.0 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/reference/plugin-commandline-reference.html 1.0 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/usage/customization-guide.html 1.0 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/reference/versions.html 0.8 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/usage/examples-and-demos.html 0.5 2024-07-10T10:40:01+00:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.15/usage/kubectl-plugin.html 1.0 2024-07-10T10:40:01+00:00 \ No newline at end of file diff --git a/v0.15/usage/custom-resources.html b/v0.15/usage/custom-resources.html index 68ec11c23..6dfac5ab3 100644 --- a/v0.15/usage/custom-resources.html +++ b/v0.15/usage/custom-resources.html @@ -1,4 +1,4 @@ - CRDs · Node Feature Discovery

          Custom Resources

          Table of contents

          1. NodeFeature
          2. NodeFeatureRule
          3. NodeResourceTopology

          NFD uses some Kubernetes custom resources.

          NodeFeature

          NodeFeature is an NFD-specific custom resource for communicating node features and node labeling requests. The nfd-master pod watches for NodeFeature objects, labels nodes as specified and uses the listed features as input when evaluating NodeFeatureRules. NodeFeature objects can be used for implementing 3rd party extensions (see customization guide for more details).

          apiVersion: nfd.k8s-sigs.io/v1alpha1
          +        CRDs · Node Feature Discovery                      

          Custom Resources

          Table of contents

          1. NodeFeature
          2. NodeFeatureRule
          3. NodeResourceTopology

          NFD uses some Kubernetes custom resources.

          NodeFeature

          NodeFeature is an NFD-specific custom resource for communicating node features and node labeling requests. The nfd-master pod watches for NodeFeature objects, labels nodes as specified and uses the listed features as input when evaluating NodeFeatureRules. NodeFeature objects can be used for implementing 3rd party extensions (see customization guide for more details).

          apiVersion: nfd.k8s-sigs.io/v1alpha1
           kind: NodeFeature
           metadata:
             labels:
          diff --git a/v0.15/usage/customization-guide.html b/v0.15/usage/customization-guide.html
          index d184c06ec..bf4e9377b 100644
          --- a/v0.15/usage/customization-guide.html
          +++ b/v0.15/usage/customization-guide.html
          @@ -1,4 +1,4 @@
          -        Customization guide · Node Feature Discovery                      

          Customization guide

          Table of contents

          1. Overview
          2. NodeFeature custom resource
            1. A NodeFeature example
            2. Feature types
          3. NodeFeatureRule custom resource
            1. A NodeFeatureRule example
            2. Node tainting
          4. Local feature source
            1. An example
            2. Feature files
            3. Hooks
            4. Input format
            5. Mounts
          5. Custom feature source
            1. An example custom feature source configuration
            2. Additional configuration directory
          6. Node labels
          7. Feature rule format
            1. Fields
            2. Available features
            3. Templating
            4. Backreferences
            5. Examples

          Overview

          NFD provides multiple extension points for vendor and application specific labeling:

          • NodeFeature objects can be used to communicate "raw" node features and node labeling requests to nfd-master.
          • NodeFeatureRule objects provide a way to deploy custom labeling rules via the Kubernetes API.
          • local feature source of nfd-worker creates labels by reading text files and executing hooks.
          • custom feature source of nfd-worker creates labels based on user-specified rules.

          NodeFeature custom resource

          NodeFeature objects provide a way for 3rd party extensions to advertise custom features, both as "raw" features that serve as input to NodeFeatureRule objects and as feature labels directly.

          Note that RBAC rules must be created for each extension for them to be able to create and manipulate NodeFeature objects in their namespace.

          The NodeFeature CRD API can be disabled with the -enable-nodefeature-api=false command line flag. This flag must be specified for both nfd-master and nfd-worker as it will enable the gRPC communication between them. Note that the gRPC API is DEPRECATED and will be removed in a future release, at which point the NodeFeature API cannot be disabled.

          A NodeFeature example

          Consider the following referential example:

          apiVersion: nfd.k8s-sigs.io/v1alpha1
          +        Customization guide · Node Feature Discovery                      

          Customization guide

          Table of contents

          1. Overview
          2. NodeFeature custom resource
            1. A NodeFeature example
            2. Feature types
          3. NodeFeatureRule custom resource
            1. A NodeFeatureRule example
            2. Node tainting
          4. Local feature source
            1. An example
            2. Feature files
            3. Hooks
            4. Input format
            5. Mounts
          5. Custom feature source
            1. An example custom feature source configuration
            2. Additional configuration directory
          6. Node labels
          7. Feature rule format
            1. Fields
            2. Available features
            3. Templating
            4. Backreferences
            5. Examples

          Overview

          NFD provides multiple extension points for vendor and application specific labeling:

          • NodeFeature objects can be used to communicate "raw" node features and node labeling requests to nfd-master.
          • NodeFeatureRule objects provide a way to deploy custom labeling rules via the Kubernetes API.
          • local feature source of nfd-worker creates labels by reading text files and executing hooks.
          • custom feature source of nfd-worker creates labels based on user-specified rules.

          NodeFeature custom resource

          NodeFeature objects provide a way for 3rd party extensions to advertise custom features, both as "raw" features that serve as input to NodeFeatureRule objects and as feature labels directly.

          Note that RBAC rules must be created for each extension for them to be able to create and manipulate NodeFeature objects in their namespace.

          The NodeFeature CRD API can be disabled with the -enable-nodefeature-api=false command line flag. This flag must be specified for both nfd-master and nfd-worker as it will enable the gRPC communication between them. Note that the gRPC API is DEPRECATED and will be removed in a future release, at which point the NodeFeature API cannot be disabled.

          A NodeFeature example

          Consider the following referential example:

          apiVersion: nfd.k8s-sigs.io/v1alpha1
           kind: NodeFeature
           metadata:
             labels:
          diff --git a/v0.15/usage/examples-and-demos.html b/v0.15/usage/examples-and-demos.html
          index f30d958da..89fb0d637 100644
          --- a/v0.15/usage/examples-and-demos.html
          +++ b/v0.15/usage/examples-and-demos.html
          @@ -1 +1 @@
          -        Examples and demos · Node Feature Discovery                      

          Examples and demos

          Table of contents

          1. Demos
            1. Usage demo
            2. Demo use case

          This page contains usage examples and demos.

          Demos

          Usage demo

          asciicast

          Demo use case

          A demo on the benefits of using node feature discovery can be found in the source code repository under demo/.


          Node Feature Discovery
          v0.15
          Versions
          GitHub
          Homepage
          Issues
          Download

          This Software is under the terms of Apache License 2.0.
          \ No newline at end of file + Examples and demos · Node Feature Discovery

          Examples and demos

          Table of contents

          1. Demos
            1. Usage demo
            2. Demo use case

          This page contains usage examples and demos.

          Demos

          Usage demo

          asciicast

          Demo use case

          A demo on the benefits of using node feature discovery can be found in the source code repository under demo/.


          Node Feature Discovery
          v0.15
          Versions
          GitHub
          Homepage
          Issues
          Download

          This Software is under the terms of Apache License 2.0.
          \ No newline at end of file diff --git a/v0.15/usage/features.html b/v0.15/usage/features.html index c6442f757..88b1908b5 100644 --- a/v0.15/usage/features.html +++ b/v0.15/usage/features.html @@ -1,2 +1,2 @@ - Feature labels · Node Feature Discovery

          Feature labels

          Table of contents

          1. Built-in labels
            1. CPU
            2. Kernel
            3. Memory
            4. Network
            5. PCI
            6. USB
            7. Storage
            8. System
            9. Custom
          2. User defined labels
          3. Extended resources

          Features are advertised as labels in the Kubernetes Node object.

          Built-in labels

          Label creation in nfd-worker is performed by a set of separate modules called label sources. The core.labelSources configuration option (or -label-sources flag) of nfd-worker controls which sources to enable for label generation.

          All built-in labels use the feature.node.kubernetes.io label namespace and have the following format.

          feature.node.kubernetes.io/<feature> = <value>
          +        Feature labels · Node Feature Discovery                      

          Feature labels

          Table of contents

          1. Built-in labels
            1. CPU
            2. Kernel
            3. Memory
            4. Network
            5. PCI
            6. USB
            7. Storage
            8. System
            9. Custom
          2. User defined labels
          3. Extended resources

          Features are advertised as labels in the Kubernetes Node object.

          Built-in labels

          Label creation in nfd-worker is performed by a set of separate modules called label sources. The core.labelSources configuration option (or -label-sources flag) of nfd-worker controls which sources to enable for label generation.

          All built-in labels use the feature.node.kubernetes.io label namespace and have the following format.

          feature.node.kubernetes.io/<feature> = <value>
           

          NOTE: Consecutive runs of nfd-worker will update the labels on a given node. If features are not discovered on a consecutive run, the corresponding label will be removed. This includes any restrictions placed on the consecutive run, such as restricting discovered features with the -label-whitelist flag of nfd-master or core.labelWhiteList option of nfd-worker.

          CPU

          Feature name Value Description
          cpu-cpuid.<cpuid-flag> true CPU capability is supported. NOTE: the capability might be supported but not enabled.
          cpu-hardware_multithreading true Hardware multithreading, such as Intel HTT, enabled (number of logical CPUs is greater than physical CPUs)
          cpu-coprocessor.nx_gzip true Nest Accelerator for GZIP is supported(Power).
          cpu-power.sst_bf.enabled true Intel SST-BF (Intel Speed Select Technology - Base frequency) enabled
          cpu-pstate.status string The status of the Intel pstate driver when in use and enabled, either ‘active' or ‘passive'.
          cpu-pstate.turbo bool Set to ‘true' if turbo frequencies are enabled in Intel pstate driver, set to ‘false' if they have been disabled.
          cpu-pstate.scaling_governor string The value of the Intel pstate scaling_governor when in use, either ‘powersave' or ‘performance'.
          cpu-cstate.enabled bool Set to ‘true' if cstates are set in the intel_idle driver, otherwise set to ‘false'. Unset if intel_idle cpuidle driver is not active.
          cpu-rdt.<rdt-flag> true DEPRECATED Intel RDT capability is supported. See RDT flags for details.
          cpu-security.sgx.enabled true Set to ‘true' if Intel SGX is enabled in BIOS (based on a non-zero sum value of SGX EPC section sizes).
          cpu-security.se.enabled true Set to ‘true' if IBM Secure Execution for Linux (IBM Z & LinuxONE) is available and enabled (requires /sys/firmware/uv/prot_virt_host facility)
          cpu-security.tdx.enabled true Set to ‘true' if Intel TDX is available on the host and has been enabled (requires /sys/module/kvm_intel/parameters/tdx).
          cpu-security.tdx.protected true Set to ‘true' if Intel TDX was used to start the guest node, based on the existence of the "TDX_GUEST" information as part of cpuid features.
          cpu-security.sev.enabled true Set to ‘true' if ADM SEV is available on the host and has been enabled (requires /sys/module/kvm_amd/parameters/sev).
          cpu-security.sev.es.enabled true Set to ‘true' if ADM SEV-ES is available on the host and has been enabled (requires /sys/module/kvm_amd/parameters/sev_es).
          cpu-security.sev.snp.enabled true Set to ‘true' if ADM SEV-SNP is available on the host and has been enabled (requires /sys/module/kvm_amd/parameters/sev_snp).
          cpu-model.vendor_id string Comparable CPU vendor ID.
          cpu-model.family int CPU family.
          cpu-model.id int CPU model number.

          NOTE: the cpu-rdt.<rdt-flag> labels are deprecated and will be removed in a future release. They will remain to be available as features for NodeFeatureRule to consume. See customization guide for details how to use NodeFeatureRule objects to create labels.

          The CPU label source is configurable, see worker configuration and sources.cpu configuration options for details.

          X86 CPUID flags (partial list)

          Flag Description
          ADX Multi-Precision Add-Carry Instruction Extensions (ADX)
          AESNI Advanced Encryption Standard (AES) New Instructions (AES-NI)
          APX_F Intel Advanced Performance Extensions (APX)
          AVX10 Intel Advanced Vector Extensions 10 (AVX10)
          AVX10_256, AVX10_512 Intel AVX10 256-bit and 512-bit vector support
          AVX Advanced Vector Extensions (AVX)
          AVX2 Advanced Vector Extensions 2 (AVX2)
          AVXIFMA AVX-IFMA instructions
          AVXVNNI AVX (VEX encoded) VNNI neural network instructions
          AMXBF16 Advanced Matrix Extension, tile multiplication operations on BFLOAT16 numbers
          AMXINT8 Advanced Matrix Extension, tile multiplication operations on 8-bit integers
          AMXFP16 Advanced Matrix Extension, tile multiplication operations on FP16 numbers
          AMXTILE Advanced Matrix Extension, base tile architecture support
          AVX512BF16 AVX-512 BFLOAT16 instructions
          AVX512BITALG AVX-512 bit Algorithms
          AVX512BW AVX-512 byte and word Instructions
          AVX512CD AVX-512 conflict detection instructions
          AVX512DQ AVX-512 doubleword and quadword instructions
          AVX512ER AVX-512 exponential and reciprocal instructions
          AVX512F AVX-512 foundation
          AVX512FP16 AVX-512 FP16 instructions
          AVX512IFMA AVX-512 integer fused multiply-add instructions
          AVX512PF AVX-512 prefetch instructions
          AVX512VBMI AVX-512 vector bit manipulation instructions
          AVX512VBMI2 AVX-512 vector bit manipulation instructions, version 2
          AVX512VL AVX-512 vector length extensions
          AVX512VNNI AVX-512 vector neural network instructions
          AVX512VP2INTERSECT AVX-512 intersect for D/Q
          AVX512VPOPCNTDQ AVX-512 vector population count doubleword and quadword
          AVXNECONVERT AVX-NE-CONVERT instructions
          AVXVNNIINT8 AVX-VNNI-INT8 instructions
          CMPCCXADD CMPCCXADD instructions
          ENQCMD Enqueue Command
          GFNI Galois Field New Instructions
          HYPERVISOR Running under hypervisor
          MSRLIST Read/Write List of Model Specific Registers
          PREFETCHI PREFETCHIT0/1 instructions
          VAES AVX-512 vector AES instructions
          VPCLMULQDQ Carry-less multiplication quadword
          WRMSRNS Non-Serializing Write to Model Specific Register

          By default, the following CPUID flags have been blacklisted: BMI1, BMI2, CLMUL, CMOV, CX16, ERMS, F16C, HTT, LZCNT, MMX, MMXEXT, NX, POPCNT, RDRAND, RDSEED, RDTSCP, SGX, SSE, SSE2, SSE3, SSE4, SSE42, SSSE3 and TDX_GUEST. See sources.cpu configuration options to change the behavior.

          See the full list in github.com/klauspost/cpuid.

          Arm CPUID flags (partial list)

          Flag Description
          IDIVA Integer divide instructions available in ARM mode
          IDIVT Integer divide instructions available in Thumb mode
          THUMB Thumb instructions
          FASTMUL Fast multiplication
          VFP Vector floating point instruction extension (VFP)
          VFPv3 Vector floating point extension v3
          VFPv4 Vector floating point extension v4
          VFPD32 VFP with 32 D-registers
          HALF Half-word loads and stores
          EDSP DSP extensions
          NEON NEON SIMD instructions
          LPAE Large Physical Address Extensions

          Arm64 CPUID flags (partial list)

          Flag Description
          AES Announcing the Advanced Encryption Standard
          EVSTRM Event Stream Frequency Features
          FPHP Half Precision(16bit) Floating Point Data Processing Instructions
          ASIMDHP Half Precision(16bit) Asimd Data Processing Instructions
          ATOMICS Atomic Instructions to the A64
          ASIMRDM Support for Rounding Double Multiply Add/Subtract
          PMULL Optional Cryptographic and CRC32 Instructions
          JSCVT Perform Conversion to Match Javascript
          DCPOP Persistent Memory Support

          Kernel

          Feature Value Description
          kernel-config.<option> true Kernel config option is enabled (set ‘y' or ‘m'). Default options are NO_HZ, NO_HZ_IDLE, NO_HZ_FULL and PREEMPT
          kernel-selinux.enabled true Selinux is enabled on the node
          kernel-version.full string Full kernel version as reported by /proc/sys/kernel/osrelease (e.g. ‘4.5.6-7-g123abcde')
          kernel-version.major string First component of the kernel version (e.g. ‘4')
          kernel-version.minor string Second component of the kernel version (e.g. ‘5')
          kernel-version.revision string Third component of the kernel version (e.g. ‘6')

          The kernel label source is configurable, see worker configuration and sources.kernel configuration options for details.

          Memory

          Feature Value Description
          memory-numa true Multiple memory nodes i.e. NUMA architecture detected
          memory-nv.present true NVDIMM device(s) are present
          memory-nv.dax true NVDIMM region(s) configured in DAX mode are present

          Network

          Feature Value Description
          network-sriov.capable true Single Root Input/Output Virtualization (SR-IOV) enabled Network Interface Card(s) present
          network-sriov.configured true SR-IOV virtual functions have been configured

          PCI

          Feature Value Description
          pci-<device label>.present true PCI device is detected
          pci-<device label>.sriov.capable true Single Root Input/Output Virtualization (SR-IOV) enabled PCI device present
               

          <device label> is format is configurable and set to <class>_<vendor> by default. For more more details about configuration of the pci labels, see sources.pci options and worker configuration instructions.

          USB

          Feature Value Description
          usb-<device label>.present true USB device is detected

          <device label> is format is configurable and set to <class>_<vendor>_<device> by default. For more more details about configuration of the usb labels, see sources.usb options and worker configuration instructions.

          Storage

          Feature Value Description
          storage-nonrotationaldisk true Non-rotational disk, like SSD, is present in the node

          System

          Feature Value Description
          system-os_release.ID string Operating system identifier
          system-os_release.VERSION_ID string Operating system version identifier (e.g. ‘6.7')
          system-os_release.VERSION_ID.major string First component of the OS version id (e.g. ‘6')
          system-os_release.VERSION_ID.minor string Second component of the OS version id (e.g. ‘7')

          Custom

          The custom label source is designed for creating user defined labels. However, it has a few statically defined built-in labels:

          Feature Value Description
          custom-rdma.capable true The node has an RDMA capable Network adapter
          custom-rdma.enabled true The node has the needed RDMA modules loaded to run RDMA traffic
               

          User defined labels

          NFD has many extension points for creating vendor and application specific labels. See the customization guide for detailed documentation.

          Extended resources

          NFD is able to create extended resources, see the NodeFeatureRule CRD and its extendedResources field for more details.

          Note that NFD is not a replacement for the usage of device plugins.

          An example use-case for extended resources could be based on custom feature (created e.g. with feature files that exposes the node SGX EPC memory section size. This value will then be turned into an extended resource of the node, allowing PODs to request that resource and the Kubernetes scheduler to schedule such PODs to only those nodes which have a sufficient capacity of said resource left.


          Node Feature Discovery
          v0.15
          Versions
          GitHub
          Homepage
          Issues
          Download

          This Software is under the terms of Apache License 2.0.
          \ No newline at end of file diff --git a/v0.15/usage/index.html b/v0.15/usage/index.html index f917e2ed1..39965b519 100644 --- a/v0.15/usage/index.html +++ b/v0.15/usage/index.html @@ -1 +1 @@ - Usage · Node Feature Discovery

          Usage

          Usage instructions.


          Node Feature Discovery
          v0.15
          Versions
          GitHub
          Homepage
          Issues
          Download

          This Software is under the terms of Apache License 2.0.
          \ No newline at end of file + Usage · Node Feature Discovery

          Usage

          Usage instructions.


          Node Feature Discovery
          v0.15
          Versions
          GitHub
          Homepage
          Issues
          Download

          This Software is under the terms of Apache License 2.0.
          \ No newline at end of file diff --git a/v0.15/usage/kubectl-plugin.html b/v0.15/usage/kubectl-plugin.html index 71446e19d..317ced5ea 100644 --- a/v0.15/usage/kubectl-plugin.html +++ b/v0.15/usage/kubectl-plugin.html @@ -1,4 +1,4 @@ - Kubectl plugin · Node Feature Discovery

          Kubectl plugin

          Table of contents

          1. Overview
            1. Validate
            2. Test
            3. DryRun

          Developer Preview This feature is currently in developer preview and subject to change. It is not recommended to use it in production environments.

          Overview

          The kubectl plugin kubectl nfd can be used to validate/dryrun and test NodeFeatureRule objects. It can be installed with the following command:

          git clone https://github.com/kubernetes-sigs/node-feature-discovery
          +        Kubectl plugin · Node Feature Discovery                      

          Kubectl plugin

          Table of contents

          1. Overview
            1. Validate
            2. Test
            3. DryRun

          Developer Preview This feature is currently in developer preview and subject to change. It is not recommended to use it in production environments.

          Overview

          The kubectl plugin kubectl nfd can be used to validate/dryrun and test NodeFeatureRule objects. It can be installed with the following command:

          git clone https://github.com/kubernetes-sigs/node-feature-discovery
           cd node-feature-discovery
           make build-kubectl-nfd
           KUBECTL_PATH=/usr/local/bin/
          diff --git a/v0.15/usage/nfd-gc.html b/v0.15/usage/nfd-gc.html
          index b417bd147..5e03931ee 100644
          --- a/v0.15/usage/nfd-gc.html
          +++ b/v0.15/usage/nfd-gc.html
          @@ -1 +1 @@
          -        NFD-Garbage-Collector · Node Feature Discovery                      

          NFD-GC


          NFD-GC (NFD Garbage-Collector) is preferably run as a Kubernetes deployment with one replica. It makes sure that all NodeFeature and NodeResourceTopology objects have corresponding nodes and removes stale objects for non-existent nodes.

          The daemon watches for Node deletion events and removes NodeFeature and NodeResourceTopology objects upon them. It also runs periodically to make sure no node delete event was missed and to remove any NodeFeature or NodeResourceTopology objects that were created without corresponding node. The default garbage collector interval is set to 1h which is the value when no -gc-interval is specified.

          Configuration

          In Helm deployments (see garbage collector parameters) NFD-GC will only be deployed when enableNodeFeatureApi or topologyUpdater.enable is set to true.


          Node Feature Discovery
          v0.15
          Versions
          GitHub
          Homepage
          Issues
          Download

          This Software is under the terms of Apache License 2.0.
          \ No newline at end of file + NFD-Garbage-Collector · Node Feature Discovery

          NFD-GC


          NFD-GC (NFD Garbage-Collector) is preferably run as a Kubernetes deployment with one replica. It makes sure that all NodeFeature and NodeResourceTopology objects have corresponding nodes and removes stale objects for non-existent nodes.

          The daemon watches for Node deletion events and removes NodeFeature and NodeResourceTopology objects upon them. It also runs periodically to make sure no node delete event was missed and to remove any NodeFeature or NodeResourceTopology objects that were created without corresponding node. The default garbage collector interval is set to 1h which is the value when no -gc-interval is specified.

          Configuration

          In Helm deployments (see garbage collector parameters) NFD-GC will only be deployed when enableNodeFeatureApi or topologyUpdater.enable is set to true.


          Node Feature Discovery
          v0.15
          Versions
          GitHub
          Homepage
          Issues
          Download

          This Software is under the terms of Apache License 2.0.
          \ No newline at end of file diff --git a/v0.15/usage/nfd-master.html b/v0.15/usage/nfd-master.html index 715ec13ea..f8c56f00c 100644 --- a/v0.15/usage/nfd-master.html +++ b/v0.15/usage/nfd-master.html @@ -1,2 +1,2 @@ - NFD-Master · Node Feature Discovery

          NFD-Master


          NFD-Master is responsible for connecting to the Kubernetes API server and updating node objects. More specifically, it modifies node labels, taints and extended resources based on requests from nfd-workers and 3rd party extensions.

          NodeFeature controller

          The NodeFeature Controller uses NodeFeature objects as the input for the NodeFeatureRule processing pipeline. In addition, any labels listed in the NodeFeature object are created on the node (note the allowed label namespaces are controlled).

          NodeFeatureRule controller

          NFD-Master acts as the controller for NodeFeatureRule objects. It applies the rules specified in NodeFeatureRule objects on raw feature data and creates node labels accordingly. The feature data used as the input is received from nfd-worker instances through NodeFeature objects.

          NOTE: when gRPC (DEPRECATED) is used for communicating the features (by setting the flag -enable-nodefeature-api=false on both nfd-master and nfd-worker, or via Helm values.enableNodeFeatureApi=false), (re-)labelling only happens when a request is received from nfd-worker. That is, in practice rules are evaluated and labels for each node are created on intervals specified by the core.sleepInterval configuration option of nfd-worker instances. This means that modification or creation of NodeFeatureRule objects does not instantly cause the node labels to be updated. Instead, the changes only come visible in node labels as nfd-worker instances send their labelling requests. This limitation is not present when gRPC interface is disabled and NodeFeature API is used.

          Master configuration

          NFD-Master supports dynamic configuration through a configuration file. The default location is /etc/kubernetes/node-feature-discovery/nfd-master.conf, but, this can be changed by specifying the-config command line flag. Configuration file is re-read whenever it is modified which makes run-time re-configuration of nfd-master straightforward.

          Master configuration file is read inside the container, and thus, Volumes and VolumeMounts are needed to make your configuration available for NFD. The preferred method is to use a ConfigMap which provides easy deployment and re-configurability.

          The provided nfd-master deployment templates create an empty configmap and mount it inside the nfd-master containers. In kustomize deployments, configuration can be edited with:

          kubectl -n ${NFD_NS} edit configmap nfd-master-conf
          +        NFD-Master · Node Feature Discovery                      

          NFD-Master


          NFD-Master is responsible for connecting to the Kubernetes API server and updating node objects. More specifically, it modifies node labels, taints and extended resources based on requests from nfd-workers and 3rd party extensions.

          NodeFeature controller

          The NodeFeature Controller uses NodeFeature objects as the input for the NodeFeatureRule processing pipeline. In addition, any labels listed in the NodeFeature object are created on the node (note the allowed label namespaces are controlled).

          NodeFeatureRule controller

          NFD-Master acts as the controller for NodeFeatureRule objects. It applies the rules specified in NodeFeatureRule objects on raw feature data and creates node labels accordingly. The feature data used as the input is received from nfd-worker instances through NodeFeature objects.

          NOTE: when gRPC (DEPRECATED) is used for communicating the features (by setting the flag -enable-nodefeature-api=false on both nfd-master and nfd-worker, or via Helm values.enableNodeFeatureApi=false), (re-)labelling only happens when a request is received from nfd-worker. That is, in practice rules are evaluated and labels for each node are created on intervals specified by the core.sleepInterval configuration option of nfd-worker instances. This means that modification or creation of NodeFeatureRule objects does not instantly cause the node labels to be updated. Instead, the changes only come visible in node labels as nfd-worker instances send their labelling requests. This limitation is not present when gRPC interface is disabled and NodeFeature API is used.

          Master configuration

          NFD-Master supports dynamic configuration through a configuration file. The default location is /etc/kubernetes/node-feature-discovery/nfd-master.conf, but, this can be changed by specifying the-config command line flag. Configuration file is re-read whenever it is modified which makes run-time re-configuration of nfd-master straightforward.

          Master configuration file is read inside the container, and thus, Volumes and VolumeMounts are needed to make your configuration available for NFD. The preferred method is to use a ConfigMap which provides easy deployment and re-configurability.

          The provided nfd-master deployment templates create an empty configmap and mount it inside the nfd-master containers. In kustomize deployments, configuration can be edited with:

          kubectl -n ${NFD_NS} edit configmap nfd-master-conf
           

          In Helm deployments, Master pod parameter master.config can be used to edit the respective configuration.

          See nfd-master configuration file reference for more details. The (empty-by-default) example config contains all available configuration options and can be used as a reference for creating a configuration.

          Deployment notes

          NFD-Master runs as a deployment, by default it prefers running on the cluster's master nodes but will run on worker nodes if no master nodes are found.

          For High Availability, you should increase the replica count of the deployment object. You should also look into adding inter-pod affinity to prevent masters from running on the same node. However note that inter-pod affinity is costly and is not recommended in bigger clusters.

          Note: When NFD-Master is intended to run with more than one replica, it is advised to use -enable-leader-election flag. This flag turns on leader election for NFD-Master and let only one replica to act on changes in NodeFeature and NodeFeatureRule objects.

          If you have RBAC authorization enabled (as is the default e.g. with clusters initialized with kubeadm) you need to configure the appropriate ClusterRoles, ClusterRoleBindings and a ServiceAccount for NFD to create node labels. The provided template will configure these for you.


          Node Feature Discovery
          v0.15
          Versions
          GitHub
          Homepage
          Issues
          Download

          This Software is under the terms of Apache License 2.0.
          \ No newline at end of file diff --git a/v0.15/usage/nfd-topology-updater.html b/v0.15/usage/nfd-topology-updater.html index d53db3f4a..edeb2d0cf 100644 --- a/v0.15/usage/nfd-topology-updater.html +++ b/v0.15/usage/nfd-topology-updater.html @@ -1,2 +1,2 @@ - NFD-Topology-Updater · Node Feature Discovery

          NFD-Topology-Updater


          NFD-Topology-Updater is preferably run as a Kubernetes DaemonSet. This assures re-examination on regular intervals and/or per pod life-cycle events, capturing changes in the allocated resources and hence the allocatable resources on a per-zone basis by updating NodeResourceTopology custom resources. It makes sure that new NodeResourceTopology instances are created for each new nodes that get added to the cluster.

          Because of the design and implementation of Kubernetes, only resources exclusively allocated to Guaranteed Quality of Service pods will be accounted. This includes CPU cores, memory and devices.

          When run as a daemonset, nodes are re-examined for the allocated resources (to determine the information of the allocatable resources on a per-zone basis where a zone can be a NUMA node) at an interval specified using the -sleep-interval option. The default sleep interval is set to 60s which is the value when no -sleep-interval is specified. The re-examination can be disabled by setting the sleep-interval to 0.

          Another option is to configure the updater to update the allocated resources per pod life-cycle events. The updater will monitor the checkpoint file stated in -kubelet-state-dir and triggers an update for every change occurs in the files.

          In addition, it can avoid examining specific allocated resources given a configuration of resources to exclude via -excludeList

          Deployment Notes

          Kubelet PodResource API with the GetAllocatableResources functionality enabled is a prerequisite for nfd-topology-updater to be able to run (i.e. Kubernetes v1.21 or later is required).

          Preceding Kubernetes v1.23, the kubelet must be started with --feature-gates=KubeletPodResourcesGetAllocatable=true.

          Starting from Kubernetes v1.23, the KubeletPodResourcesGetAllocatable feature gate. is enabled by default

          Topology-Updater Configuration

          NFD-Topology-Updater supports configuration through a configuration file. The default location is /etc/kubernetes/node-feature-discovery/topology-updater.conf, but, this can be changed by specifying the-config command line flag.

          NOTE: unlike nfd-worker, dynamic configuration updates are not supported.

          Topology-Updater configuration file is read inside the container, and thus, Volumes and VolumeMounts are needed to make your configuration available for NFD. The preferred method is to use a ConfigMap which provides easy deployment and re-configurability.

          The provided nfd-topology-updater deployment templates create an empty configmap and mount it inside the nfd-topology-updater containers. In kustomize deployments, configuration can be edited with:

          kubectl -n ${NFD_NS} edit configmap nfd-topology-updater-conf
          +        NFD-Topology-Updater · Node Feature Discovery                      

          NFD-Topology-Updater


          NFD-Topology-Updater is preferably run as a Kubernetes DaemonSet. This assures re-examination on regular intervals and/or per pod life-cycle events, capturing changes in the allocated resources and hence the allocatable resources on a per-zone basis by updating NodeResourceTopology custom resources. It makes sure that new NodeResourceTopology instances are created for each new nodes that get added to the cluster.

          Because of the design and implementation of Kubernetes, only resources exclusively allocated to Guaranteed Quality of Service pods will be accounted. This includes CPU cores, memory and devices.

          When run as a daemonset, nodes are re-examined for the allocated resources (to determine the information of the allocatable resources on a per-zone basis where a zone can be a NUMA node) at an interval specified using the -sleep-interval option. The default sleep interval is set to 60s which is the value when no -sleep-interval is specified. The re-examination can be disabled by setting the sleep-interval to 0.

          Another option is to configure the updater to update the allocated resources per pod life-cycle events. The updater will monitor the checkpoint file stated in -kubelet-state-dir and triggers an update for every change occurs in the files.

          In addition, it can avoid examining specific allocated resources given a configuration of resources to exclude via -excludeList

          Deployment Notes

          Kubelet PodResource API with the GetAllocatableResources functionality enabled is a prerequisite for nfd-topology-updater to be able to run (i.e. Kubernetes v1.21 or later is required).

          Preceding Kubernetes v1.23, the kubelet must be started with --feature-gates=KubeletPodResourcesGetAllocatable=true.

          Starting from Kubernetes v1.23, the KubeletPodResourcesGetAllocatable feature gate. is enabled by default

          Topology-Updater Configuration

          NFD-Topology-Updater supports configuration through a configuration file. The default location is /etc/kubernetes/node-feature-discovery/topology-updater.conf, but, this can be changed by specifying the-config command line flag.

          NOTE: unlike nfd-worker, dynamic configuration updates are not supported.

          Topology-Updater configuration file is read inside the container, and thus, Volumes and VolumeMounts are needed to make your configuration available for NFD. The preferred method is to use a ConfigMap which provides easy deployment and re-configurability.

          The provided nfd-topology-updater deployment templates create an empty configmap and mount it inside the nfd-topology-updater containers. In kustomize deployments, configuration can be edited with:

          kubectl -n ${NFD_NS} edit configmap nfd-topology-updater-conf
           

          In Helm deployments, Topology Updater parameters toplogyUpdater.config can be used to edit the respective configuration.

          See nfd-topology-updater configuration file reference for more details. The (empty-by-default) example config contains all available configuration options and can be used as a reference for creating a configuration.


          Node Feature Discovery
          v0.15
          Versions
          GitHub
          Homepage
          Issues
          Download

          This Software is under the terms of Apache License 2.0.
          \ No newline at end of file diff --git a/v0.15/usage/nfd-worker.html b/v0.15/usage/nfd-worker.html index 96b5310b8..70e1e9585 100644 --- a/v0.15/usage/nfd-worker.html +++ b/v0.15/usage/nfd-worker.html @@ -1,3 +1,3 @@ - NFD-Worker · Node Feature Discovery

          NFD-Worker


          NFD-Worker is preferably run as a Kubernetes DaemonSet. This assures re-labeling on regular intervals capturing changes in the system configuration and makes sure that new nodes are labeled as they are added to the cluster. Worker connects to the nfd-master service to advertise hardware features.

          When run as a daemonset, nodes are re-labeled at an default interval of 60s. This can be changed by using the core.sleepInterval config option.

          The worker configuration file is watched and re-read on every change which provides a mechanism of dynamic run-time reconfiguration. See worker configuration for more details.

          Worker configuration

          NFD-Worker supports dynamic configuration through a configuration file. The default location is /etc/kubernetes/node-feature-discovery/nfd-worker.conf, but, this can be changed by specifying the-config command line flag. Configuration file is re-read whenever it is modified which makes run-time re-configuration of nfd-worker straightforward.

          Worker configuration file is read inside the container, and thus, Volumes and VolumeMounts are needed to make your configuration available for NFD. The preferred method is to use a ConfigMap which provides easy deployment and re-configurability.

          The provided nfd-worker deployment templates create an empty configmap and mount it inside the nfd-worker containers. In kustomize deployments, configuration can be edited with:

          kubectl -n ${NFD_NS} edit configmap nfd-worker-conf
          +        NFD-Worker · Node Feature Discovery                      

          NFD-Worker


          NFD-Worker is preferably run as a Kubernetes DaemonSet. This assures re-labeling on regular intervals capturing changes in the system configuration and makes sure that new nodes are labeled as they are added to the cluster. Worker connects to the nfd-master service to advertise hardware features.

          When run as a daemonset, nodes are re-labeled at an default interval of 60s. This can be changed by using the core.sleepInterval config option.

          The worker configuration file is watched and re-read on every change which provides a mechanism of dynamic run-time reconfiguration. See worker configuration for more details.

          Worker configuration

          NFD-Worker supports dynamic configuration through a configuration file. The default location is /etc/kubernetes/node-feature-discovery/nfd-worker.conf, but, this can be changed by specifying the-config command line flag. Configuration file is re-read whenever it is modified which makes run-time re-configuration of nfd-worker straightforward.

          Worker configuration file is read inside the container, and thus, Volumes and VolumeMounts are needed to make your configuration available for NFD. The preferred method is to use a ConfigMap which provides easy deployment and re-configurability.

          The provided nfd-worker deployment templates create an empty configmap and mount it inside the nfd-worker containers. In kustomize deployments, configuration can be edited with:

          kubectl -n ${NFD_NS} edit configmap nfd-worker-conf
           

          In Helm deployments, Worker pod parameter worker.config can be used to edit the respective configuration.

          See nfd-worker configuration file reference for more details. The (empty-by-default) example config contains all available configuration options and can be used as a reference for creating a configuration.

          Configuration options can also be specified via the -options command line flag, in which case no mounts need to be used. The same format as in the config file must be used, i.e. JSON (or YAML). For example:

          -options='{"sources": { "pci": { "deviceClassWhitelist": ["12"] } } }'
           

          Configuration options specified from the command line will override those read from the config file.


          Node Feature Discovery
          v0.15
          Versions
          GitHub
          Homepage
          Issues
          Download

          This Software is under the terms of Apache License 2.0.
          \ No newline at end of file diff --git a/v0.15/usage/using-labels.html b/v0.15/usage/using-labels.html index f25c1a92a..d4fd59f00 100644 --- a/v0.15/usage/using-labels.html +++ b/v0.15/usage/using-labels.html @@ -1,4 +1,4 @@ - Using node labels · Node Feature Discovery

          Using node labels


          Nodes with specific features can be targeted using the nodeSelector field. The following example shows how to target nodes with Intel TurboBoost enabled.

          apiVersion: v1
          +        Using node labels · Node Feature Discovery                      

          Using node labels


          Nodes with specific features can be targeted using the nodeSelector field. The following example shows how to target nodes with Intel TurboBoost enabled.

          apiVersion: v1
           kind: Pod
           metadata:
             labels: