From cf602e42e244ac2fa910822110848157ddf9e311 Mon Sep 17 00:00:00 2001 From: Github Actions Date: Thu, 31 Aug 2023 16:05:12 +0000 Subject: [PATCH] Update documentation for v0.13 Auto-generated from v0.13.4 by 'update-gh-pages.sh' --- v0.13/404.html | 2 +- v0.13/contributing/index.html | 2 +- v0.13/deployment/helm.html | 2 +- v0.13/deployment/image-variants.html | 2 +- v0.13/deployment/index.html | 2 +- v0.13/deployment/kustomize.html | 2 +- v0.13/deployment/operator.html | 2 +- v0.13/deployment/tls.html | 2 +- v0.13/deployment/uninstallation.html | 2 +- v0.13/developer-guide/index.html | 2 +- v0.13/get-started/index.html | 2 +- v0.13/get-started/introduction.html | 2 +- v0.13/get-started/quick-start.html | 2 +- v0.13/reference/index.html | 2 +- v0.13/reference/master-commandline-reference.html | 2 +- v0.13/reference/master-configuration-reference.html | 2 +- v0.13/reference/topology-gc-commandline-reference.html | 2 +- v0.13/reference/topology-updater-commandline-reference.html | 2 +- v0.13/reference/topology-updater-configuration-reference.html | 2 +- v0.13/reference/worker-commandline-reference.html | 2 +- v0.13/reference/worker-configuration-reference.html | 2 +- v0.13/search.html | 2 +- v0.13/sitemap.xml | 2 +- v0.13/usage/custom-resources.html | 2 +- v0.13/usage/customization-guide.html | 2 +- v0.13/usage/examples-and-demos.html | 2 +- v0.13/usage/features.html | 2 +- v0.13/usage/index.html | 2 +- v0.13/usage/nfd-master.html | 2 +- v0.13/usage/nfd-topology-gc.html | 2 +- v0.13/usage/nfd-topology-updater.html | 2 +- v0.13/usage/nfd-worker.html | 2 +- v0.13/usage/using-labels.html | 2 +- 33 files changed, 33 insertions(+), 33 deletions(-) diff --git a/v0.13/404.html b/v0.13/404.html index 2a69b23c72..1f3f209c7d 100644 --- a/v0.13/404.html +++ b/v0.13/404.html @@ -1 +1 @@ - 404 · Node Feature Discovery

404

Not Found


Node Feature Discovery
v0.13
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.13
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.13/contributing/index.html b/v0.13/contributing/index.html index fff4a338de..86a3bdb830 100644 --- a/v0.13/contributing/index.html +++ b/v0.13/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.13
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.13
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.13/deployment/helm.html b/v0.13/deployment/helm.html index 28da460aad..1cb325cc4b 100644 --- a/v0.13/deployment/helm.html +++ b/v0.13/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. Topology garbage collector parameters

Node Feature Discovery Helm chart allow to easily deploy and manage NFD.

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. Topology garbage collector parameters

Node Feature Discovery Helm chart allow to easily deploy and manage NFD.

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.13/deployment/image-variants.html b/v0.13/deployment/image-variants.html
index 8096a3e7f0..8649d70c2a 100644
--- a/v0.13/deployment/image-variants.html
+++ b/v0.13/deployment/image-variants.html
@@ -1 +1 @@
-        Image variants · Node Feature Discovery                      

Image variants

Table of contents

  1. Minimal
  2. Full

NFD currently offers two variants of the container image. The "minimal" variant is currently deployed by default. Released container images are available for x86_64 and Arm64 architectures.

Minimal

This is a minimal image based on gcr.io/distroless/base 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.13.4-minimal) is provided.

Full

This image is based on debian:bullseye-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.13.4-full).


Node Feature Discovery
v0.13
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

Table of contents

  1. Minimal
  2. Full

NFD currently offers two variants of the container image. The "minimal" variant is currently deployed by default. Released container images are available for x86_64 and Arm64 architectures.

Minimal

This is a minimal image based on gcr.io/distroless/base 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.13.4-minimal) is provided.

