From de0f252856b3f1f255e7528b35ad92da49de7353 Mon Sep 17 00:00:00 2001 From: Github Actions Date: Mon, 15 Jul 2024 13:06:24 +0000 Subject: [PATCH] Update documentation for master Auto-generated from v0.2.0-301-gea4d9be by 'update-gh-pages.sh' --- master/404.html | 2 +- master/advanced/developer-guide.html | 4 ++-- master/advanced/index.html | 2 +- master/advanced/nodefeaturediscovery.html | 4 ++-- master/contributing/index.html | 2 +- master/deployment/cleanup.html | 4 ++-- master/deployment/helm.html | 4 ++-- master/deployment/index.html | 2 +- master/deployment/manual.html | 4 ++-- master/introduction/index.html | 2 +- master/search.html | 2 +- master/sitemap.xml | 2 +- 12 files changed, 17 insertions(+), 17 deletions(-) diff --git a/master/404.html b/master/404.html index a94ddeaf..b5170943 100644 --- a/master/404.html +++ b/master/404.html @@ -1 +1 @@ - 404 · Node Feature Discovery Operator

404

Not Found


Node Feature Discovery Operator
master
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 Operator

404

Not Found


Node Feature Discovery Operator
master
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/master/advanced/developer-guide.html b/master/advanced/developer-guide.html index 0202ca3f..f764aa96 100644 --- a/master/advanced/developer-guide.html +++ b/master/advanced/developer-guide.html @@ -1,4 +1,4 @@ - Developer guide · Node Feature Discovery Operator

Developer guide

Table of contents

  1. Developer guide
    1. Building the operator
      1. Download the source code
      2. Build the operator image
    2. Manual deployment of the operator
    3. Undeploy the operator
    4. Clean up labels
    5. Using skipper utility

Building the operator

Download the source code

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

Developer guide

Table of contents

  1. Developer guide
    1. Building the operator
      1. Download the source code
      2. Build the operator image
    2. Manual deployment of the operator
    3. Undeploy the operator
    4. Clean up labels
    5. Using skipper utility

Building the operator

Download the source code

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

Build the operator image

IMAGE_REGISTRY=<my registry>
 make image
 

Or for the debug variant

IMAGE_REGISTRY=<my registry>
@@ -18,4 +18,4 @@
 

using Makefile commands with skipper

skipper make image
 skipper make build
 skipper make deploy
-

Node Feature Discovery Operator
master
Versions
GitHub
Homepage
Issues
Download

This Software is under the terms of Apache License 2.0.
\ No newline at end of file +

Node Feature Discovery Operator
master
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/master/advanced/index.html b/master/advanced/index.html index 6b5b9da0..20551338 100644 --- a/master/advanced/index.html +++ b/master/advanced/index.html @@ -1 +1 @@ - Advanced · Node Feature Discovery Operator

Advanced

Advanced topics and reference.

Continue to:


Node Feature Discovery Operator
master
Versions
GitHub
Homepage
Issues
Download

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

Advanced

Advanced topics and reference.

Continue to:


Node Feature Discovery Operator
master
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/master/advanced/nodefeaturediscovery.html b/master/advanced/nodefeaturediscovery.html index da267c8b..dfc6299b 100644 --- a/master/advanced/nodefeaturediscovery.html +++ b/master/advanced/nodefeaturediscovery.html @@ -1,4 +1,4 @@ - NodeFeatureDiscovery · Node Feature Discovery Operator

The NodeFeatureDiscovery CR

The NodeFeatureDiscovery CustomResource defines operational variables to define the behaviour of the Node Feature Discovery Operand, an example of the CustomResource:

apiVersion: nfd.kubernetes.io/v1
+        NodeFeatureDiscovery · Node Feature Discovery Operator                      

The NodeFeatureDiscovery CR

The NodeFeatureDiscovery CustomResource defines operational variables to define the behaviour of the Node Feature Discovery Operand, an example of the CustomResource:

apiVersion: nfd.kubernetes.io/v1
 kind: NodeFeatureDiscovery
 metadata:
   name: nfd-master-server
@@ -165,4 +165,4 @@
       #        - feature: local.label
       #          matchExpressions:
       #            custom-feature-knob: {op: Gt, value: ["100"]}
-

For more information about how to setup the WorkerConfig stanza, see worker config reference


Node Feature Discovery Operator
master
Versions
GitHub
Homepage
Issues
Download

This Software is under the terms of Apache License 2.0.
\ No newline at end of file +

For more information about how to setup the WorkerConfig stanza, see worker config reference


Node Feature Discovery Operator
master
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/master/contributing/index.html b/master/contributing/index.html index 3d00f574..b87d3cb6 100644 --- a/master/contributing/index.html +++ b/master/contributing/index.html @@ -1 +1 @@ - Contributing · Node Feature Discovery Operator

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 Operator
master
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 Operator

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 Operator
master
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/master/deployment/cleanup.html b/master/deployment/cleanup.html index 761e342b..4cb40c56 100644 --- a/master/deployment/cleanup.html +++ b/master/deployment/cleanup.html @@ -1,4 +1,4 @@ - Cleanup · Node Feature Discovery Operator

Removing feature labels

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

In order to remove all feature labels from the cluster, run the following command:

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

Removing feature labels

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

In order to remove all feature labels from the cluster, run the following command:

kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prune?ref=master
 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=master
-

Node Feature Discovery Operator
master
Versions
GitHub
Homepage
Issues
Download

This Software is under the terms of Apache License 2.0.
\ No newline at end of file +

Node Feature Discovery Operator
master
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/master/deployment/helm.html b/master/deployment/helm.html index f98dd8c6..98fe2638 100644 --- a/master/deployment/helm.html +++ b/master/deployment/helm.html @@ -1,4 +1,4 @@ - Helm · Node Feature Discovery Operator

Deployment with Helm

Table of contents

  1. Deployment with Helm
    1. Prerequisites
    2. Deployment
    3. Configuration
    4. Uninstalling the chart
    5. Chart parameters
      1. General parameters
      2. Controller deployment parameters

Helm chart allow to easily deploy and manage the NFD-operator.

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

Prerequisites

Helm package manager should be installed.

Deployment

To install the latest stable version:

export NFD_O_NS=nfd-operator
+        Helm · Node Feature Discovery Operator                      

Deployment with Helm

Table of contents

  1. Deployment with Helm
    1. Prerequisites
    2. Deployment
    3. Configuration
    4. Uninstalling the chart
    5. Chart parameters
      1. General parameters
      2. Controller deployment parameters

Helm chart allow to easily deploy and manage the NFD-operator.

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

Prerequisites

Helm package manager should be installed.

Deployment

To install the latest stable version:

export NFD_O_NS=nfd-operator
 helm repo add nfd-operator https://kubernetes-sigs.github.io/node-feature-discovery-operator/charts
 helm repo update
 helm install nfd-operator/nfd-operator --namespace $NFD_O_NS --create-namespace --generate-name
@@ -12,4 +12,4 @@
 helm install nfd-operator/nfd-operator --set nameOverride=NFDinstance --namespace $NFD_O_NS --create-namespace
 

Uninstalling the chart

To uninstall the nfd-operator deployment:

export NFD_O_NS=nfd-operator
 helm uninstall nfd-operator --namespace $NFD_O_NS
-

The command removes all the Kubernetes components associated with the chart and deletes the release.

Chart parameters

In order to tailor the deployment of the Node Feature Discovery to your cluster needs We have introduced the following Chart parameters.

General parameters

Name Type Default description
image.repository string gcr.io/k8s-staging-nfd/node-feature-discovery-operator NFD image repository
image.tag string master NFD image tag
image.pullPolicy string Always Image pull policy
imagePullSecrets list [] ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info
nameOverride string   Override the name of the chart
fullnameOverride string   Override a default fully qualified app name

Controller deployment parameters

Name Type Default description
controller.image.repository string gcr.io/k8s-staging-nfd/node-feature-discovery-operator NFD-Operator image repository
controller.image.tag string master NFD-Operator image tag

Node Feature Discovery Operator
master
Versions
GitHub
Homepage
Issues
Download

This Software is under the terms of Apache License 2.0.
\ No newline at end of file +

The command removes all the Kubernetes components associated with the chart and deletes the release.

Chart parameters

In order to tailor the deployment of the Node Feature Discovery to your cluster needs We have introduced the following Chart parameters.

General parameters

Name Type Default description
image.repository string gcr.io/k8s-staging-nfd/node-feature-discovery-operator NFD image repository
image.tag string master NFD image tag
image.pullPolicy string Always Image pull policy
imagePullSecrets list [] ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info
nameOverride string   Override the name of the chart
fullnameOverride string   Override a default fully qualified app name

Controller deployment parameters

Name Type Default description
controller.image.repository string gcr.io/k8s-staging-nfd/node-feature-discovery-operator NFD-Operator image repository
controller.image.tag string master NFD-Operator image tag

Node Feature Discovery Operator
master
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/master/deployment/index.html b/master/deployment/index.html index c4463de2..be9b1eb4 100644 --- a/master/deployment/index.html +++ b/master/deployment/index.html @@ -1 +1 @@ - Deployment · Node Feature Discovery Operator

Deployment

Installation provides instructions for installing NFD-Operator to a cluster.

Uninstallation provides instructions for removing NFD-Operator from a cluster.

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

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


Node Feature Discovery Operator
master
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 Operator

Deployment

Installation provides instructions for installing NFD-Operator to a cluster.

Uninstallation provides instructions for removing NFD-Operator from a cluster.

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

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


Node Feature Discovery Operator
master
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/master/deployment/manual.html b/master/deployment/manual.html index fc86b407..dcc6045f 100644 --- a/master/deployment/manual.html +++ b/master/deployment/manual.html @@ -1,4 +1,4 @@ - Manual deployment · Node Feature Discovery Operator

Manual deployment

Table of contents

  1. Manual deployment
  2. Requirements
  3. Manual deployment
    1. Verify
  4. Uninstallation

Requirements

  1. Linux (x86_64/Arm64/Arm)
  2. kubectl (properly set up and configured to work with your Kubernetes cluster)

Manual deployment

Get the source code

git clone -b master https://github.com/kubernetes-sigs/node-feature-discovery-operator
+        Manual deployment · Node Feature Discovery Operator                      

Manual deployment

Table of contents

  1. Manual deployment
  2. Requirements
  3. Manual deployment
    1. Verify
  4. Uninstallation

Requirements

  1. Linux (x86_64/Arm64/Arm)
  2. kubectl (properly set up and configured to work with your Kubernetes cluster)

Manual deployment

Get the source code

git clone -b master https://github.com/kubernetes-sigs/node-feature-discovery-operator
 

Deploy the operator

You can use the IMAGE_TAG environment variable to specify the container image to use.

IMAGE_TAG=gcr.io/k8s-staging-nfd/node-feature-discovery-operator:master
 make deploy
 

By default the operator will watch NodeFeatureDiscovery objects only in the namespace where the operator is deployed in. This is specified by the WATCH_NAMESPACE env variable in the operator deployment manifest. If unset the operator will watch ALL namespaces.

Create a NodeFeatureDiscovery instance

kubectl apply -f config/samples/nfd.kubernetes.io_v1_nodefeaturediscovery.yaml
@@ -17,4 +17,4 @@
 ...
 

Uninstallation

If you followed the deployment instructions from the above you can simply do:

kubectl -n nfd-operator delete NodeFeatureDiscovery my-nfd-deployment
 

Optionally, you can also remove the namespace:

kubectl delete ns nfd-operator
-

See the node-feature-discovery-operator and OLM project documentation for instructions for uninstalling the operator and operator lifecycle manager, respectively.


Node Feature Discovery Operator
master
Versions
GitHub
Homepage
Issues
Download

This Software is under the terms of Apache License 2.0.
\ No newline at end of file +

See the node-feature-discovery-operator and OLM project documentation for instructions for uninstalling the operator and operator lifecycle manager, respectively.


Node Feature Discovery Operator
master
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/master/introduction/index.html b/master/introduction/index.html index 2ba4a1dc..6ef73670 100644 --- a/master/introduction/index.html +++ b/master/introduction/index.html @@ -1 +1 @@ - Introduction · Node Feature Discovery Operator

Node Feature Discovery Operator

Welcome to Node Feature Discovery Operator – an Operator Framework implementation around the Node Feature Discovery project to enable detecting hardware features and system configuration!

Continue to:

  • Deployment for instructions on how to deploy NFD-Operator to a cluster.

  • Advanced for more advanced topics and reference.

Introduction

The Node Feature Discovery Operator manages the detection of hardware features and configuration in a Kubernetes cluster by labeling the nodes with hardware-specific information. The Node Feature Discovery (NFD) will label the host with node-specific attributes, like PCI cards, kernel, or OS version, and many more.

The NFD Operator is based on the Operator Framework an open source toolkit to manage Kubernetes native applications, called Operators, in an effective, automated, and scalable way.


Node Feature Discovery Operator
master
Versions
GitHub
Homepage
Issues
Download

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

Node Feature Discovery Operator

Welcome to Node Feature Discovery Operator – an Operator Framework implementation around the Node Feature Discovery project to enable detecting hardware features and system configuration!

Continue to:

  • Deployment for instructions on how to deploy NFD-Operator to a cluster.

  • Advanced for more advanced topics and reference.

Introduction

The Node Feature Discovery Operator manages the detection of hardware features and configuration in a Kubernetes cluster by labeling the nodes with hardware-specific information. The Node Feature Discovery (NFD) will label the host with node-specific attributes, like PCI cards, kernel, or OS version, and many more.

The NFD Operator is based on the Operator Framework an open source toolkit to manage Kubernetes native applications, called Operators, in an effective, automated, and scalable way.


Node Feature Discovery Operator
master
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/master/search.html b/master/search.html index fa1147e1..d5936c46 100644 --- a/master/search.html +++ b/master/search.html @@ -1 +1 @@ - Search · Node Feature Discovery Operator

Searching


    Node Feature Discovery Operator
    master
    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 Operator

    Searching


      Node Feature Discovery Operator
      master
      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/master/sitemap.xml b/master/sitemap.xml index 6a06157a..393aa936 100644 --- a/master/sitemap.xml +++ b/master/sitemap.xml @@ -1 +1 @@ - https://kubernetes-sigs.github.com/node-feature-discovery-operator/master/advanced/developer-guide.html 1.0 2024-07-15T03:12:12-05:00 https://kubernetes-sigs.github.com/node-feature-discovery-operator/master/deployment/helm.html 1.0 2024-07-15T03:12:12-05:00 https://kubernetes-sigs.github.com/node-feature-discovery-operator/master/introduction/ 0.6 2024-07-15T03:12:12-05:00 https://kubernetes-sigs.github.com/node-feature-discovery-operator/master/advanced/nodefeaturediscovery.html 1.0 2024-07-15T03:12:12-05:00 https://kubernetes-sigs.github.com/node-feature-discovery-operator/master/deployment/manual.html 1.0 2024-07-15T03:12:12-05:00 https://kubernetes-sigs.github.com/node-feature-discovery-operator/master/deployment/ 0.3 2024-07-15T03:12:12-05:00 https://kubernetes-sigs.github.com/node-feature-discovery-operator/master/advanced/ 0.2 2024-07-15T03:12:12-05:00 https://kubernetes-sigs.github.com/node-feature-discovery-operator/master/deployment/cleanup.html 0.7 2024-07-15T03:12:12-05:00 https://kubernetes-sigs.github.com/node-feature-discovery-operator/master/contributing/ 0.6 2024-07-15T03:12:12-05:00 \ No newline at end of file + https://kubernetes-sigs.github.com/node-feature-discovery-operator/master/advanced/developer-guide.html 1.0 2024-07-15T08:06:16-05:00 https://kubernetes-sigs.github.com/node-feature-discovery-operator/master/deployment/helm.html 1.0 2024-07-15T08:06:16-05:00 https://kubernetes-sigs.github.com/node-feature-discovery-operator/master/introduction/ 0.6 2024-07-15T08:06:16-05:00 https://kubernetes-sigs.github.com/node-feature-discovery-operator/master/advanced/nodefeaturediscovery.html 1.0 2024-07-15T08:06:16-05:00 https://kubernetes-sigs.github.com/node-feature-discovery-operator/master/deployment/manual.html 1.0 2024-07-15T08:06:16-05:00 https://kubernetes-sigs.github.com/node-feature-discovery-operator/master/deployment/ 0.3 2024-07-15T08:06:16-05:00 https://kubernetes-sigs.github.com/node-feature-discovery-operator/master/advanced/ 0.2 2024-07-15T08:06:16-05:00 https://kubernetes-sigs.github.com/node-feature-discovery-operator/master/deployment/cleanup.html 0.7 2024-07-15T08:06:16-05:00 https://kubernetes-sigs.github.com/node-feature-discovery-operator/master/contributing/ 0.6 2024-07-15T08:06:16-05:00 \ No newline at end of file