Full

This image is based on debian:bullseye-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.13.4-full).


Node Feature Discovery
v0.13
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.13/deployment/index.html b/v0.13/deployment/index.html index 656b59e94d..58023a2b13 100644 --- a/v0.13/deployment/index.html +++ b/v0.13/deployment/index.html @@ -1 +1 @@ - Deployment · Node Feature Discovery

Deployment

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.13
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

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.13
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.13/deployment/kustomize.html b/v0.13/deployment/kustomize.html index 2aab35a3ff..452a74eea9 100644 --- a/v0.13/deployment/kustomize.html +++ b/v0.13/deployment/kustomize.html @@ -1,4 +1,4 @@ - Kustomize · Node Feature Discovery

Deploymenet with Kustomize

Table of contents

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

Kustomize provides easy deployment of 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.13.4
+        Kustomize · Node Feature Discovery                      

Deploymenet with Kustomize

Table of contents

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

Kustomize provides easy deployment of 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.13.4
 

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. Please refer to the Master Worker Topologyupdater and Topologyupdater below.

Alternatively you can clone the repository and customize the deployment by creating your own overlays. For example, to deploy the minimal image. 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

Master-worker pod

You can also run nfd-master and nfd-worker inside the same pod

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

This creates a DaemonSet that runs nfd-worker and nfd-master in the same Pod. In this case no nfd-master is run on the master node(s), but, the worker nodes are able to label themselves which may be desirable e.g. in single-node setups.

NOTE: nfd-topology-updater is not deployed by the default-combined overlay. To enable nfd-topology-updater in this scenario,the users must customize the deployment themselves.

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)
diff --git a/v0.13/deployment/operator.html b/v0.13/deployment/operator.html
index 42ac77321b..17ee6a6a44 100644
--- a/v0.13/deployment/operator.html
+++ b/v0.13/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.13/deployment/tls.html b/v0.13/deployment/tls.html
      index 133e38e7d8..7e7157bea5 100644
      --- a/v0.13/deployment/tls.html
      +++ b/v0.13/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

      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 can be done as easily as this, below, or you can refer to their documentation for other installation methods such as the helm chart they provide.

      kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.6.1/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

      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 can be done as easily as this, below, or you can refer to their documentation for other installation methods such as the helm chart they provide.

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

      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.13/deployment/uninstallation.html b/v0.13/deployment/uninstallation.html
      index 7e10a991df..fcbf699aec 100644
      --- a/v0.13/deployment/uninstallation.html
      +++ b/v0.13/deployment/uninstallation.html
      @@ -1,4 +1,4 @@
      -        Uninstallation · Node Feature Discovery                      

      Uninstallation

      Table of contents

      1. Removing feature labels

      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.13.4
      +        Uninstallation · Node Feature Discovery                      

      Uninstallation

      Table of contents

      1. Removing feature labels

      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.13.4
       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.13.4
       

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


      Node Feature Discovery
      v0.13
      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.13/developer-guide/index.html b/v0.13/developer-guide/index.html index 818daf1b65..c6cc63b5c8 100644 --- a/v0.13/developer-guide/index.html +++ b/v0.13/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.13/get-started/index.html b/v0.13/get-started/index.html
      index 6bc5e94bae..328e4451b7 100644
      --- a/v0.13/get-started/index.html
      +++ b/v0.13/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.13.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.13.4
         namespace/node-feature-discovery created
         serviceaccount/nfd-master created
         clusterrole.rbac.authorization.k8s.io/nfd-master created
      diff --git a/v0.13/get-started/introduction.html b/v0.13/get-started/introduction.html
      index 7b9be7e6ed..a3ee36c4e2 100644
      --- a/v0.13/get-started/introduction.html
      +++ b/v0.13/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-Topology-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 and node taints.

      NFD consists of four software components:

      1. nfd-master
      2. nfd-worker
      3. nfd-topology-updater
      4. nfd-topology-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-Topology-GC

      NFD-Topology-GC is a daemon responsible for cleaning obsolete NodeResourceTopology objects, obsolete means that there is no corresponding worker node.

      One instance of nfd-topology-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-Topology-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 and node taints.

      NFD consists of four software components:

      1. nfd-master
      2. nfd-worker
      3. nfd-topology-updater
      4. nfd-topology-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-Topology-GC

      NFD-Topology-GC is a daemon responsible for cleaning obsolete NodeResourceTopology objects, obsolete means that there is no corresponding worker node.

      One instance of nfd-topology-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.13/get-started/quick-start.html b/v0.13/get-started/quick-start.html
      index 3f44b57836..0c4fc6ba5e 100644
      --- a/v0.13/get-started/quick-start.html
      +++ b/v0.13/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.13.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.13.4
       

      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.13/reference/index.html b/v0.13/reference/index.html
      index 4f2851bd1f..9a6d8be4c7 100644
      --- a/v0.13/reference/index.html
      +++ b/v0.13/reference/index.html
      @@ -1 +1 @@
      -        Reference · Node Feature Discovery                      

      Reference

      Command line and configuration reference.


      Node Feature Discovery
      v0.13
      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.13
      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.13/reference/master-commandline-reference.html b/v0.13/reference/master-commandline-reference.html index 0103c2c435..eb65ff6354 100644 --- a/v0.13/reference/master-commandline-reference.html +++ b/v0.13/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. -instance
      6. -ca-file
      7. -cert-file
      8. -key-file
      9. -verify-node-name
      10. -enable-nodefeature-api
      11. -enable-taints
      12. -no-publish
      13. -crd-controller
      14. -featurerules-controller
      15. -label-whitelist
      16. -extra-label-ns
      17. -deny-label-ns
      18. -resource-labels
      19. -config
      20. -options
      21. Logging

      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.13.4 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. -instance
      6. -ca-file
      7. -cert-file
      8. -key-file
      9. -verify-node-name
      10. -enable-nodefeature-api
      11. -enable-taints
      12. -no-publish
      13. -crd-controller
      14. -featurerules-controller
      15. -label-whitelist
      16. -extra-label-ns
      17. -deny-label-ns
      18. -resource-labels
      19. -config
      20. -options
      21. Logging

      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.13.4 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
       

      -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
       

      -ca-file

      The -ca-file is one of the three flags (together with -cert-file and -key-file) controlling master-worker mutual TLS authentication on the nfd-master side. This flag specifies the TLS root certificate that is used for authenticating incoming connections. NFD-Worker side needs to have matching key and cert files configured in order for the incoming requests to be accepted.

      Default: empty

      Note: Must be specified together with -cert-file and -key-file

      Example:

      nfd-master -ca-file=/opt/nfd/ca.crt -cert-file=/opt/nfd/master.crt -key-file=/opt/nfd/master.key
      diff --git a/v0.13/reference/master-configuration-reference.html b/v0.13/reference/master-configuration-reference.html
      index 70fbd73552..35d35695dc 100644
      --- a/v0.13/reference/master-configuration-reference.html
      +++ b/v0.13/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. resourceLabels
      5. enableTaints
      6. labelWhiteList

      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. resourceLabels
      5. enableTaints
      6. labelWhiteList

      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. Note that the namespaces feature.node.kubernetes.io and profile.node.kubernetes.io and their sub-namespaces are always allowed and cannot be denied.

      Default: empty

      Example:

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

      resourceLabels

      DEPRECATED: NodeFeatureRule should be used for managing extended resources in NFD.

      The resourceLabels option specifies a list of features to be advertised as extended resources instead of labels. Features that have integer values can be published as Extended Resources by listing them in this option.

      Default: empty

      Example:

      resourceLabels: ["vendor-1.com/feature-1","vendor-2.io/feature-2"]
      diff --git a/v0.13/reference/topology-gc-commandline-reference.html b/v0.13/reference/topology-gc-commandline-reference.html
      index 49531b0015..ec02a6f8b0 100644
      --- a/v0.13/reference/topology-gc-commandline-reference.html
      +++ b/v0.13/reference/topology-gc-commandline-reference.html
      @@ -1,4 +1,4 @@
      -        Topology Garbage Collector Cmdline Reference · Node Feature Discovery                      

      NFD-Topology-Garbage-Collector Commandline Flags

      Table of Contents

      1. NFD-Topology-Garbage-Collector Commandline Flags
        1. -h, -help
        2. -version
        3. -gc-interval

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

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

      NFD-Topology-Garbage-Collector Commandline Flags

      Table of Contents

      1. NFD-Topology-Garbage-Collector Commandline Flags
        1. -h, -help
        2. -version
        3. -gc-interval

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

      docker run registry.k8s.io/nfd/node-feature-discovery:v0.13.4 \
       nfd-topology-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-topology-gc -gc-interval=1h
       

      Node Feature Discovery
      v0.13
      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.13/reference/topology-updater-commandline-reference.html b/v0.13/reference/topology-updater-commandline-reference.html index 0bdb65f470..9587aa2147 100644 --- a/v0.13/reference/topology-updater-commandline-reference.html +++ b/v0.13/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. NFD-Topology-Updater Commandline Flags
        1. -h, -help
        2. -version
        3. -config
        4. -no-publish
        5. -oneshot
        6. -sleep-interval
        7. -watch-namespace
        8. -kubelet-config-uri
        9. -api-auth-token-file
        10. -podresources-socket
        11. -pods-fingerprint
        12. -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.13.4 \
      +        Topology Updater Cmdline Reference · Node Feature Discovery                      

      NFD-Topology-Updater Commandline Flags

      Table of Contents

      1. NFD-Topology-Updater Commandline Flags
        1. -h, -help
        2. -version
        3. -config
        4. -no-publish
        5. -oneshot
        6. -sleep-interval
        7. -watch-namespace
        8. -kubelet-config-uri
        9. -api-auth-token-file
        10. -podresources-socket
        11. -pods-fingerprint
        12. -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.13.4 \
       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.13/reference/topology-updater-configuration-reference.html b/v0.13/reference/topology-updater-configuration-reference.html
      index 0a6974e519..ba89c35650 100644
      --- a/v0.13/reference/topology-updater-configuration-reference.html
      +++ b/v0.13/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.13/reference/worker-commandline-reference.html b/v0.13/reference/worker-commandline-reference.html
      index 2b99d6a641..12a878e764 100644
      --- a/v0.13/reference/worker-commandline-reference.html
      +++ b/v0.13/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. -no-publish
      15. -oneshot
      16. 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.13.4 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. -no-publish
      15. -oneshot
      16. 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.13.4 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

      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.13/reference/worker-configuration-reference.html b/v0.13/reference/worker-configuration-reference.html
      index 5be7e2dd5f..00f7e2b760 100644
      --- a/v0.13/reference/worker-configuration-reference.html
      +++ b/v0.13/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.13/search.html b/v0.13/search.html
      index f628be7ee8..67a7d2d5e0 100644
      --- a/v0.13/search.html
      +++ b/v0.13/search.html
      @@ -1 +1 @@
      -        Search · Node Feature Discovery                      

      Searching


        Node Feature Discovery
        v0.13
        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.13
          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.13/sitemap.xml b/v0.13/sitemap.xml index 97d95aadc1..0f3e077212 100644 --- a/v0.13/sitemap.xml +++ b/v0.13/sitemap.xml @@ -1 +1 @@ - https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/usage/features.html 1.0 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/get-started/ 1.0 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/deployment/image-variants.html 0.8 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/get-started/introduction.html 1.0 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/reference/master-commandline-reference.html 1.0 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/usage/using-labels.html 0.8 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/reference/worker-commandline-reference.html 1.0 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/deployment/kustomize.html 1.0 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/deployment/ 0.3 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/get-started/quick-start.html 1.0 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/usage/ 0.1 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/usage/nfd-master.html 1.0 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/reference/master-configuration-reference.html 1.0 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/deployment/helm.html 1.0 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/reference/ 0.1 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/reference/worker-configuration-reference.html 1.0 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/usage/nfd-worker.html 1.0 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/deployment/operator.html 1.0 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/reference/topology-updater-commandline-reference.html 1.0 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/deployment/tls.html 1.0 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/usage/nfd-topology-updater.html 1.0 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/developer-guide/ 1.0 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/reference/topology-updater-configuration-reference.html 1.0 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/contributing/ 0.5 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/deployment/uninstallation.html 0.9 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/usage/nfd-topology-gc.html 0.6 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/reference/topology-gc-commandline-reference.html 0.9 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/usage/custom-resources.html 1.0 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/usage/customization-guide.html 1.0 2023-08-31T10:34:26-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/usage/examples-and-demos.html 0.5 2023-08-31T10:34:26-05:00 \ No newline at end of file + https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/usage/features.html 1.0 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/get-started/ 1.0 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/deployment/image-variants.html 0.8 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/get-started/introduction.html 1.0 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/reference/master-commandline-reference.html 1.0 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/usage/using-labels.html 0.8 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/reference/worker-commandline-reference.html 1.0 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/deployment/kustomize.html 1.0 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/deployment/ 0.3 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/get-started/quick-start.html 1.0 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/usage/ 0.1 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/usage/nfd-master.html 1.0 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/reference/master-configuration-reference.html 1.0 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/deployment/helm.html 1.0 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/reference/ 0.1 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/reference/worker-configuration-reference.html 1.0 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/usage/nfd-worker.html 1.0 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/deployment/operator.html 1.0 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/reference/topology-updater-commandline-reference.html 1.0 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/deployment/tls.html 1.0 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/usage/nfd-topology-updater.html 1.0 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/developer-guide/ 1.0 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/reference/topology-updater-configuration-reference.html 1.0 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/contributing/ 0.5 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/deployment/uninstallation.html 0.9 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/usage/nfd-topology-gc.html 0.6 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/reference/topology-gc-commandline-reference.html 0.9 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/usage/custom-resources.html 1.0 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/usage/customization-guide.html 1.0 2023-08-31T11:04:56-05:00 https://kubernetes-sigs.github.com/node-feature-discovery/v0.13/usage/examples-and-demos.html 0.5 2023-08-31T11:04:56-05:00 \ No newline at end of file diff --git a/v0.13/usage/custom-resources.html b/v0.13/usage/custom-resources.html index 608688e0d7..fe46f34268 100644 --- a/v0.13/usage/custom-resources.html +++ b/v0.13/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

          EXPERIMENTAL NodeFeature is an NFD-specific custom resource for communicating node features and node labeling requests. Support for NodeFeature objects is disabled by default. If enabled, nfd-master 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

          EXPERIMENTAL NodeFeature is an NFD-specific custom resource for communicating node features and node labeling requests. Support for NodeFeature objects is disabled by default. If enabled, nfd-master 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.13/usage/customization-guide.html b/v0.13/usage/customization-guide.html
          index 19c0b6cbaa..e29b97446d 100644
          --- a/v0.13/usage/customization-guide.html
          +++ b/v0.13/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. NodeFeatureRule tainting feature
          4. Local feature source
            1. A hook example
            2. Hooks
            3. Feature files
            4. Input format
            5. Mounts
          5. Custom feature source
            1. An example custom feature source configuration
            2. Additional configuration directory
          6. Node labels
          7. Label rule format
            1. Fields
            2. Available features
            3. Templating
            4. Backreferences
            5. Examples
          8. Legacy custom rule syntax
            1. General nomenclature and definitions
            2. Custom features format (using the nomenclature defined above)
            3. Matching process
            4. Rules
            5. Legacy custom rule example

          Overview

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

          • NodeFeature (EXPERIMENTAL) 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 executing hooks and reading files.
          • custom feature source of nfd-worker creates labels based on user-specified rules.

          NodeFeature custom resource

          EXPERIMENTAL 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.

          Support for NodeFeature CRD API is enabled with the -enable-nodefeature-api command line flag. This flag must be specified for both nfd-master and nfd-worker as it will disable the gRPC communication between them.

          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. NodeFeatureRule tainting feature
          4. Local feature source
            1. A hook example
            2. Hooks
            3. Feature files
            4. Input format
            5. Mounts
          5. Custom feature source
            1. An example custom feature source configuration
            2. Additional configuration directory
          6. Node labels
          7. Label rule format
            1. Fields
            2. Available features
            3. Templating
            4. Backreferences
            5. Examples
          8. Legacy custom rule syntax
            1. General nomenclature and definitions
            2. Custom features format (using the nomenclature defined above)
            3. Matching process
            4. Rules
            5. Legacy custom rule example

          Overview

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

          • NodeFeature (EXPERIMENTAL) 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 executing hooks and reading files.
          • custom feature source of nfd-worker creates labels based on user-specified rules.

          NodeFeature custom resource

          EXPERIMENTAL 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.

          Support for NodeFeature CRD API is enabled with the -enable-nodefeature-api command line flag. This flag must be specified for both nfd-master and nfd-worker as it will disable the gRPC communication between them.

          A NodeFeature example

          Consider the following referential example:

          apiVersion: nfd.k8s-sigs.io/v1alpha1
           kind: NodeFeature
           metadata:
             labels:
          diff --git a/v0.13/usage/examples-and-demos.html b/v0.13/usage/examples-and-demos.html
          index 1f03204402..8429616839 100644
          --- a/v0.13/usage/examples-and-demos.html
          +++ b/v0.13/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.13
          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.13
          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.13/usage/features.html b/v0.13/usage/features.html index 731ff29646..727bb57981 100644 --- a/v0.13/usage/features.html +++ b/v0.13/usage/features.html @@ -1,4 +1,4 @@ - 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.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-security.sex.asids int The total amount of AMD SEV address-space identifiers (ASIDs), based on the /sys/fs/cgroup/misc.capacity information.
          cpu-security.sex.encrypted_state_ids int The total amount of AMD SEV-ES and SEV-SNP supported, based on the /sys/fs/cgroup/misc.capacity information.
          cpu-sgx.enabled true DEPRECATED: use cpu-security.sgx.enabled instead.
          cpu-se.enabled true DEPRECATED: use cpu-security.se.enabled instead.
          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)
          AVX Advanced Vector Extensions (AVX)
          AVX2 Advanced Vector Extensions 2 (AVX2)
          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
          AVXIFMA AVX-IFMA instructions
          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 and SSSE3. 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

          This feature is experimental and by no means a replacement for the usage of device plugins.

          Labels which have integer values, can be promoted to Kubernetes extended resources by listing them to the master -resource-labels command line flag. These labels won't then show in the node label section, they will appear only as extended resources.

          An example use-case for the extended resources could be based on a hook which creates a label for the node SGX EPC memory section size. By giving the name of that label in the -resource-labels flag, that value will then turn 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.

          Similar to labels, the default namespace feature.node.kubernetes.io is automatically prefixed to the extended resource, if the promoted label doesn't have a namespace.

          Example usage of the command line arguments, using a new namespace: nfd-master -resource-labels=my_source-my.feature,sgx.some.ns/epc -extra-label-ns=sgx.some.ns

          The above would result in following extended resources provided that related labels exist:

            sgx.some.ns/epc: <label value>
             feature.node.kubernetes.io/my_source-my.feature: <label value>
           

          Node Feature Discovery
          v0.13
          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.13/usage/index.html b/v0.13/usage/index.html index ec86012ceb..429a9c2dfa 100644 --- a/v0.13/usage/index.html +++ b/v0.13/usage/index.html @@ -1 +1 @@ - Usage · Node Feature Discovery

          Usage

          Usage instructions.


          Node Feature Discovery
          v0.13
          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.13
          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.13/usage/nfd-master.html b/v0.13/usage/nfd-master.html index 6a9cf78048..1e77f9b38c 100644 --- a/v0.13/usage/nfd-master.html +++ b/v0.13/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

          EXPERIMENTAL Controller for NodeFeature objects can be enabled with the -enable-nodefeature-api command line flag. When enabled, features from NodeFeature objects are used 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).

          NOTE: NodeFeature API must also be enabled in nfd-worker with its -enable-nodefeature-api flag.

          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 can be received from nfd-worker instances through the gRPC interface or from NodeFeature objects. The latter requires that the NodeFeaure controller has been enabled.

          NOTE: when gRPC is used for communicating the features (the default mechanism), (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

          EXPERIMENTAL Controller for NodeFeature objects can be enabled with the -enable-nodefeature-api command line flag. When enabled, features from NodeFeature objects are used 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).

          NOTE: NodeFeature API must also be enabled in nfd-worker with its -enable-nodefeature-api flag.

          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 can be received from nfd-worker instances through the gRPC interface or from NodeFeature objects. The latter requires that the NodeFeaure controller has been enabled.

          NOTE: when gRPC is used for communicating the features (the default mechanism), (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 simply 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: If the NodeFeature controller is enabled the replica count should be 1.

          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 in order for NFD to create node labels. The provided template will configure these for you.


          Node Feature Discovery
          v0.13
          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.13/usage/nfd-topology-gc.html b/v0.13/usage/nfd-topology-gc.html index 599484ab0c..24da475394 100644 --- a/v0.13/usage/nfd-topology-gc.html +++ b/v0.13/usage/nfd-topology-gc.html @@ -1 +1 @@ - NFD-Topology-Garbage-Collector · Node Feature Discovery

          NFD-Topology-Garbage-Collector


          NFD-Topology-Garbage-Collector is preferably run as a Kubernetes deployment with one replica. It makes sure that all NodeResourceTopology have corresponding worker nodes and removes stale objects for worker nodes which are no longer part of Kubernetes cluster.

          This service watches for Node deletion events and removes NodeResourceTopology objects upon them. It is also running periodically to make sure no event was missed or NodeResourceTopology object was created without corresponding worker node. The default garbage collector interval is set to 1h which is the value when no -gc-interval is specified.

          Topology-Garbage-Collector Configuration

          In Helm deployments, (see Topology Garbage Collector for parameters). NFD-Topology-Garbage-Collector will only be deployed when topologyUpdater.enable is set to true.


          Node Feature Discovery
          v0.13
          Versions
          GitHub
          Homepage
          Issues
          Download

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

          NFD-Topology-Garbage-Collector


          NFD-Topology-Garbage-Collector is preferably run as a Kubernetes deployment with one replica. It makes sure that all NodeResourceTopology have corresponding worker nodes and removes stale objects for worker nodes which are no longer part of Kubernetes cluster.

          This service watches for Node deletion events and removes NodeResourceTopology objects upon them. It is also running periodically to make sure no event was missed or NodeResourceTopology object was created without corresponding worker node. The default garbage collector interval is set to 1h which is the value when no -gc-interval is specified.

          Topology-Garbage-Collector Configuration

          In Helm deployments, (see Topology Garbage Collector for parameters). NFD-Topology-Garbage-Collector will only be deployed when topologyUpdater.enable is set to true.


          Node Feature Discovery
          v0.13
          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.13/usage/nfd-topology-updater.html b/v0.13/usage/nfd-topology-updater.html index 3750d10bca..4c2f68ff77 100644 --- a/v0.13/usage/nfd-topology-updater.html +++ b/v0.13/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.

          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 is a prerequisite for nfd-topology-updater to be able to run.

          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 currently 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.

          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 is a prerequisite for nfd-topology-updater to be able to run.

          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 currently 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.13
          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.13/usage/nfd-worker.html b/v0.13/usage/nfd-worker.html index f7f8b794ff..9f3b7c90b6 100644 --- a/v0.13/usage/nfd-worker.html +++ b/v0.13/usage/nfd-worker.html @@ -1,3 +1,3 @@ - NFD-Worker · Node Feature Discovery

          NFD-Worker

          Table of contents

          1. Worker configuration

          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 simple 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

          Table of contents

          1. Worker configuration

          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 simple 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.13
          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.13/usage/using-labels.html b/v0.13/usage/using-labels.html index 8aa1950a44..737c4c0072 100644 --- a/v0.13/usage/using-labels.html +++ b/v0.13/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: