\n```\n\n\n[klauspost-cpuid]: https://github.com/klauspost/cpuid#x86-cpu-instructions\n[intel-rdt]: http://www.intel.com/content/www/us/en/architecture-and-technology/resource-director-technology.html\n[intel-pstate]: https://www.kernel.org/doc/Documentation/cpu-freq/intel-pstate.txt\n[intel-sst]: https://www.intel.com/content/www/us/en/architecture-and-technology/speed-select-technology-article.html\n[sriov]: http://www.intel.com/content/www/us/en/pci-express/pci-sig-sr-iov-primer-sr-iov-technology-paper.html\n","dir":"/get-started/","name":"features.md","path":"get-started/features.md","url":"/get-started/features.html"},{"title":"Get started","layout":"default","sort":1,"content":"Node Feature Discovery \n\nWelcome to Node Feature Discovery – a Kubernetes add-on for detecting hardware\nfeatures and system configuration!
\n\nContinue to:
\n\n\n\nQuick-start – the short-short version \n\n$ kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref= master\n namespace/node-feature-discovery created\n serviceaccount/nfd-master created\n clusterrole.rbac.authorization.k8s.io/nfd-master created\n clusterrolebinding.rbac.authorization.k8s.io/nfd-master created\n configmap/nfd-worker-conf created\n service/nfd-master created\n deployment.apps/nfd-master created\n daemonset.apps/nfd-worker created\n\n$ kubectl -n node-feature-discovery get all\n NAME READY STATUS RESTARTS AGE\n pod/nfd-master-555458dbbc-sxg6w 1/1 Running 0 56s\n pod/nfd-worker-mjg9f 1/1 Running 0 17s\n...\n\n$ kubectl get no -o json | jq .items[].metadata.labels\n { \n \"beta.kubernetes.io/arch\" : \"amd64\" ,\n \"beta.kubernetes.io/os\" : \"linux\" ,\n \"feature.node.kubernetes.io/cpu-cpuid.ADX\" : \"true\" ,\n \"feature.node.kubernetes.io/cpu-cpuid.AESNI\" : \"true\" ,\n...\n\nDeveloper guide \n\nTable of contents \n\n\n Building from source \n Download the source code Docker build Deployment Building locally Customizing the build Testing \n Running locally \n NFD-Master NFD-Worker NFD-Topology-Updater \n Documentation \n\nBuilding from source \n\nDownload the source code \n\ngit clone https://github.com/kubernetes-sigs/node-feature-discovery\ncd node-feature-discovery\nDocker build \n\nBuild the container image \n\nSee customizing the build below for altering the\ncontainer image registry, for example.
\n\n\n\nPush the container image \n\nOptional, this example with Docker.
\n\ndocker push <IMAGE_TAG>\nChange the job spec to use your custom image (optional) \n\nTo use your published image from the step above instead of the\nk8s.gcr.io/nfd/node-feature-discovery image, edit image\nattribute in the spec template(s) to the new location\n(<registry-name>/<image-name>[:<version>]).
\n\nDeployment \n\nThe yamls makefile generates a kustomization.yaml matching your locally\nbuilt image and using the deploy/overlays/default deployment. See\nbuild customization below for configurability, e.g.\nchanging the deployment namespace.
\n\nK8S_NAMESPACE = my-ns make yamls\nkubectl apply -k . \nYou can use alternative deployment methods by modifying the auto-generated\nkustomization file. For example, deploying worker and master in the same pod by\npointing to deployment/overlays/default-combined.
\n\nBuilding locally \n\nYou can also build the binaries locally
\n\n\n\nThis will compile binaries under bin/
\n\nCustomizing the build \n\nThere are several Makefile variables that control the build process and the\nname of the resulting container image. The following are targeted targeted for\nbuild customization and they can be specified via environment variables or\nmakefile overrides.
\n\n\n \n \n Variable \n Description \n Default value \n \n \n \n \n HOSTMOUNT_PREFIX \n Prefix of system directories for feature discovery (local builds) \n / (local builds ) /host- (container builds ) \n \n \n IMAGE_BUILD_CMD \n Command to build the image \n docker build \n \n \n IMAGE_BUILD_EXTRA_OPTS \n Extra options to pass to build command \n empty \n \n IMAGE_PUSH_CMD \n Command to push the image to remote registry \n docker push \n \n \n IMAGE_REGISTRY \n Container image registry to use \n k8s.gcr.io/nfd \n \n \n IMAGE_TAG_NAME \n Container image tag name \n <nfd version> \n \n \n IMAGE_EXTRA_TAG_NAMES \n Additional container image tag(s) to create when building image \n empty \n \n K8S_NAMESPACE \n nfd-master and nfd-worker namespace \n kube-system \n \n \n KUBECONFIG \n Kubeconfig for running e2e-tests \n empty \n \n E2E_TEST_CONFIG \n Parameterization file of e2e-tests (see example ) \n empty \n \n OPENSHIFT \n Non-empty value enables OpenShift specific support (currently only effective in e2e tests) \n empty \n \n BASE_IMAGE_FULL \n Container base image for target image full (–target full) \n debian:buster-slim \n \n \n BASE_IMAGE_MINIMAL \n Container base image for target image minimal (–target minimal) \n gcr.io/distroless/base \n \n \n
\n\nFor example, to use a custom registry:
\n\nmake IMAGE_REGISTRY = <my custom registry uri>\nOr to specify a build tool different from Docker, It can be done in 2 ways:
\n\n\n \n via environment
\n\n IMAGE_BUILD_CMD = \"buildah bud\" make\n \n \n by overriding the variable value
\n\n make IMAGE_BUILD_CMD = \"buildah bud\" \n \n \n\nTesting \n\nUnit tests are automatically run as part of the container image build. You can\nalso run them manually in the source code tree by simply running:
\n\n\n\nEnd-to-end tests are built on top of the e2e test framework of Kubernetes, and,\nthey required a cluster to run them on. For running the tests on your test\ncluster you need to specify the kubeconfig to be used:
\n\nmake e2e-test KUBECONFIG = $HOME /.kube/config\nRunning locally \n\nYou can run NFD locally, either directly on your host OS or in containers for\ntesting and development purposes. This may be useful e.g. for checking\nfeatures-detection.
\n\nNFD-Master \n\nWhen running as a standalone container labeling is expected to fail because\nKubernetes API is not available. Thus, it is recommended to use -no-publish\ncommand line flag. E.g.
\n\n$ export NFD_CONTAINER_IMAGE = gcr.io/k8s-staging-nfd/node-feature-discovery:master\n$ docker run --rm --name = nfd-test ${ NFD_CONTAINER_IMAGE } nfd-master -no-publish \n2019/02/01 14:48:21 Node Feature Discovery Master <NFD_VERSION>\n2019/02/01 14:48:21 gRPC server serving on port: 8080\nNFD-Worker \n\nIn order to run nfd-worker as a “stand-alone” container against your\nstandalone nfd-master you need to run them in the same network namespace:
\n\n$ docker run --rm --network = container:nfd-test ${ NFD_CONTAINER_IMAGE } nfd-worker\n2019/02/01 14:48:56 Node Feature Discovery Worker <NFD_VERSION>\n...\nIf you just want to try out feature discovery without connecting to nfd-master,\npass the -no-publish flag to nfd-worker.
\n\nNOTE Some feature sources need certain directories and/or files from the\nhost mounted inside the NFD container. Thus, you need to provide Docker with the\ncorrect --volume options in order for them to work correctly when run\nstand-alone directly with docker run. See the\ndefault deployment \nfor up-to-date information about the required volume mounts.
\n\nNFD-Topology-Updater \n\nIn order to run nfd-topology-updater as a “stand-alone” container against your\nstandalone nfd-master you need to run them in the same network namespace:
\n\n$ docker run --rm --network = container:nfd-test ${ NFD_CONTAINER_IMAGE } nfd-topology-updater\n2019/02/01 14:48:56 Node Feature Discovery Topology Updater <NFD_VERSION>\n...\nIf you just want to try out feature discovery without connecting to nfd-master,\npass the -no-publish flag to nfd-topology-updater.
\n\nCommand line flags of nfd-topology-updater:
\n\n$ docker run --rm ${ NFD_CONTAINER_IMAGE } nfd-topology-updater -help \ndocker run --rm quay.io/swsehgal/node-feature-discovery:v0.10.0-devel-64-g93a0a9f-dirty nfd-topology-updater -help \nUsage of nfd-topology-updater:\n -add_dir_header \n If true , adds the file directory to the header of the log messages\n -alsologtostderr \n log to standard error as well as files\n -ca-file string\n Root certificate for verifying connections\n -cert-file string\n Certificate used for authenticating connections\n -key-file string\n Private key matching -cert-file \n -kubeconfig string\n Kube config file.\n -kubelet-config-file string\n Kubelet config file path. ( default \"/host-var/lib/kubelet/config.yaml\" ) \n -log_backtrace_at value\n when logging hits line file:N, emit a stack trace\n -log_dir string\n If non-empty, write log files in this directory\n -log_file string\n If non-empty, use this log file\n -log_file_max_size uint\n Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. ( default 1800) \n -logtostderr \n log to standard error instead of files ( default true ) \n -no-publish \n Do not publish discovered features to the cluster-local Kubernetes API server.\n -one_output \n If true , only write logs to their native severity level ( vs also writing to each lower severity level) \n -oneshot \n Update once and exit \n -podresources-socket string\n Pod Resource Socket path to use. ( default \"/host-var/lib/kubelet/pod-resources/kubelet.sock\" ) \n -server string\n NFD server address to connecto to. ( default \"localhost:8080\" ) \n -server-name-override string\n Hostname expected from server certificate, useful in testing\n -skip_headers \n If true , avoid header prefixes in the log messages\n -skip_log_headers \n If true , avoid headers when opening log files\n -sleep-interval duration\n Time to sleep between CR updates. Non-positive value implies no CR updatation ( i.e. infinite sleep ) . [ Default: 60s] ( default 1m0s) \n -stderrthreshold value\n logs at or above this threshold go to stderr ( default 2) \n -v value\n number for the log level verbosity\n -version \n Print version and exit.\n -vmodule value\n comma-separated list of pattern = N settings for file-filtered logging\n -watch-namespace string\n Namespace to watch pods ( for testing/debugging purpose) . Use * for all namespaces. ( default \"*\" ) \nNOTE:
\n\nNFD topology updater needs certain directories and/or files from the\nhost mounted inside the NFD container. Thus, you need to provide Docker with the\ncorrect --volume options in order for them to work correctly when run\nstand-alone directly with docker run. See the\ntemplate spec \nfor up-to-date information about the required volume mounts.
\n\nPodResource API is a prerequisite for nfd-topology-updater.\nPreceding Kubernetes v1.23, the kubelet must be started with the following flag:\n--feature-gates=KubeletPodResourcesGetAllocatable=true.\nStarting Kubernetes v1.23, the GetAllocatableResources is enabled by default\nthrough KubeletPodResourcesGetAllocatable feature gate .
\n\nDocumentation \n\nAll documentation resides under the\ndocs \ndirectory in the source tree. It is designed to be served as a html site by\nGitHub Pages .
\n\nBuilding the documentation is containerized in order to fix the build\nenvironment. The recommended way for developing documentation is to run:
\n\n\n\nThis will build the documentation in a container and serve it under\nlocalhost:4000/ making it easy to verify the results.\nAny changes made to the docs/ will automatically re-trigger a rebuild and are\nreflected in the served content and can be inspected with a simple browser\nrefresh.
\n\nIn order to just build the html documentation run:
\n\n\n\nThis will generate html documentation under docs/_site/.
\n\n\n","dir":"/advanced/","name":"developer-guide.md","path":"advanced/developer-guide.md","url":"/advanced/developer-guide.html"},{"title":"Introduction","layout":"default","sort":1,"content":"Introduction \n\nTable of contents \n\n\n NFD-Master NFD-Worker NFD-Topology-Updater Feature Discovery Node annotations NodeResourceTopology CR \n\nThis software enables node feature discovery for Kubernetes. It detects\nhardware features available on each node in a Kubernetes cluster, and\nadvertises those features using node labels.
\n\nNFD consists of three software components:
\n\n\n nfd-master \n nfd-worker \n nfd-topology-updater \n \n\nNFD-Master \n\nNFD-Master is the daemon responsible for communication towards the Kubernetes\nAPI. That is, it receives labeling requests from the worker and modifies node\nobjects accordingly.
\n\nNFD-Worker \n\nNFD-Worker is a daemon responsible for feature detection. It then communicates\nthe information to nfd-master which does the actual node labeling. One\ninstance of nfd-worker is supposed to be running on each node of the cluster,
\n\nNFD-Topology-Updater \n\nNFD-Topology-Updater is a daemon responsible for examining allocated\nresources on a worker node to account for resources available to be allocated\nto new pod on a per-zone basis (where a zone can be a NUMA node). It then\ncommunicates the information to nfd-master which does the\nNodeResourceTopology CR creation corresponding\nto all the nodes in the cluster. One instance of nfd-topology-updater is\nsupposed to be running on each node of the cluster.
\n\nFeature Discovery \n\nFeature discovery is divided into domain-specific feature sources:
\n\n\n CPU \n IOMMU \n Kernel \n Memory \n Network \n PCI \n Storage \n System \n USB \n Custom (rule-based custom features) \n Local (hooks for user-specific features) \n \n\nEach feature source is responsible for detecting a set of features which. in\nturn, are turned into node feature labels. Feature labels are prefixed with\nfeature.node.kubernetes.io/ and also contain the name of the feature source.\nNon-standard user-specific feature labels can be created with the local and\ncustom feature sources.
\n\nAn overview of the default feature labels:
\n\n{ \n \"feature.node.kubernetes.io/cpu-<feature-name>\" : \"true\" , \n \"feature.node.kubernetes.io/custom-<feature-name>\" : \"true\" , \n \"feature.node.kubernetes.io/iommu-<feature-name>\" : \"true\" , \n \"feature.node.kubernetes.io/kernel-<feature name>\" : \"<feature value>\" , \n \"feature.node.kubernetes.io/memory-<feature-name>\" : \"true\" , \n \"feature.node.kubernetes.io/network-<feature-name>\" : \"true\" , \n \"feature.node.kubernetes.io/pci-<device label>.present\" : \"true\" , \n \"feature.node.kubernetes.io/storage-<feature-name>\" : \"true\" , \n \"feature.node.kubernetes.io/system-<feature name>\" : \"<feature value>\" , \n \"feature.node.kubernetes.io/usb-<device label>.present\" : \"<feature value>\" , \n \"feature.node.kubernetes.io/<file name>-<feature name>\" : \"<feature value>\" \n } \n Node annotations \n\nNFD also annotates nodes it is running on:
\n\n\n \n \n Annotation \n Description \n \n \n \n \n [<instance>.]nfd.node.kubernetes.io/master.version \n Version of the nfd-master instance running on the node. Informative use only. \n \n \n [<instance>.]nfd.node.kubernetes.io/worker.version \n Version of the nfd-worker instance running on the node. Informative use only. \n \n \n [<instance>.]nfd.node.kubernetes.io/feature-labels \n Comma-separated list of node labels managed by NFD. NFD uses this internally so must not be edited by users. \n \n \n [<instance>.]nfd.node.kubernetes.io/extended-resources \n Comma-separated list of node extended resources managed by NFD. NFD uses this internally so must not be edited by users. \n \n \n
\n\nNOTE: the -instance
\n\nUnapplicable annotations are not created, i.e. for example master.version is\nonly created on nodes running nfd-master.
\n\nNodeResourceTopology CR \n\nWhen run with NFD-Topology-Updater, NFD creates CR instances corresponding to\nnode resource hardware topology such as:
\n\napiVersion : topology.node.k8s.io/v1alpha1 \nkind : NodeResourceTopology \nmetadata : \n name : node1 \ntopologyPolicies : [ \" SingleNUMANodeContainerLevel\" ] \nzones : \n - name : node-0 \n type : Node \n resources : \n - name : cpu \n capacity : 20 \n allocatable : 16 \n available : 10 \n - name : vendor/nic1 \n capacity : 3 \n allocatable : 3 \n available : 3 \n - name : node-1 \n type : Node \n resources : \n - name : cpu \n capacity : 30 \n allocatable : 30 \n available : 15 \n - name : vendor/nic2 \n capacity : 6 \n allocatable : 6 \n available : 6 \n - name : node-2 \n type : Node \n resources : \n - name : cpu \n capacity : 30 \n allocatable : 30 \n available : 15 \n - name : vendor/nic1 \n capacity : 3 \n allocatable : 3 \n available : 3 \nAdvanced \n\nAdvanced topics and reference.
\n","dir":"/advanced/","name":"index.md","path":"advanced/index.md","url":"/advanced/"},{"title":"Master cmdline reference","layout":"default","sort":2,"content":"Commandline flags of nfd-master \n\nTable of contents \n\n\n -h, -help -version -prune -port -instance -ca-file -cert-file -key-file -verify-node-name -no-publish -featurerules-controller -label-whitelist -resource-labels Logging \n\nTo quickly view available command line flags execute nfd-master -help.\nIn a docker container:
\n\ndocker run gcr.io/k8s-staging-nfd/node-feature-discovery:master nfd-master -help \n-h, -help \n\nPrint usage and exit.
\n\n-version \n\nPrint version and exit.
\n\n-prune \n\nThe -prune flag is a sub-command like option for cleaning up the cluster. It\ncauses nfd-master to remove all NFD related labels, annotations and extended\nresources from all Node objects of the cluster and exit.
\n\n-port \n\nThe -port flag specifies the TCP port that nfd-master listens for incoming requests.
\n\nDefault: 8080
\n\nExample:
\n\n\n\n-instance \n\nThe -instance flag makes it possible to run multiple NFD deployments in\nparallel. In practice, it separates the node annotations between deployments so\nthat each of them can store metadata independently. The instance name must\nstart and end with an alphanumeric character and may only contain alphanumeric\ncharacters, -, _ or ..
\n\nDefault: empty
\n\nExample:
\n\nnfd-master -instance = network\n-ca-file \n\nThe -ca-file is one of the three flags (together with -cert-file and\n-key-file) controlling master-worker mutual TLS authentication on the\nnfd-master side. This flag specifies the TLS root certificate that is used for\nauthenticating incoming connections. NFD-Worker side needs to have matching key\nand cert files configured in order for the incoming requests to be accepted.
\n\nDefault: empty
\n\nNote: Must be specified together with -cert-file and -key-file
\n\nExample:
\n\nnfd-master -ca-file = /opt/nfd/ca.crt -cert-file = /opt/nfd/master.crt -key-file = /opt/nfd/master.key\n-cert-file \n\nThe -cert-file is one of the three flags (together with -ca-file and\n-key-file) controlling master-worker mutual TLS authentication on the\nnfd-master side. This flag specifies the TLS certificate presented for\nauthenticating outgoing traffic towards nfd-worker.
\n\nDefault: empty
\n\nNote: Must be specified together with -ca-file and -key-file
\n\nExample:
\n\nnfd-master -cert-file = /opt/nfd/master.crt -key-file = /opt/nfd/master.key -ca-file = /opt/nfd/ca.crt\n-key-file \n\nThe -key-file is one of the three flags (together with -ca-file and\n-cert-file) controlling master-worker mutual TLS authentication on the\nnfd-master side. This flag specifies the private key corresponding the given\ncertificate file (-cert-file) that is used for authenticating outgoing\ntraffic.
\n\nDefault: empty
\n\nNote: Must be specified together with -cert-file and -ca-file
\n\nExample:
\n\nnfd-master -key-file = /opt/nfd/master.key -cert-file = /opt/nfd/master.crt -ca-file = /opt/nfd/ca.crt\n-verify-node-name \n\nThe -verify-node-name flag controls the NodeName based authorization of\nincoming requests and only has effect when mTLS authentication has been enabled\n(with -ca-file, -cert-file and -key-file). If enabled, the worker node\nname of the incoming must match with the CN or a SAN in its TLS certificate. Thus,\nworkers are only able to label the node they are running on (or the node whose\ncertificate they present).
\n\nNode Name based authorization is disabled by default.
\n\nDefault: false
\n\nExample:
\n\nnfd-master -verify-node-name -ca-file = /opt/nfd/ca.crt \\ \n -cert-file = /opt/nfd/master.crt -key-file = /opt/nfd/master.key\n-no-publish \n\nThe -no-publish flag disables updates to the Node objects in the Kubernetes\nAPI server, making a “dry-run” flag for nfd-master. No Labels, Annotations or\nExtendedResources of nodes are updated.
\n\nDefault: false
\n\nExample:
\n\n\n\n-featurerules-controller \n\nThe -featurerules-controller flag controlers the processing of\nNodeFeatureRule objects, effectively enabling/disabling labels from these\ncustom labeling rules.
\n\nDefault: true
\n\nExample:
\n\nnfd-master -featurerules-controller = false \n-label-whitelist \n\nThe -label-whitelist specifies a regular expression for filtering feature\nlabels based on their name. Each label must match against the given reqular\nexpression in order to be published.
\n\nNote: The regular expression is only matches against the “basename” part of the\nlabel, i.e. to the part of the name after ‘/’. The label namespace is omitted.
\n\nDefault: empty
\n\nExample:
\n\nnfd-master -label-whitelist = '.*cpuid\\.' \nThe -extra-label-ns flag specifies a comma-separated list of allowed feature\nlabel namespaces. By default, nfd-master only allows creating labels in the\ndefault feature.node.kubernetes.io and profile.node.kubernetes.io label\nnamespaces and their sub-namespaces (e.g. vendor.feature.node.kubernetes.io\nand sub.ns.profile.node.kubernetes.io). This option can be used to allow\nother vendor or application specific namespaces for custom labels from the\nlocal and custom feature sources.
\n\nThe same namespace control and this flag applies Extended Resources (created\nwith -resource-labels), too.
\n\nDefault: empty
\n\nExample:
\n\nnfd-master -extra-label-ns = vendor-1.com,vendor-2.io\n-resource-labels \n\nThe -resource-labels flag specifies a comma-separated list of features to be\nadvertised as extended resources instead of labels. Features that have integer\nvalues can be published as Extended Resources by listing them in this flag.
\n\nDefault: empty
\n\nExample:
\n\nnfd-master -resource-labels = vendor-1.com/feature-1,vendor-2.io/feature-2\nLogging \n\nThe following logging-related flags are inherited from the\nklog package.
\n\n\n\nIf true, adds the file directory to the header of the log messages.
\n\nDefault: false
\n\n-alsologtostderr \n\nLog to standard error as well as files.
\n\nDefault: false
\n\n-log_backtrace_at \n\nWhen logging hits line file:N, emit a stack trace.
\n\nDefault: empty
\n\n-log_dir \n\nIf non-empty, write log files in this directory.
\n\nDefault: empty
\n\n-log_file \n\nIf non-empty, use this log file.
\n\nDefault: empty
\n\n-log_file_max_size \n\nDefines the maximum size a log file can grow to. Unit is megabytes. If the\nvalue is 0, the maximum file size is unlimited.
\n\nDefault: 1800
\n\n-logtostderr \n\nLog to standard error instead of files
\n\nDefault: true
\n\n\n\nIf true, avoid header prefixes in the log messages.
\n\nDefault: false
\n\n\n\nIf true, avoid headers when opening log files.
\n\nDefault: false
\n\n-stderrthreshold \n\nLogs at or above this threshold go to stderr.
\n\nDefault: 2
\n\n-v \n\nNumber for the log level verbosity.
\n\nDefault: 0
\n\n-vmodule \n\nComma-separated list of pattern=N settings for file-filtered logging.
\n\nDefault: empty
\n","dir":"/advanced/","name":"master-commandline-reference.md","path":"advanced/master-commandline-reference.md","url":"/advanced/master-commandline-reference.html"},{"title":"Quick start","layout":"default","sort":2,"content":"Quick start \n\nMinimal steps to deploy latest released version of NFD in your cluster.
\n\nInstallation \n\nDeploy with kustomize – creates a new namespace, service and required RBAC\nrules and deploys nfd-master and nfd-worker daemons.
\n\nkubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref= master\nVerify \n\nWait until NFD master and NFD worker are running.
\n\n$ kubectl -n node-feature-discovery get ds,deploy\nNAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE\ndaemonset.apps/nfd-worker 2 2 2 2 2 <none> 10s\n\nNAME READY UP-TO-DATE AVAILABLE AGE\ndeployment.apps/nfd-master 1/1 1 1 17s\n\nCheck that NFD feature labels have been created
\n\n$ kubectl get no -o json | jq .items[].metadata.labels\n{ \n \"beta.kubernetes.io/arch\" : \"amd64\" ,\n \"beta.kubernetes.io/os\" : \"linux\" ,\n \"feature.node.kubernetes.io/cpu-cpuid.ADX\" : \"true\" ,\n \"feature.node.kubernetes.io/cpu-cpuid.AESNI\" : \"true\" ,\n \"feature.node.kubernetes.io/cpu-cpuid.AVX\" : \"true\" ,\n...\nUse node labels \n\nCreate a pod targeting a distinguishing feature (select a valid feature from\nthe list printed on the previous step)
\n\n$ cat << EOF | kubectl apply -f -\napiVersion: v1\nkind: Pod\nmetadata:\n name: feature-dependent-pod\nspec:\n containers:\n - image: k8s.gcr.io/pause\n name: pause\n nodeSelector:\n # Select a valid feature\n feature.node.kubernetes.io/cpu-cpuid.AESNI: 'true'\n EOF\n pod/feature-dependent-pod created\nSee that the pod is running on a desired node
\n\n$ kubectl get po feature-dependent-pod -o wide\nNAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES\nfeature-dependent-pod 1/1 Running 0 23s 10.36.0.4 node-2 <none> <none>\nAdditional Optional Installation Steps \n\nIn order to deploy nfd-master and nfd-topology-updater daemons\nuse topologyupdater overlay.
\n\nDeploy with kustomize – creates a new namespace, service and required RBAC\nrules and nfd-master and nfd-topology-updater daemons.
\n\nkubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref= master\nNOTE:
\n\nPodResource API is a prerequisite for nfd-topology-updater.
\n\nPreceding Kubernetes v1.23, the kubelet must be started with the following flag:
\n\n--feature-gates=KubeletPodResourcesGetAllocatable=true
\n\nStarting Kubernetes v1.23, the GetAllocatableResources is enabled by default\nthrough KubeletPodResourcesGetAllocatable feature gate .
\n\nVerify \n\nWait until NFD master and NFD topologyupdater are running.
\n\n$ kubectl -n node-feature-discovery get ds,deploy\nNAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE\ndaemonset.apps/nfd-topology-updater 2 2 2 2 2 <none> 5s\n\nNAME READY UP-TO-DATE AVAILABLE AGE\ndeployment.apps/nfd-master 1/1 1 1 17s\n\nCheck that the NodeResourceTopology CR instances are created
\n\n$ kubectl get noderesourcetopologies.topology.node.k8s.io\nNAME AGE\nkind-control-plane 23s\nkind-worker 23s\nShow the CR instances \n\n$ kubectl describe noderesourcetopologies.topology.node.k8s.io kind-control-plane\nName: kind-control-plane\nNamespace: default\nLabels: <none>\nAnnotations: <none>\nAPI Version: topology.node.k8s.io/v1alpha1\nKind: NodeResourceTopology\n...\nTopology Policies:\n SingleNUMANodeContainerLevel\nZones:\n Name: node-0\n Costs:\n node-0: 10\n node-1: 20\n Resources:\n Name: Cpu\n Allocatable: 3\n Capacity: 3\n Available: 3\n Name: vendor/nic1\n Allocatable: 2\n Capacity: 2\n Available: 2\n Name: vendor/nic2\n Allocatable: 2\n Capacity: 2\n Available: 2\n Type: Node\n Name: node-1\n Costs:\n node-0: 20\n node-1: 10\n Resources:\n Name: Cpu\n Allocatable: 4\n Capacity: 4\n Available: 4\n Name: vendor/nic1\n Allocatable: 2\n Capacity: 2\n Available: 2\n Name: vendor/nic2\n Allocatable: 2\n Capacity: 2\n Available: 2\n Type: Node\nEvents: <none>\nThe CR instances created can be used to gain insight into the allocatable\nresources along with the granularity of those resources at a per-zone level\n(represented by node-0 and node-1 in the above example) or can be used by an\nexternal entity (e.g. topology-aware scheduler plugin) to take an action based\non the gathered information.
\n\n\n","dir":"/get-started/","name":"quick-start.md","path":"get-started/quick-start.md","url":"/get-started/quick-start.html"},{"title":"Contributing","layout":"default","sort":3,"content":"Contributing \n\nYou can reach us via the following channels:
\n\n\n\nGovernance \n\nThis is a\nSIG-node \nsubproject, hosted under the\nKubernetes SIGs organization in Github.\nThe project was established in 2016 and was migrated to Kubernetes SIGs in 2018.
\n\nLicense \n\nThis is open source software released under the Apache 2.0 License .
\n","dir":"/contributing/","name":"index.md","path":"contributing/index.md","url":"/contributing/"},{"title":"Worker cmdline reference","layout":"default","sort":3,"content":"Commandline flags of nfd-worker \n\nTable of contents \n\n\n -h, -help -version -config -options -server -ca-file -cert-file -key-file -server-name-override -sources -no-publish -label-whitelist -oneshot -sleep-interval Logging \n\nTo quickly view available command line flags execute nfd-worker -help.\nIn a docker container:
\n\ndocker run gcr.io/k8s-staging-nfd/node-feature-discovery:master nfd-worker -help \n-h, -help \n\nPrint usage and exit.
\n\n-version \n\nPrint version and exit.
\n\n-config \n\nThe -config flag specifies the path of the nfd-worker configuration file to\nuse.
\n\nDefault: /etc/kubernetes/node-feature-discovery/nfd-worker.conf
\n\nExample:
\n\nnfd-worker -config = /opt/nfd/worker.conf\n-options \n\nThe -options flag may be used to specify and override configuration file\noptions directly from the command line. The required format is the same as in\nthe config file i.e. JSON or YAML. Configuration options specified via this\nflag will override those from the configuration file:
\n\nDefault: empty
\n\nExample:
\n\nnfd-worker -options = '{\"sources\":{\"cpu\":{\"cpuid\":{\"attributeWhitelist\":[\"AVX\",\"AVX2\"]}}}}' \n-server \n\nThe -server flag specifies the address of the nfd-master endpoint where to\nconnect to.
\n\nDefault: localhost:8080
\n\nExample:
\n\nnfd-worker -server = nfd-master.nfd.svc.cluster.local:443\n-ca-file \n\nThe -ca-file is one of the three flags (together with -cert-file and\n-key-file) controlling the mutual TLS authentication on the worker side.\nThis flag specifies the TLS root certificate that is used for verifying the\nauthenticity of nfd-master.
\n\nDefault: empty
\n\nNote: Must be specified together with -cert-file and -key-file
\n\nExample:
\n\nnfd-worker -ca-file = /opt/nfd/ca.crt -cert-file = /opt/nfd/worker.crt -key-file = /opt/nfd/worker.key\n-cert-file \n\nThe -cert-file is one of the three flags (together with -ca-file and\n-key-file) controlling mutual TLS authentication on the worker side. This\nflag specifies the TLS certificate presented for authenticating outgoing\nrequests.
\n\nDefault: empty
\n\nNote: Must be specified together with -ca-file and -key-file
\n\nExample:
\n\nnfd-workerr -cert-file = /opt/nfd/worker.crt -key-file = /opt/nfd/worker.key -ca-file = /opt/nfd/ca.crt\n-key-file \n\nThe -key-file is one of the three flags (together with -ca-file and\n-cert-file) controlling the mutual TLS authentication on the worker side.\nThis flag specifies the private key corresponding the given certificate file\n(-cert-file) that is used for authenticating outgoing requests.
\n\nDefault: empty
\n\nNote: Must be specified together with -cert-file and -ca-file
\n\nExample:
\n\nnfd-worker -key-file = /opt/nfd/worker.key -cert-file = /opt/nfd/worker.crt -ca-file = /opt/nfd/ca.crt\n-server-name-override \n\nThe -server-name-override flag specifies the common name (CN) which to\nexpect from the nfd-master TLS certificate. This flag is mostly intended for\ndevelopment and debugging purposes.
\n\nDefault: empty
\n\nExample:
\n\nnfd-worker -server-name-override = localhost\n-sources \n\nThe -sources flag specifies a comma-separated list of enabled feature\nsources. A special value all enables all feature sources.
\n\nNote: This flag takes precedence over the core.sources configuration\nfile option.
\n\nDefault: all
\n\nExample:
\n\nnfd-worker -sources = kernel,system,local\nDEPRECATED : you should use the core.sources option in the\nconfiguration file, instead.
\n\n-no-publish \n\nThe -no-publish flag disables all communication with the nfd-master, making\nit a “dry-run” flag for nfd-worker. NFD-Worker runs feature detection normally,\nbut no labeling requests are sent to nfd-master.
\n\nDefault: false
\n\nExample:
\n\n\n\n-label-whitelist \n\nThe -label-whitelist specifies a regular expression for filtering feature\nlabels based on their name. Each label must match against the given reqular\nexpression in order to be published.
\n\nNote: The regular expression is only matches against the “basename” part of the\nlabel, i.e. to the part of the name after ‘/’. The label namespace is omitted.
\n\nNote: This flag takes precedence over the core.labelWhiteList configuration\nfile option.
\n\nDefault: empty
\n\nExample:
\n\nnfd-worker -label-whitelist = '.*cpuid\\.' \nDEPRECATED : you should use the core.labelWhiteList option in the\nconfiguration file, instead.
\n\n-oneshot \n\nThe -oneshot flag causes nfd-worker to exit after one pass of feature\ndetection.
\n\nDefault: false
\n\nExample:
\n\nnfd-worker -oneshot -no-publish \n-sleep-interval \n\nThe -sleep-interval specifies the interval between feature re-detection (and\nnode re-labeling). A non-positive value implies infinite sleep interval, i.e.\nno re-detection or re-labeling is done.
\n\nNote: This flag takes precedence over the core.sleepInterval configuration\nfile option.
\n\nDefault: 60s
\n\nExample:
\n\nnfd-worker -sleep-interval = 1h\nDEPRECATED : you should use the core.sleepInterval option in the\nconfiguration file, instead.
\n\nLogging \n\nThe following logging-related flags are inherited from the\nklog package.
\n\nNote: The logger setup can also be specified via the core.klog configuration\nfile options. However, the command line flags take precedence over any\ncorresponding config file options specified.
\n\n\n\nIf true, adds the file directory to the header of the log messages.
\n\nDefault: false
\n\n-alsologtostderr \n\nLog to standard error as well as files.
\n\nDefault: false
\n\n-log_backtrace_at \n\nWhen logging hits line file:N, emit a stack trace.
\n\nDefault: empty
\n\n-log_dir \n\nIf non-empty, write log files in this directory.
\n\nDefault: empty
\n\n-log_file \n\nIf non-empty, use this log file.
\n\nDefault: empty
\n\n-log_file_max_size \n\nDefines the maximum size a log file can grow to. Unit is megabytes. If the\nvalue is 0, the maximum file size is unlimited.
\n\nDefault: 1800
\n\n-logtostderr \n\nLog to standard error instead of files
\n\nDefault: true
\n\n\n\nIf true, avoid header prefixes in the log messages.
\n\nDefault: false
\n\n\n\nIf true, avoid headers when opening log files.
\n\nDefault: false
\n\n-stderrthreshold \n\nLogs at or above this threshold go to stderr.
\n\nDefault: 2
\n\n-v \n\nNumber for the log level verbosity.
\n\nDefault: 0
\n\n-vmodule \n\nComma-separated list of pattern=N settings for file-filtered logging.
\n\nDefault: empty
\n","dir":"/advanced/","name":"worker-commandline-reference.md","path":"advanced/worker-commandline-reference.md","url":"/advanced/worker-commandline-reference.html"},{"title":"Deployment and usage","layout":"default","sort":3,"content":"Deployment and usage \n\nTable of contents \n\n\n Requirements Image variants \n Full Minimal \n Deployment options \n Operator Deployment with kustomize Deployment with Helm Build your own \n Usage \n NFD-Master NFD-Worker NFD-Topology-Updater Communication security with TLS \n Worker configuration Using node labels Uninstallation \n Operator was used for deployment Manual Removing feature labels \n \n\nRequirements \n\n\n Linux (x86_64/Arm64/Arm) \n kubectl v1.21 or\nlater (properly set up and configured to work with your Kubernetes cluster) \n\nImage variants \n\nNFD currently offers two variants of the container image. The “full” variant is\ncurrently deployed by default.
\n\nFull \n\nThis image is based on\ndebian:buster-slim and contains a full Linux\nsystem for running shell-based nfd-worker hooks and doing live debugging and\ndiagnosis of the NFD images.
\n\nMinimal \n\nThis is a minimal image based on\ngcr.io/distroless/base \nand only supports running statically linked binaries.
\n\nThe container image tag has suffix -minimal\n(e.g. gcr.io/k8s-staging-nfd/node-feature-discovery:master-minimal)
\n\nDeployment options \n\nOperator \n\nDeployment using the\nNode Feature Discovery Operator \nis recommended to be done via\noperatorhub.io .
\n\n\n You need to have\nOLM \ninstalled. If you don’t, take a look at the\nlatest release \nfor detailed instructions. \n \n Install the operator:
\n\n kubectl create -f https://operatorhub.io/install/nfd-operator.yaml\n \n \n Create NodeFeatureDiscovery resource (in nfd namespace here):
\n\n cat << EOF | kubectl apply -f -\n apiVersion: v1\n kind: Namespace\n metadata:\n name: nfd\n ---\n apiVersion: nfd.kubernetes.io/v1alpha1\n kind: NodeFeatureDiscovery\n metadata:\n name: my-nfd-deployment\n namespace: nfd\n EOF\n \n \n\nIn order to deploy the minimal image you need to add
\n\n image : gcr.io/k8s-staging-nfd/node-feature-discovery:master-minimal \nto the metadata of NodeFeatureDiscovery object above.
\n\nDeployment with kustomize \n\nThe kustomize overlays provided in the repo can be used directly:
\n\nkubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref= master\nThis will required RBAC rules and deploy nfd-master (as a deployment) and\nnfd-worker (as daemonset) in the node-feature-discovery namespace.
\n\nNOTE: nfd-topology-updater is not deployed as part of the default overlay.\nPlease refer to the Master Worker Topologyupdater \nand Topologyupdater below.
\n\nAlternatively you can clone the repository and customize the deployment by\ncreating your own overlays. For example, to deploy the minimal \nimage. See kustomize for more information about managing\ndeployment configurations.
\n\nDefault overlays \n\nThe NFD repository hosts a set of overlays for different usages and deployment\nscenarios under\ndeployment/overlays
\n\n\n\nMaster-worker pod \n\nYou can also run nfd-master and nfd-worker inside the same pod
\n\nkubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default-combined?ref= master\n\nThis creates a DaemonSet that runs nfd-worker and nfd-master in the same Pod.\nIn this case no nfd-master is run on the master node(s), but, the worker nodes\nare able to label themselves which may be desirable e.g. in single-node setups.
\n\nNOTE: nfd-topology-updater is not deployed by the default-combined overlay.\nTo enable nfd-topology-updater in this scenario,the users must customize the\ndeployment themselves.
\n\nWorker one-shot \n\nFeature discovery can alternatively be configured as a one-shot job.\nThe default-job overlay may be used to achieve this:
\n\nNUM_NODES = $( kubectl get no -o jsonpath = '{.items[*].metadata.name}' | wc -w ) \nkubectl kustomize https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default-job?ref= master | \\ \n sed s\"/NUM_NODES/ $NUM_NODES /\" | \\ \n kubectl apply -f -\nThe example above launches as many jobs as there are non-master nodes. Note that\nthis approach does not guarantee running once on every node. For example,\ntainted, non-ready nodes or some other reasons in Job scheduling may cause some\nnode(s) will run extra job instance(s) to satisfy the request.
\n\nMaster Worker Topologyupdater \n\nNFD Master, NFD worker and NFD Topologyupdater can be configured to be deployed\nas separate pods. The master-worker-topologyupdater overlay may be used to\nachieve this:
\n\nkubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/master-worker-topologyupdater?ref= master\n\nTopologyupdater \n\nIn order to deploy just NFD master and NFD Topologyupdater (without nfd-worker)\nuse the topologyupdater overlay:
\n\nkubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref= master\n\nNFD Topologyupdater can be configured along with the default overlay\n(which deploys NFD worker and NFD master) where all the software components\nare deployed as separate pods. The topologyupdater overlay may be used\nalong with default overlay to achieve this:
\n\n\nkubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref= master\nkubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref= master\n\nDeployment with Helm \n\nNode Feature Discovery Helm chart allow to easily deploy and manage NFD.
\n\nPrerequisites \n\nHelm package manager should be installed.
\n\nDeployment \n\nTo install the latest stable version:
\n\nexport NFD_NS = node-feature-discovery\nhelm repo add nfd https://kubernetes-sigs.github.io/node-feature-discovery/charts\nhelm repo update\nhelm install nfd/node-feature-discovery --namespace $NFD_NS --create-namespace --generate-name \nTo install the latest development version you need to clone the NFD Git\nrepository and install from there.
\n\ngit clone https://github.com/kubernetes-sigs/node-feature-discovery/\ncd node-feature-discovery/deployment/helm\nexport NFD_NS = node-feature-discovery\nhelm install node-feature-discovery ./node-feature-discovery/ --namespace $NFD_NS --create-namespace \nSee the configuration section below for instructions how to\nalter the deployment parameters.
\n\nIn order to deploy the minimal image you need to override the image\ntag:
\n\nhelm install node-feature-discovery ./node-feature-discovery/ --set image.tag= master-minimal --namespace $NFD_NS --create-namespace \nConfiguration \n\nYou can override values from values.yaml and provide a file with custom values:
\n\nexport NFD_NS = node-feature-discovery\nhelm install nfd/node-feature-discovery -f <path/to/custom/values.yaml> --namespace $NFD_NS --create-namespace \nTo specify each parameter separately you can provide them to helm install command:
\n\nexport NFD_NS = node-feature-discovery\nhelm install nfd/node-feature-discovery --set nameOverride = NFDinstance --set master.replicaCount= 2 --namespace $NFD_NS --create-namespace \nUninstalling the chart \n\nTo uninstall the node-feature-discovery deployment:
\n\nexport NFD_NS = node-feature-discovery\nhelm uninstall node-feature-discovery --namespace $NFD_NS \nThe command removes all the Kubernetes components associated with the chart and\ndeletes the release.
\n\nChart parameters \n\nIn order to tailor the deployment of the Node Feature Discovery to your cluster needs\nWe have introduced the following Chart parameters.
\n\nGeneral parameters \n\n\n \n \n Name \n Type \n Default \n description \n \n \n \n \n image.repositorystring \n gcr.io/k8s-staging-nfd/node-feature-discoveryNFD image repository \n \n \n image.tagstring \n masterNFD image tag \n \n \n image.pullPolicystring \n AlwaysImage pull policy \n \n \n imagePullSecretslist \n [] \n 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 \n \n \n serviceAccount.createbool \n true \n Specifies whether a service account should be created \n \n \n serviceAccount.annotationsdict \n {} \n Annotations to add to the service account \n \n \n serviceAccount.namestring \n \n The name of the service account to use. If not set and create is true, a name is generated using the fullname template \n \n \n rbacdict \n \n RBAC parameteres \n \n \n nameOverridestring \n \n Override the name of the chart \n \n \n fullnameOverridestring \n \n Override a default fully qualified app name \n \n \n nodeFeatureRule.createCRDbool \n true \n Specifies whether to create the NodeFeatureRule CRD \n \n \n
\n\nMaster pod parameters \n\n\n \n \n Name \n Type \n Default \n description \n \n \n \n \n master.*dict \n \n NFD master deployment configuration \n \n \n master.instancestring \n \n Instance name. Used to separate annotation namespaces for multiple parallel deployments \n \n \n master.extraLabelNsarray \n [] \n List of allowed extra label namespaces \n \n \n master.featureRulesControllerbool \n True \n Specifies whether the controller for processing of NodeFeatureRule objects is enable. \n \n \n master.replicaCountinteger \n 1 \n Number of desired pods. This is a pointer to distinguish between explicit zero and not specified \n \n \n master.podSecurityContextdict \n {} \n SecurityContext holds pod-level security attributes and common container settings \n \n \n master.service.typestring \n ClusterIP \n NFD master service type \n \n \n master.service.portinteger \n port \n NFD master service port \n \n \n master.resourcesdict \n {} \n NFD master pod resources management \n \n \n master.nodeSelectordict \n {} \n NFD master pod node selector \n \n \n master.tolerationsdict \n Scheduling to master node is disabled NFD master pod tolerations \n \n \n master.annotationsdict \n {} \n NFD master pod metadata \n \n \n master.affinitydict \n \n NFD master pod required node affinity \n \n \n
\n\nWorker pod parameters \n\n\n \n \n Name \n Type \n Default \n description \n \n \n \n \n worker.*dict \n \n NFD worker daemonset configuration \n \n \n worker.configdict \n \n NFD worker configuration \n \n \n worker.podSecurityContextdict \n {} \n SecurityContext holds pod-level security attributes and common container settings \n \n \n worker.securityContextdict \n {} \n Container security settings \n \n \n worker.resourcesdict \n {} \n NFD worker pod resources management \n \n \n worker.nodeSelectordict \n {} \n NFD worker pod node selector \n \n \n worker.tolerationsdict \n {} \n NFD worker pod node tolerations \n \n \n worker.annotationsdict \n {} \n NFD worker pod metadata \n \n \n
\n\nTopology updater parameters \n\n\n \n \n Name \n Type \n Default \n description \n \n \n \n \n topologyUpdater.*dict \n \n NFD Topology Updater configuration \n \n \n topologyUpdater.enablebool \n false \n Specifies whether the NFD Topology Updater should be created \n \n \n topologyUpdater.createCRDsbool \n false \n Specifies whether the NFD Topology Updater CRDs should be created \n \n \n topologyUpdater.serviceAccount.createbool \n true \n Specifies whether the service account for topology updater should be created \n \n \n topologyUpdater.serviceAccount.annotationsdict \n {} \n Annotations to add to the service account for topology updater \n \n \n topologyUpdater.serviceAccount.namestring \n \n The name of the service account for topology updater to use. If not set and create is true, a name is generated using the fullname template and -topology-updater suffix \n \n \n topologyUpdater.rbacdict \n \n RBAC parameteres for the topology updater \n \n \n topologyUpdater.rbac.createbool \n false \n Specifies whether the cluster role and binding for topology updater should be created \n \n \n topologyUpdater.kubeletConfigPathstring \n ”” \n Specifies the kubelet config host path \n \n \n topologyUpdater.kubeletPodResourcesSockPathstring \n ”” \n Specifies the kubelet sock path to read pod resources \n \n \n topologyUpdater.updateIntervalstring \n 60s \n Time to sleep between CR updates. Non-positive value implies no CR update. \n \n \n topologyUpdater.watchNamespacestring \n *Namespace to watch pods, * for all namespaces \n \n \n topologyUpdater.podSecurityContextdict \n {} \n SecurityContext holds pod-level security attributes and common container settings \n \n \n topologyUpdater.securityContextdict \n {} \n Container security settings \n \n \n topologyUpdater.resourcesdict \n {} \n Topology updater pod resources management \n \n \n topologyUpdater.nodeSelectordict \n {} \n Topology updater pod node selector \n \n \n topologyUpdater.tolerationsdict \n {} \n Topology updater pod node tolerations \n \n \n topologyUpdater.annotationsdict \n {} \n Topology updater pod metadata \n \n \n topologyUpdater.affinitydict \n {} \n Topology updater pod affinity \n \n \n
\n\nBuild your own \n\nIf you want to use the latest development version (master branch) you need to\nbuild your own custom image.\nSee the Developer Guide for instructions how to\nbuild images and deploy them on your cluster.
\n\nUsage \n\nNFD-Master \n\nNFD-Master runs as a deployment (with a replica count of 1), by default\nit prefers running on the cluster’s master nodes but will run on worker\nnodes if no master nodes are found.
\n\nFor High Availability, you should simply increase the replica count of\nthe deployment object. You should also look into adding\ninter-pod \naffinity to prevent masters from running on the same node.\nHowever note that inter-pod affinity is costly and is not recommended\nin bigger clusters.
\n\nNFD-Master listens for connections from nfd-worker(s) and connects to the\nKubernetes API server to add node labels advertised by them.
\n\nIf you have RBAC authorization enabled (as is the default e.g. with clusters\ninitialized with kubeadm) you need to configure the appropriate ClusterRoles,\nClusterRoleBindings and a ServiceAccount in order for NFD to create node\nlabels. The provided template will configure these for you.
\n\nNFD-Worker \n\nNFD-Worker is preferably run as a Kubernetes DaemonSet. This assures\nre-labeling on regular intervals capturing changes in the system configuration\nand makes sure that new nodes are labeled as they are added to the cluster.\nWorker connects to the nfd-master service to advertise hardware features.
\n\nWhen run as a daemonset, nodes are re-labeled at an default interval of 60s.\nThis can be changed by using the\ncore.sleepInterval-sleep-interval
\n\nThe worker configuration file is watched and re-read on every change which\nprovides a simple mechanism of dynamic run-time reconfiguration. See\nworker configuration for more details.
\n\nNFD-Topology-Updater \n\nNFD-Topology-Updater is preferably run as a Kubernetes DaemonSet. This assures\nre-examination (and CR updates) on regular intervals capturing changes in\nthe allocated resources and hence the allocatable resources on a per zone\nbasis. It makes sure that more CR instances are created as new nodes get\nadded to the cluster. Topology-Updater connects to the nfd-master service\nto create CR instances corresponding to nodes.
\n\nWhen run as a daemonset, nodes are re-examined for the allocated resources\n(to determine the information of the allocatable resources on a per zone basis\nwhere a zone can be a NUMA node) at an interval specified using the\n-sleep-interval option. The default sleep interval is set to 60s which is the\n the value when no -sleep-interval is specified.
\n\nCommunication security with TLS \n\nNFD supports mutual TLS authentication between the nfd-master and nfd-worker\ninstances. That is, nfd-worker and nfd-master both verify that the other end\npresents a valid certificate.
\n\nTLS authentication is enabled by specifying -ca-file, -key-file and\n-cert-file args, on both the nfd-master and nfd-worker instances.\nThe template specs provided with NFD contain (commented out) example\nconfiguration for enabling TLS authentication.
\n\nThe Common Name (CN) of the nfd-master certificate must match the DNS name of\nthe nfd-master Service of the cluster. By default, nfd-master only check that\nthe nfd-worker has been signed by the specified root certificate (-ca-file).\nAdditional hardening can be enabled by specifying -verify-node-name in\nnfd-master args, in which case nfd-master verifies that the NodeName presented\nby nfd-worker matches the Common Name (CN) or a Subject Alternative Name (SAN)\nof its certificate.
\n\nAutomated TLS certificate management using cert-manager \n\ncert-manager can be used to automate certificate\nmanagement between nfd-master and the nfd-worker pods.
\n\nNFD source code repository contains an example kustomize overlay that can be\nused to deploy NFD with cert-manager supplied certificates enabled. The\ninstructions below describe steps how to generate a self-signed CA certificate\nand set up cert-manager’s\nCA Issuer to sign\nCertificate requests for NFD components in node-feature-discovery\nnamespace.
\n\nkubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.5.1/cert-manager.yaml\nopenssl genrsa -out deployment/overlays/samples/cert-manager/tls.key 2048\nopenssl req -x509 -new -nodes -key deployment/overlays/samples/cert-manager/tls.key -subj \"/CN=nfd-ca\" \\ \n -days 10000 -out deployment/overlays/samples/cert-manager/tls.crt\nkubectl apply -k deployment/overlays/samples/cert-manager\nWorker configuration \n\nNFD-Worker supports dynamic configuration through a configuration file. The\ndefault location is /etc/kubernetes/node-feature-discovery/nfd-worker.conf,\nbut, this can be changed by specifying the-config command line flag.\nConfiguration file is re-read whenever it is modified which makes run-time\nre-configuration of nfd-worker straightforward.
\n\nWorker configuration file is read inside the container, and thus, Volumes and\nVolumeMounts are needed to make your configuration available for NFD. The\npreferred method is to use a ConfigMap which provides easy deployment and\nre-configurability.
\n\nThe provided nfd-worker deployment templates create an empty configmap and\nmount it inside the nfd-worker containers. In kustomize deployments,\nconfiguration can be edited with:
\n\nkubectl -n ${ NFD_NS } edit configmap nfd-worker-conf\nIn Helm deployments, Worker pod parameter \nworker.config can be used to edit the respective configuration.
\n\nSee\nnfd-worker configuration file reference \nfor more details.\nThe (empty-by-default)\nexample config \ncontains all available configuration options and can be used as a reference\nfor creating creating a configuration.
\n\nConfiguration options can also be specified via the -options command line\nflag, in which case no mounts need to be used. The same format as in the config\nfile must be used, i.e. JSON (or YAML). For example:
\n\n-options = '{\"sources\": { \"pci\": { \"deviceClassWhitelist\": [\"12\"] } } }' \nConfiguration options specified from the command line will override those read\nfrom the config file.
\n\nUsing node labels \n\nNodes with specific features can be targeted using the nodeSelector field. The\nfollowing example shows how to target nodes with Intel TurboBoost enabled.
\n\napiVersion : v1 \nkind : Pod \nmetadata : \n labels : \n env : test \n name : golang-test \nspec : \n containers : \n - image : golang \n name : go1 \n nodeSelector : \n feature.node.kubernetes.io/cpu-pstate.turbo : ' true' \nFor more details on targeting nodes, see\nnode selection .
\n\nUninstallation \n\nOperator was used for deployment \n\nIf you followed the deployment instructions above you can simply do:
\n\nkubectl -n nfd delete NodeFeatureDiscovery my-nfd-deployment\nOptionally, you can also remove the namespace:
\n\n\n\nSee the node-feature-discovery-operator and OLM project\ndocumentation for instructions for uninstalling the operator and operator\nlifecycle manager, respectively.
\n\nManual \n\nSimplest way is to invoke kubectl delete on the deployment files you used.\nBeware that this will also delete the namespace that NFD is running in. For\nexample, in case the default deployment from the repo was used:
\n\n\nkubectl delete -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref= master\nAlternatively you can delete create objects one-by-one, depending on the type\nof deployment, for example:
\n\nNFD_NS = node-feature-discovery\nkubectl -n $NFD_NS delete ds nfd-worker\nkubectl -n $NFD_NS delete deploy nfd-master\nkubectl -n $NFD_NS delete svc nfd-master\nkubectl -n $NFD_NS delete sa nfd-master\nkubectl delete clusterrole nfd-master\nkubectl delete clusterrolebinding nfd-master\nRemoving feature labels \n\nNFD-Master has a special -prune command line flag for removing all\nnfd-related node labels, annotations and extended resources from the cluster.
\n\nkubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prune?ref= master\nkubectl -n node-feature-discovery wait job.batch/nfd-prune --for = condition = complete && \\ \n kubectl delete -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prune?ref= master\nNOTE: You must run prune before removing the RBAC rules (serviceaccount,\nclusterrole and clusterrolebinding).
\n\n\n","dir":"/get-started/","name":"deployment-and-usage.md","path":"get-started/deployment-and-usage.md","url":"/get-started/deployment-and-usage.html"},{"title":"Worker config reference","layout":"default","sort":4,"content":"Configuration file reference of nfd-worker \n\nTable of contents \n\n\n core \n core.sleepInterval core.sources core.labelWhiteList core.noPublish core.klog \n sources \n sources.cpu sources.kernel soures.pci sources.usb sources.custom \n \n\nSee the\nsample configuration file \nfor a full example configuration.
\n\ncore \n\nThe core section contains common configuration settings that are not specific\nto any particular feature source.
\n\ncore.sleepInterval \n\ncore.sleepInterval specifies the interval between consecutive passes of\nfeature (re-)detection, and thus also the interval between node re-labeling. A\nnon-positive value implies infinite sleep interval, i.e. no re-detection or\nre-labeling is done.
\n\nNote: Overridden by the deprecated -sleep-interval command line flag (if\nspecified).
\n\nDefault: 60s
\n\nExample:
\n\ncore : \n sleepInterval : 60s \ncore.sources \n\ncore.sources specifies the list of enabled feature sources. A special value\nall enables all feature sources.
\n\nNote: Overridden by the deprecated -sources command line flag (if\nspecified).
\n\nDefault: [all]
\n\nExample:
\n\ncore : \n sources : \n - system \n - custom \ncore.labelWhiteList \n\ncore.labelWhiteList specifies a regular expression for filtering feature\nlabels based on the label name. Non-matching labels are not published.
\n\nNote: The regular expression is only matches against the “basename” part of the\nlabel, i.e. to the part of the name after ‘/’. The label prefix (or namespace)\nis omitted.
\n\nNote: Overridden by the deprecated -label-whitelist command line flag (if\nspecified).
\n\nDefault: null
\n\nExample:
\n\ncore : \n labelWhiteList : ' ^cpu-cpuid' \ncore.noPublish \n\nSetting core.noPublish to true disables all communication with the\nnfd-master. It is effectively a “dry-run” flag: nfd-worker runs feature\ndetection normally, but no labeling requests are sent to nfd-master.
\n\nNote: Overridden by the -no-publish command line flag (if specified).
\n\nDefault: false
\n\nExample:
\n\ncore : \n noPublish : true \ncore.klog \n\nThe following options specify the logger configuration. Most of which can be\ndynamically adjusted at run-time.
\n\nNote: The logger options can also be specified via command line flags which\ntake precedence over any corresponding config file options.
\n\n\n\nIf true, adds the file directory to the header of the log messages.
\n\nDefault: false
\n\nRun-time configurable: yes
\n\ncore.klog.alsologtostderr \n\nLog to standard error as well as files.
\n\nDefault: false
\n\nRun-time configurable: yes
\n\ncore.klog.logBacktraceAt \n\nWhen logging hits line file:N, emit a stack trace.
\n\nDefault: empty
\n\nRun-time configurable: yes
\n\ncore.klog.logDir \n\nIf non-empty, write log files in this directory.
\n\nDefault: empty
\n\nRun-time configurable: no
\n\ncore.klog.logFile \n\nIf non-empty, use this log file.
\n\nDefault: empty
\n\nRun-time configurable: no
\n\ncore.klog.logFileMaxSize \n\nDefines the maximum size a log file can grow to. Unit is megabytes. If the\nvalue is 0, the maximum file size is unlimited.
\n\nDefault: 1800
\n\nRun-time configurable: no
\n\ncore.klog.logtostderr \n\nLog to standard error instead of files
\n\nDefault: true
\n\nRun-time configurable: yes
\n\n\n\nIf true, avoid header prefixes in the log messages.
\n\nDefault: false
\n\nRun-time configurable: yes
\n\n\n\nIf true, avoid headers when opening log files.
\n\nDefault: false
\n\nRun-time configurable: no
\n\ncore.klog.stderrthreshold \n\nLogs at or above this threshold go to stderr (default 2)
\n\nRun-time configurable: yes
\n\ncore.klog.v \n\nNumber for the log level verbosity.
\n\nDefault: 0
\n\nRun-time configurable: yes
\n\ncore.klog.vmodule \n\nComma-separated list of pattern=N settings for file-filtered logging.
\n\nDefault: empty
\n\nRun-time configurable: yes
\n\nsources \n\nThe sources section contains feature source specific configuration parameters.
\n\nsources.cpu \n\nsources.cpu.cpuid \n\nsources.cpu.cpuid.attributeBlacklist \n\nPrevent publishing cpuid features listed in this option.
\n\nNote: overridden by sources.cpu.cpuid.attributeWhitelist (if specified)
\n\nDefault: [BMI1, BMI2, CLMUL, CMOV, CX16, ERMS, F16C, HTT, LZCNT, MMX, MMXEXT,\nNX, POPCNT, RDRAND, RDSEED, RDTSCP, SGX, SGXLC, SSE, SSE2, SSE3, SSE4.1,\nSSE4.2, SSSE3]
\n\nExample:
\n\nsources : \n cpu : \n cpuid : \n attributeBlacklist : [ MMX , MMXEXT ] \nsources.cpu.cpuid.attributeWhitelist \n\nOnly publish the cpuid features listed in this option.
\n\nNote: takes precedence over sources.cpu.cpuid.attributeBlacklist
\n\nDefault: empty
\n\nExample:
\n\nsources : \n cpu : \n cpuid : \n attributeWhitelist : [ AVX512BW , AVX512CD , AVX512DQ , AVX512F , AVX512VL ] \nsources.kernel \n\nsources.kernel.kconfigFile \n\nPath of the kernel config file. If empty, NFD runs a search in the well-known\nstandard locations.
\n\nDefault: empty
\n\nExample:
\n\nsources : \n kernel : \n kconfigFile : \" /path/to/kconfig\" \nsources.kernel.configOpts \n\nKernel configuration options to publish as feature labels.
\n\nDefault: [NO_HZ, NO_HZ_IDLE, NO_HZ_FULL, PREEMPT]
\n\nExample:
\n\nsources : \n kernel : \n configOpts : [ NO_HZ , X86 , DMI ] \nsoures.pci \n\nsoures.pci.deviceClassWhitelist \n\nList of PCI device class IDs for which to\npublish a label. Can be specified as a main class only (e.g. 03) or full\nclass-subclass combination (e.g. 0300) - the former implies that all\nsubclasses are accepted. The format of the labels can be further configured\nwith deviceLabelFields .
\n\nDefault: [\"03\", \"0b40\", \"12\"]
\n\nExample:
\n\nsources : \n pci : \n deviceClassWhitelist : [ \" 0200\" , \" 03\" ] \nsoures.pci.deviceLabelFields \n\nThe set of PCI ID fields to use when constructing the name of the feature\nlabel. Valid fields are class, vendor, device, subsystem_vendor and\nsubsystem_device.
\n\nDefault: [class, vendor]
\n\nExample:
\n\nsources : \n pci : \n deviceLabelFields : [ class , vendor , device ] \nWith the example config above NFD would publish labels like:\nfeature.node.kubernetes.io/pci-<class-id>_<vendor-id>_<device-id>.present=true
\n\nsources.usb \n\nsoures.usb.deviceClassWhitelist \n\nList of USB device class IDs for\nwhich to publish a feature label. The format of the labels can be further\nconfigured with deviceLabelFields .
\n\nDefault: [\"0e\", \"ef\", \"fe\", \"ff\"]
\n\nExample:
\n\nsources : \n usb : \n deviceClassWhitelist : [ \" ef\" , \" ff\" ] \nsoures.usb.deviceLabelFields \n\nThe set of USB ID fields from which to compose the name of the feature label.\nValid fields are class, vendor, device and serial.
\n\nDefault: [class, vendor, device]
\n\nExample:
\n\nsources : \n pci : \n deviceLabelFields : [ class , vendor ] \nWith the example config above NFD would publish labels like:\nfeature.node.kubernetes.io/usb-<class-id>_<vendor-id>.present=true
\n\nsources.custom \n\nList of rules to process in the custom feature source to create user-specific\nlabels. Refer to the documentation of the\ncustom feature source for details of\nthe available rules and their configuration.
\n\nDefault: empty
\n\nExample:
\n\nsource : \n custom : \n - name : \" my.custom.feature\" \n matchOn : \n - loadedKMod : [ \" e1000e\" ] \n - pciId : \n class : [ \" 0200\" ] \n vendor : [ \" 8086\" ] \nExamples and demos \n\nTable of contents \n\n\n Demos \n Usage demo Demo use case \n \n\nThis page contains usage examples and demos.
\n\nDemos \n\nUsage demo \n\n
\n\nDemo use case \n\nA demo on the benefits of using node feature discovery can be found in the\nsource code repository under\ndemo/ .
\n","dir":"/get-started/","name":"examples-and-demos.md","path":"get-started/examples-and-demos.md","url":"/get-started/examples-and-demos.html"},{"title":"Topology Updater Cmdline Reference","layout":"default","sort":5,"content":"NFD-Topology-Updater Commandline Flags \n\nTable of Contents \n\n\n NFD-Topology-Updater Commandline Flags \n -h, -help -version -server -ca-file -cert-file -key-file -server-name-override -no-publish -oneshot -sleep-interval -watch-namespace -kubelet-config-file -podresources-socket \n \n\nTo quickly view available command line flags execute nfd-topology-updater -help.\nIn a docker container:
\n\ndocker run gcr.io/k8s-staging-nfd/node-feature-discovery:master nfd-topology-updater -help \n-h, -help \n\nPrint usage and exit.
\n\n-version \n\nPrint version and exit.
\n\n-server \n\nThe -server flag specifies the address of the nfd-master endpoint where to\nconnect to.
\n\nDefault: localhost:8080
\n\nExample:
\n\nnfd-topology-updater -server = nfd-master.nfd.svc.cluster.local:443\n-ca-file \n\nThe -ca-file is one of the three flags (together with -cert-file and\n-key-file) controlling the mutual TLS authentication on the topology-updater side.\nThis flag specifies the TLS root certificate that is used for verifying the\nauthenticity of nfd-master.
\n\nDefault: empty
\n\nNote: Must be specified together with -cert-file and -key-file
\n\nExample:
\n\nnfd-topology-updater -ca-file = /opt/nfd/ca.crt -cert-file = /opt/nfd/updater.crt -key-file = /opt/nfd/updater.key\n-cert-file \n\nThe -cert-file is one of the three flags (together with -ca-file and\n-key-file) controlling mutual TLS authentication on the topology-updater\nside. This flag specifies the TLS certificate presented for authenticating\noutgoing requests.
\n\nDefault: empty
\n\nNote: Must be specified together with -ca-file and -key-file
\n\nExample:
\n\nnfd-topology-updater -cert-file = /opt/nfd/updater.crt -key-file = /opt/nfd/updater.key -ca-file = /opt/nfd/ca.crt\n-key-file \n\nThe -key-file is one of the three flags (together with -ca-file and\n-cert-file) controlling the mutual TLS authentication on topology-updater\nside. This flag specifies the private key corresponding the given certificate file\n(-cert-file) that is used for authenticating outgoing requests.
\n\nDefault: empty
\n\nNote: Must be specified together with -cert-file and -ca-file
\n\nExample:
\n\nnfd-topology-updater -key-file = /opt/nfd/updater.key -cert-file = /opt/nfd/updater.crt -ca-file = /opt/nfd/ca.crt\n-server-name-override \n\nThe -server-name-override flag specifies the common name (CN) which to\nexpect from the nfd-master TLS certificate. This flag is mostly intended for\ndevelopment and debugging purposes.
\n\nDefault: empty
\n\nExample:
\n\nnfd-topology-updater -server-name-override = localhost\n-no-publish \n\nThe -no-publish flag disables all communication with the nfd-master, making\nit a “dry-run” flag for nfd-topology-updater. NFD-Topology-Updater runs\nresource hardware topology detection normally, but no CR requests are sent to\nnfd-master.
\n\nDefault: false
\n\nExample:
\n\nnfd-topology-updater -no-publish \n-oneshot \n\nThe -oneshot flag causes nfd-topology-updater to exit after one pass of\nresource hardware topology detection.
\n\nDefault: false
\n\nExample:
\n\nnfd-topology-updater -oneshot -no-publish \n-sleep-interval \n\nThe -sleep-interval specifies the interval between resource hardware\ntopology re-examination (and CR updates). A non-positive value implies\ninfinite sleep interval, i.e. no re-detection is done.
\n\nDefault: 60s
\n\nExample:
\n\nnfd-topology-updater -sleep-interval = 1h\n-watch-namespace \n\nThe -watch-namespace specifies the namespace to ensure that resource\nhardware topology examination only happens for the pods running in the\nspecified namespace. Pods that are not running in the specified namespace\nare not considered during resource accounting. This is particularly useful\nfor testing/debugging purpose. A “*” value would mean that all the pods would\nbe considered during the accounting process.
\n\nDefault: “*”
\n\nExample:
\n\nnfd-topology-updater -watch-namespace = rte\n-kubelet-config-file \n\nThe -kubelet-config-file specifies the path to the Kubelet’s configuration\nfile.
\n\nDefault: /host-var/lib/kubelet/config.yaml
\n\nExample:
\n\nnfd-topology-updater -kubelet-config-file = /var/lib/kubelet/config.yaml\n-podresources-socket \n\nThe -podresources-socket specifies the path to the Unix socket where kubelet\nexports a gRPC service to enable discovery of in-use CPUs and devices, and to\nprovide metadata for them.
\n\nDefault: /host-var/lib/kubelet/pod-resources/kubelet.sock
\n\nExample:
\n\nnfd-topology-updater -podresources-socket = /var/lib/kubelet/pod-resources/kubelet.sock\n/-[.]\n```\n\nThe last component (i.e. `attribute-name`) is optional, and only used if a\nfeature logically has sub-hierarchy, e.g. `sriov.capable` and\n`sriov.configure` from the `network` source.\n\nThe `-label-sources` flag controls which sources to enable for label\ngeneration.\n\n*Note: Consecutive runs of nfd-worker will update the labels on a\ngiven node. If features are not discovered on a consecutive run, the corresponding\nlabel will be removed. This includes any restrictions placed on the consecutive run,\nsuch as restricting discovered features with the -label-whitelist option.*\n\n## Feature sources\n\n### CPU\n\nThe **cpu** feature source supports the following labels:\n\n| Feature name | Attribute | Description |\n| ----------------------- | ------------------ | ----------------------------- |\n| cpuid | <cpuid flag> | CPU capability is supported\n| hardware_multithreading | | Hardware multithreading, such as Intel HTT, enabled (number of logical CPUs is greater than physical CPUs)\n| power | sst_bf.enabled | Intel SST-BF ([Intel Speed Select Technology][intel-sst] - Base frequency) enabled\n| [pstate][intel-pstate] | status | The status of the Intel pstate driver when in use and enabled, either 'active' or 'passive'.\n| | turbo | Set to 'true' if turbo frequencies are enabled in Intel pstate driver, set to 'false' if they have been disabled.\n| | scaling_governor | The value of the Intel pstate scaling_governor when in use, either 'powersave' or 'performance'.\n| cstate | enabled | 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.\n| [rdt][intel-rdt] | RDTMON | Intel RDT Monitoring Technology\n| | RDTCMT | Intel Cache Monitoring (CMT)\n| | RDTMBM | Intel Memory Bandwidth Monitoring (MBM)\n| | RDTL3CA | Intel L3 Cache Allocation Technology\n| | RDTL2CA | Intel L2 Cache Allocation Technology\n| | RDTMBA | Intel Memory Bandwidth Allocation (MBA) Technology\n| sgx | enabled | Set to 'true' if Intel SGX is enabled in BIOS (based a non-zero sum value of SGX EPC section sizes).\n\nThe (sub-)set of CPUID attributes to publish is configurable via the\n`attributeBlacklist` and `attributeWhitelist` cpuid options of the cpu source.\nIf whitelist is specified, only whitelisted attributes will be published. With\nblacklist, only blacklisted attributes are filtered out. `attributeWhitelist`\nhas priority over `attributeBlacklist`. For examples and more information\nabout configurability, see\n[configuration](deployment-and-usage#worker-configuration).\nBy default, the following CPUID flags have been blacklisted:\nBMI1, BMI2, CLMUL, CMOV, CX16, ERMS, F16C, HTT, LZCNT, MMX, MMXEXT, NX, POPCNT,\nRDRAND, RDSEED, RDTSCP, SGX, SSE, SSE2, SSE3, SSE4, SSE42 and SSSE3.\n\n**NOTE** The cpuid features advertise *supported* CPU capabilities, that is, a\ncapability might be supported but not enabled.\n\n#### X86 CPUID attributes (partial list)\n\n| Attribute | Description |\n| --------- | ---------------------------------------------------------------- |\n| ADX | Multi-Precision Add-Carry Instruction Extensions (ADX)\n| AESNI | Advanced Encryption Standard (AES) New Instructions (AES-NI)\n| AVX | Advanced Vector Extensions (AVX)\n| AVX2 | Advanced Vector Extensions 2 (AVX2)\n\nSee the full list in [github.com/klauspost/cpuid][klauspost-cpuid].\n\n#### Arm CPUID attribute (partial list)\n\n| Attribute | Description |\n| --------- | ---------------------------------------------------------------- |\n| IDIVA | Integer divide instructions available in ARM mode\n| IDIVT | Integer divide instructions available in Thumb mode\n| THUMB | Thumb instructions\n| FASTMUL | Fast multiplication\n| VFP | Vector floating point instruction extension (VFP)\n| VFPv3 | Vector floating point extension v3\n| VFPv4 | Vector floating point extension v4\n| VFPD32 | VFP with 32 D-registers\n| HALF | Half-word loads and stores\n| EDSP | DSP extensions\n| NEON | NEON SIMD instructions\n| LPAE | Large Physical Address Extensions\n\n#### Arm64 CPUID attribute (partial list)\n\n| Attribute | Description |\n| --------- | ---------------------------------------------------------------- |\n| AES | Announcing the Advanced Encryption Standard\n| EVSTRM | Event Stream Frequency Features\n| FPHP | Half Precision(16bit) Floating Point Data Processing Instructions\n| ASIMDHP | Half Precision(16bit) Asimd Data Processing Instructions\n| ATOMICS | Atomic Instructions to the A64\n| ASIMRDM | Support for Rounding Double Multiply Add/Subtract\n| PMULL | Optional Cryptographic and CRC32 Instructions\n| JSCVT | Perform Conversion to Match Javascript\n| DCPOP | Persistent Memory Support\n\n### Custom\n\nThe Custom feature source allows the user to define features based on a mix of\npredefined rules. A rule is provided input witch affects its process of\nmatching for a defined feature. The rules are specified in the\nnfd-worker configuration file. See\n[configuration](/node-feature-discovery/master/get-started/deployment-and-usage.html#worker-configuration) for instructions\nand examples how to set-up and manage the worker configuration.\n\nTo aid in making Custom Features clearer, we define a general and a per rule\nnomenclature, keeping things as consistent as possible.\n\n#### Additional configuration directory\n\nAdditionally to the rules defined in the nfd-worker configuration file, the\nCustom feature can read more configuration files located in the\n`/etc/kubernetes/node-feature-discovery/custom.d/` directory. This makes more\ndynamic and flexible configuration easier. This directory must be available\ninside the NFD worker container, so Volumes and VolumeMounts must be used for\nmounting e.g. ConfigMap(s). The example deployment manifests provide an example\n(commented out) for providing Custom configuration with an additional\nConfigMap, mounted into the `custom.d` directory.\n\n#### General nomenclature & definitions\n\n```plaintext\nRule :Represents a matching logic that is used to match on a feature.\nRule Input :The input a Rule is provided. This determines how a Rule performs the match operation.\nMatcher :A composition of Rules, each Matcher may be composed of at most one instance of each Rule.\n```\n\n#### Custom features format (using the nomenclature defined above)\n\nRules are specified under `sources.custom` in the nfd-worker configuration\nfile.\n\n```yaml\nsources:\n custom:\n - name: \n value: \n matchOn:\n - : \n [: ]\n - \n - ...\n - ...\n - \n - \n - ...\n - ...\n - \n```\n\n#### Matching process\n\nSpecifying Rules to match on a feature is done by providing a list of Matchers.\nEach Matcher contains one or more Rules.\n\nLogical _OR_ is performed between Matchers and logical _AND_ is performed\nbetween Rules of a given Matcher.\n\n#### Rules\n\n##### pciid rule\n\n###### Nomenclature\n\n```plaintext\nAttribute :A PCI attribute.\nElement :An identifier of the PCI attribute.\n```\n\nThe PciId Rule allows matching the PCI devices in the system on the following\nAttributes: `class`,`vendor` and `device`. A list of Elements is provided for\neach Attribute.\n\n###### Format\n\n```yaml\npciId :\n class: [, ...]\n vendor: [, ...]\n device: [, ...]\n```\n\nMatching is done by performing a logical _OR_ between Elements of an Attribute\nand logical _AND_ between the specified Attributes for each PCI device in the\nsystem. At least one Attribute must be specified. Missing attributes will not\npartake in the matching process.\n\n##### UsbId rule\n\n###### Nomenclature\n\n```plaintext\nAttribute :A USB attribute.\nElement :An identifier of the USB attribute.\n```\n\nThe UsbId Rule allows matching the USB devices in the system on the following\nAttributes: `class`,`vendor`, `device` and `serial`. A list of Elements is\nprovided for each Attribute.\n\n###### Format\n\n```yaml\nusbId :\n class: [, ...]\n vendor: [, ...]\n device: [, ...]\n serial: [, ...]\n```\n\nMatching is done by performing a logical _OR_ between Elements of an Attribute\nand logical _AND_ between the specified Attributes for each USB device in the\nsystem. At least one Attribute must be specified. Missing attributes will not\npartake in the matching process.\n\n##### LoadedKMod rule\n\n###### Nomenclature\n\n```plaintext\nElement :A kernel module\n```\n\nThe LoadedKMod Rule allows matching the loaded kernel modules in the system\nagainst a provided list of Elements.\n\n###### Format\n\n```yaml\nloadedKMod : [, ...]\n```\n\nMatching is done by performing logical _AND_ for each provided Element, i.e\nthe Rule will match if all provided Elements (kernel modules) are loaded in the\nsystem.\n\n##### CpuId rule\n\n###### Nomenclature\n\n```plaintext\nElement :A CPUID flag\n```\n\nThe Rule allows matching the available CPUID flags in the system against a\nprovided list of Elements.\n\n###### Format\n\n```yaml\ncpuId : [, ...]\n```\n\nMatching is done by performing logical _AND_ for each provided Element, i.e the\nRule will match if all provided Elements (CPUID flag strings) are available in\nthe system.\n\n##### Kconfig rule\n\n###### Nomenclature\n\n```plaintext\nElement :A Kconfig option\n```\n\nThe Rule allows matching the kconfig options in the system against a provided\nlist of Elements.\n\n###### Format\n\n```yaml\nkConfig: ['>, ...]\n```\n\nMatching is done by performing logical _AND_ for each provided Element, i.e the\nRule will match if all provided Elements (kernel config options) are enabled\n(`y` or `m`) or matching `=` in the kernel.\n\n##### Nodename rule\n\n###### Nomenclature\n\n```plaintext\nElement :A nodename regexp pattern\n```\n\nThe Rule allows matching the node's name against a provided list of Elements.\n\n###### Format\n\n```yaml\nnodename: [ , ... ]\n```\n\nMatching is done by performing logical _OR_ for each provided Element, i.e the\nRule will match if one of the provided Elements (nodename regexp pattern)\nmatches the node's name.\n\n#### Example\n\n```yaml\ncustom:\n - name: \"my.kernel.feature\"\n matchOn:\n - loadedKMod: [\"kmod1\", \"kmod2\"]\n - name: \"my.pci.feature\"\n matchOn:\n - pciId:\n vendor: [\"15b3\"]\n device: [\"1014\", \"1017\"]\n - name: \"my.usb.feature\"\n matchOn:\n - usbId:\n vendor: [\"1d6b\"]\n device: [\"0003\"]\n serial: [\"090129a\"]\n - name: \"my.combined.feature\"\n matchOn:\n - loadedKMod : [\"vendor_kmod1\", \"vendor_kmod2\"]\n pciId:\n vendor: [\"15b3\"]\n device: [\"1014\", \"1017\"]\n - name: \"vendor.feature.node.kubernetes.io/accumulated.feature\"\n matchOn:\n - loadedKMod : [\"some_kmod1\", \"some_kmod2\"]\n - pciId:\n vendor: [\"15b3\"]\n device: [\"1014\", \"1017\"]\n - name: \"my.kernel.featureneedscpu\"\n matchOn:\n - kConfig: [\"KVM_INTEL\"]\n - cpuId: [\"VMX\"]\n - name: \"my.kernel.modulecompiler\"\n matchOn:\n - kConfig: [\"GCC_VERSION=100101\"]\n loadedKMod: [\"kmod1\"]\n - name: \"profile.node.kubernetes.io/my-datacenter\"\n value: \"datacenter-1\"\n matchOn:\n - nodename: [ \"node-datacenter1-rack.*-server.*\" ]\n```\n\n__In the example above:__\n\n- A node would contain the label:\n `feature.node.kubernetes.io/custom-my.kernel.feature=true` if the node has\n `kmod1` _AND_ `kmod2` kernel modules loaded.\n- A node would contain the label:\n `feature.node.kubernetes.io/custom-my.pci.feature=true` if the node contains\n a PCI device with a PCI vendor ID of `15b3` _AND_ PCI device ID of `1014` _OR_\n `1017`.\n- A node would contain the label:\n `feature.node.kubernetes.io/custom-my.usb.feature=true` if the node contains\n a USB device with a USB vendor ID of `1d6b` _AND_ USB device ID of `0003`.\n- A node would contain the label:\n `feature.node.kubernetes.io/custom-my.combined.feature=true` if\n `vendor_kmod1` _AND_ `vendor_kmod2` kernel modules are loaded __AND__ the node\n contains a PCI device\n with a PCI vendor ID of `15b3` _AND_ PCI device ID of `1014` _or_ `1017`.\n- A node would contain the label:\n `vendor.feature.node.kubernetes.io/accumulated.feature=true` if\n `some_kmod1` _AND_ `some_kmod2` kernel modules are loaded __OR__ the node\n contains a PCI device\n with a PCI vendor ID of `15b3` _AND_ PCI device ID of `1014` _OR_ `1017`.\n- A node would contain the label:\n `feature.node.kubernetes.io/custom-my.kernel.featureneedscpu=true` if\n `KVM_INTEL` kernel config is enabled __AND__ the node CPU supports `VMX`\n virtual machine extensions\n- A node would contain the label:\n `feature.node.kubernetes.io/custom-my.kernel.modulecompiler=true` if the\n in-tree `kmod1` kernel module is loaded __AND__ it's built with\n `GCC_VERSION=100101`.\n- A node would contain the label:\n `profile.node.kubernetes.io/my-datacenter=datacenter-1` if the node's name\n matches the `node-datacenter1-rack.*-server.*` pattern, e.g.\n `node-datacenter1-rack2-server42`\n\n#### Statically defined features\n\nSome feature labels which are common and generic are defined statically in the\n`custom` feature source. A user may add additional Matchers to these feature\nlabels by defining them in the `nfd-worker` configuration file.\n\n| Feature | Attribute | Description |\n| ------- | --------- | -----------|\n| rdma | capable | The node has an RDMA capable Network adapter |\n| rdma | enabled | The node has the needed RDMA modules loaded to run RDMA traffic |\n\n### IOMMU\n\nThe **iommu** feature source supports the following labels:\n\n| Feature name | Description |\n| :------------: | :---------------------------------------------------------: |\n| enabled | IOMMU is present and enabled in the kernel\n\n### Kernel\n\nThe **kernel** feature source supports the following labels:\n\n| Feature | Attribute | Description |\n| ------- | ------------------- | -------------------------------------------- |\n| config | <option name> | Kernel config option is enabled (set 'y' or 'm'). Default options are `NO_HZ`, `NO_HZ_IDLE`, `NO_HZ_FULL` and `PREEMPT`\n| selinux | enabled | Selinux is enabled on the node\n| version | full | Full kernel version as reported by `/proc/sys/kernel/osrelease` (e.g. '4.5.6-7-g123abcde')\n| | major | First component of the kernel version (e.g. '4')\n| | minor | Second component of the kernel version (e.g. '5')\n| | revision | Third component of the kernel version (e.g. '6')\n\nKernel config file to use, and, the set of config options to be detected are\nconfigurable. See [configuration](deployment-and-usage#worker-configuration)\nfor more information.\n\n### Memory\n\nThe **memory** feature source supports the following labels:\n\n| Feature | Attribute | Description |\n| ------- | --------- | ------------------------------------------------------ |\n| numa | | Multiple memory nodes i.e. NUMA architecture detected\n| nv | present | NVDIMM device(s) are present\n| nv | dax | NVDIMM region(s) configured in DAX mode are present\n\n### Network\n\nThe **network** feature source supports the following labels:\n\n| Feature | Attribute | Description |\n| ------- | ---------- | ----------------------------------------------------- |\n| sriov | capable | [Single Root Input/Output Virtualization][sriov] (SR-IOV) enabled Network Interface Card(s) present\n| | configured | SR-IOV virtual functions have been configured\n\n### PCI\n\nThe **pci** feature source supports the following labels:\n\n| Feature | Attribute | Description |\n| -------------------- | ------------- | ------------------------------------- |\n| <device label> | present | PCI device is detected\n| <device label> | sriov.capable | [Single Root Input/Output Virtualization][sriov] (SR-IOV) enabled PCI device present\n\n`` is composed of raw PCI IDs, separated by underscores. The set\nof fields used in `` is configurable, valid fields being `class`,\n`vendor`, `device`, `subsystem_vendor` and `subsystem_device`. Defaults are\n`class` and `vendor`. An example label using the default label fields:\n\n```plaintext\nfeature.node.kubernetes.io/pci-1200_8086.present=true\n```\n\nAlso the set of PCI device classes that the feature source detects is\nconfigurable. By default, device classes (0x)03, (0x)0b40 and (0x)12, i.e.\nGPUs, co-processors and accelerator cards are detected.\n\n### USB\n\nThe **usb** feature source supports the following labels:\n\n| Feature | Attribute | Description |\n| -------------------- | ------------- | ------------------------------------- |\n| <device label> | present | USB device is detected\n\n`` is composed of raw USB IDs, separated by underscores. The set\nof fields used in `` is configurable, valid fields being `class`,\n`vendor`, `device` and `serial`. Defaults are `class`, `vendor` and `device`.\nAn example label using the default label fields:\n\n```plaintext\nfeature.node.kubernetes.io/usb-fe_1a6e_089a.present=true\n```\n\nSee [configuration](deployment-and-usage#worker-configuration) for more\ninformation on NFD config.\n\n### Storage\n\nThe **storage** feature source supports the following labels:\n\n| Feature name | Description |\n| ------------------ | ------------------------------------------------------- |\n| nonrotationaldisk | Non-rotational disk, like SSD, is present in the node\n\n### System\n\nThe **system** feature source supports the following labels:\n\n| Feature | Attribute | Description |\n| ----------- | ---------------- | --------------------------------------------|\n| os_release | ID | Operating system identifier\n| | VERSION_ID | Operating system version identifier (e.g. '6.7')\n| | VERSION_ID.major | First component of the OS version id (e.g. '6')\n| | VERSION_ID.minor | Second component of the OS version id (e.g. '7')\n\n### Local -- user-specific features\n\nNFD has a special feature source named *local* which is designed for getting\nthe labels from user-specific feature detector. It provides a mechanism for\nusers to implement custom feature sources in a pluggable way, without modifying\nnfd source code or Docker images. The local feature source can be used to\nadvertise new user-specific features, and, for overriding labels created by the\nother feature sources.\n\nThe *local* feature source gets its labels by two different ways:\n\n- It tries to execute files found under\n `/etc/kubernetes/node-feature-discovery/source.d/` directory. The hook files\n must be executable and they are supposed to print all discovered features in\n `stdout`, one per line. With ELF binaries static linking is recommended as\n the selection of system libraries available in the NFD release image is very\n limited. Other runtimes currently supported by the NFD stock image are bash\n and perl.\n- It reads files found under\n `/etc/kubernetes/node-feature-discovery/features.d/` directory. The file\n content is expected to be similar to the hook output (described above).\n\n**NOTE:** The [minimal](deployment-and-usage#minimal) image variant only\nsupports running statically linked binaries.\n\nThese directories must be available inside the Docker image so Volumes and\nVolumeMounts must be used if standard NFD images are used. The given template\nfiles mount by default the `source.d` and the `features.d` directories\nrespectively from `/etc/kubernetes/node-feature-discovery/source.d/` and\n`/etc/kubernetes/node-feature-discovery/features.d/` from the host. You should\nupdate them to match your needs.\n\nIn both cases, the labels can be binary or non binary, using either `` or\n`=` format.\n\nUnlike the other feature sources, the name of the file, instead of the name of\nthe feature source (that would be `local` in this case), is used as a prefix in\nthe label name, normally. However, if the `` of the label starts with a\nslash (`/`) it is used as the label name as is, without any additional prefix.\nThis makes it possible for the user to fully control the feature label names,\ne.g. for overriding labels created by other feature sources.\n\nYou can also override the default namespace of your labels using this format:\n`/[=]`. If using something else than\n`[.]feature.node.kubernetes.io` or\n`[.]profile.node.kubernetes.io`, you must whitelist your namespace\nusing the `-extra-label-ns` option on the master.\nIn this case, the name of the\nfile will not be added to the label name. For example, if you want to add the\nlabel `my.namespace.org/my-label=value`, your hook output or file must contains\n`my.namespace.org/my-label=value` and you must add\n`-extra-label-ns=my.namespace.org` on the master command line.\n\n`stderr` output of the hooks is propagated to NFD log so it can be used for\ndebugging and logging.\n\n#### Injecting labels from other pods\n\nOne use case for the hooks and/or feature files is detecting features in other\nPods outside NFD, e.g. in Kubernetes device plugins. It is possible to mount\nthe `source.d` and/or `features.d` directories common with the NFD Pod and\ndeploy the custom hooks/features there. NFD will periodically scan the\ndirectories and run any hooks and read any feature files it finds. The\ndefault deployments contain `hostPath` mounts for `sources.d` and `features.d`\ndirectories. By using the same mounts in the secondary Pod (e.g. device plugin)\nyou have created a shared area for delivering hooks and feature files to NFD.\n\n#### A hook example\n\nUser has a shell script\n`/etc/kubernetes/node-feature-discovery/source.d/my-source` which has the\nfollowing `stdout` output:\n\n```plaintext\nMY_FEATURE_1\nMY_FEATURE_2=myvalue\n/override_source-OVERRIDE_BOOL\n/override_source-OVERRIDE_VALUE=123\noverride.namespace/value=456\n```\n\nwhich, in turn, will translate into the following node labels:\n\n```plaintext\nfeature.node.kubernetes.io/my-source-MY_FEATURE_1=true\nfeature.node.kubernetes.io/my-source-MY_FEATURE_2=myvalue\nfeature.node.kubernetes.io/override_source-OVERRIDE_BOOL=true\nfeature.node.kubernetes.io/override_source-OVERRIDE_VALUE=123\noverride.namespace/value=456\n```\n\n#### A file example\n\nUser has a file `/etc/kubernetes/node-feature-discovery/features.d/my-source`\nwhich contains the following lines:\n\n```plaintext\nMY_FEATURE_1\nMY_FEATURE_2=myvalue\n/override_source-OVERRIDE_BOOL\n/override_source-OVERRIDE_VALUE=123\noverride.namespace/value=456\n```\n\nwhich, in turn, will translate into the following node labels:\n\n```plaintext\nfeature.node.kubernetes.io/my-source-MY_FEATURE_1=true\nfeature.node.kubernetes.io/my-source-MY_FEATURE_2=myvalue\nfeature.node.kubernetes.io/override_source-OVERRIDE_BOOL=true\nfeature.node.kubernetes.io/override_source-OVERRIDE_VALUE=123\noverride.namespace/value=456\n```\n\nNFD tries to run any regular files found from the hooks directory. Any\nadditional data files your hook might need (e.g. a configuration file) should\nbe placed in a separate directory in order to avoid NFD unnecessarily trying to\nexecute these. You can use a subdirectory under the hooks directory, for\nexample `/etc/kubernetes/node-feature-discovery/source.d/conf/`.\n\n**NOTE!** NFD will blindly run any executables placed/mounted in the hooks\ndirectory. It is the user's responsibility to review the hooks for e.g.\npossible security implications.\n\n**NOTE!** Be careful when creating and/or updating hook or feature files while\nNFD is running. In order to avoid race conditions you should write into a\ntemporary file (outside the `source.d` and `features.d` directories), and,\natomically create/update the original file by doing a filesystem move\noperation.\n\n## Extended resources\n\nThis feature is experimental and by no means a replacement for the usage of\ndevice plugins.\n\nLabels which have integer values, can be promoted to Kubernetes extended\nresources by listing them to the master `-resource-labels` command line flag.\nThese labels won't then show in the node label section, they will appear only\nas extended resources.\n\nAn example use-case for the extended resources could be based on a hook which\ncreates a label for the node SGX EPC memory section size. By giving the name of\nthat label in the `-resource-labels` flag, that value will then turn into an\nextended resource of the node, allowing PODs to request that resource and the\nKubernetes scheduler to schedule such PODs to only those nodes which have a\nsufficient capacity of said resource left.\n\nSimilar to labels, the default namespace `feature.node.kubernetes.io` is\nautomatically prefixed to the extended resource, if the promoted label doesn't\nhave a namespace.\n\nExample usage of the command line arguments, using a new namespace:\n`nfd-master -resource-labels=my_source-my.feature,sgx.some.ns/epc -extra-label-ns=sgx.some.ns`\n\nThe above would result in following extended resources provided that related\nlabels exist:\n\n```plaintext\n sgx.some.ns/epc: \n feature.node.kubernetes.io/my_source-my.feature: \n```\n\n\n[klauspost-cpuid]: https://github.com/klauspost/cpuid#x86-cpu-instructions\n[intel-rdt]: http://www.intel.com/content/www/us/en/architecture-and-technology/resource-director-technology.html\n[intel-pstate]: https://www.kernel.org/doc/Documentation/cpu-freq/intel-pstate.txt\n[intel-sst]: https://www.intel.com/content/www/us/en/architecture-and-technology/speed-select-technology-article.html\n[sriov]: http://www.intel.com/content/www/us/en/pci-express/pci-sig-sr-iov-primer-sr-iov-technology-paper.html\n","dir":"/get-started/","name":"features.md","path":"get-started/features.md","url":"/get-started/features.html"},{"title":"Get started","layout":"default","sort":1,"content":"Node Feature Discovery \n\nWelcome to Node Feature Discovery – a Kubernetes add-on for detecting hardware\nfeatures and system configuration!
\n\nContinue to:
\n\n\n\nQuick-start – the short-short version \n\n$ kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref= master\n namespace/node-feature-discovery created\n serviceaccount/nfd-master created\n clusterrole.rbac.authorization.k8s.io/nfd-master created\n clusterrolebinding.rbac.authorization.k8s.io/nfd-master created\n configmap/nfd-worker-conf created\n service/nfd-master created\n deployment.apps/nfd-master created\n daemonset.apps/nfd-worker created\n\n$ kubectl -n node-feature-discovery get all\n NAME READY STATUS RESTARTS AGE\n pod/nfd-master-555458dbbc-sxg6w 1/1 Running 0 56s\n pod/nfd-worker-mjg9f 1/1 Running 0 17s\n...\n\n$ kubectl get no -o json | jq .items[].metadata.labels\n { \n \"beta.kubernetes.io/arch\" : \"amd64\" ,\n \"beta.kubernetes.io/os\" : \"linux\" ,\n \"feature.node.kubernetes.io/cpu-cpuid.ADX\" : \"true\" ,\n \"feature.node.kubernetes.io/cpu-cpuid.AESNI\" : \"true\" ,\n...\n\nDeveloper guide \n\nTable of contents \n\n\n Building from source \n Download the source code Docker build Deployment Building locally Customizing the build Testing \n Running locally \n NFD-Master NFD-Worker NFD-Topology-Updater \n Documentation \n\nBuilding from source \n\nDownload the source code \n\ngit clone https://github.com/kubernetes-sigs/node-feature-discovery\ncd node-feature-discovery\nDocker build \n\nBuild the container image \n\nSee customizing the build below for altering the\ncontainer image registry, for example.
\n\n\n\nPush the container image \n\nOptional, this example with Docker.
\n\ndocker push <IMAGE_TAG>\nChange the job spec to use your custom image (optional) \n\nTo use your published image from the step above instead of the\nk8s.gcr.io/nfd/node-feature-discovery image, edit image\nattribute in the spec template(s) to the new location\n(<registry-name>/<image-name>[:<version>]).
\n\nDeployment \n\nThe yamls makefile generates a kustomization.yaml matching your locally\nbuilt image and using the deploy/overlays/default deployment. See\nbuild customization below for configurability, e.g.\nchanging the deployment namespace.
\n\nK8S_NAMESPACE = my-ns make yamls\nkubectl apply -k . \nYou can use alternative deployment methods by modifying the auto-generated\nkustomization file. For example, deploying worker and master in the same pod by\npointing to deployment/overlays/default-combined.
\n\nBuilding locally \n\nYou can also build the binaries locally
\n\n\n\nThis will compile binaries under bin/
\n\nCustomizing the build \n\nThere are several Makefile variables that control the build process and the\nname of the resulting container image. The following are targeted targeted for\nbuild customization and they can be specified via environment variables or\nmakefile overrides.
\n\n\n \n \n Variable \n Description \n Default value \n \n \n \n \n HOSTMOUNT_PREFIX \n Prefix of system directories for feature discovery (local builds) \n / (local builds ) /host- (container builds ) \n \n \n IMAGE_BUILD_CMD \n Command to build the image \n docker build \n \n \n IMAGE_BUILD_EXTRA_OPTS \n Extra options to pass to build command \n empty \n \n IMAGE_PUSH_CMD \n Command to push the image to remote registry \n docker push \n \n \n IMAGE_REGISTRY \n Container image registry to use \n k8s.gcr.io/nfd \n \n \n IMAGE_TAG_NAME \n Container image tag name \n <nfd version> \n \n \n IMAGE_EXTRA_TAG_NAMES \n Additional container image tag(s) to create when building image \n empty \n \n K8S_NAMESPACE \n nfd-master and nfd-worker namespace \n kube-system \n \n \n KUBECONFIG \n Kubeconfig for running e2e-tests \n empty \n \n E2E_TEST_CONFIG \n Parameterization file of e2e-tests (see example ) \n empty \n \n OPENSHIFT \n Non-empty value enables OpenShift specific support (currently only effective in e2e tests) \n empty \n \n BASE_IMAGE_FULL \n Container base image for target image full (–target full) \n debian:buster-slim \n \n \n BASE_IMAGE_MINIMAL \n Container base image for target image minimal (–target minimal) \n gcr.io/distroless/base \n \n \n
\n\nFor example, to use a custom registry:
\n\nmake IMAGE_REGISTRY = <my custom registry uri>\nOr to specify a build tool different from Docker, It can be done in 2 ways:
\n\n\n \n via environment
\n\n IMAGE_BUILD_CMD = \"buildah bud\" make\n \n \n by overriding the variable value
\n\n make IMAGE_BUILD_CMD = \"buildah bud\" \n \n \n\nTesting \n\nUnit tests are automatically run as part of the container image build. You can\nalso run them manually in the source code tree by simply running:
\n\n\n\nEnd-to-end tests are built on top of the e2e test framework of Kubernetes, and,\nthey required a cluster to run them on. For running the tests on your test\ncluster you need to specify the kubeconfig to be used:
\n\nmake e2e-test KUBECONFIG = $HOME /.kube/config\nRunning locally \n\nYou can run NFD locally, either directly on your host OS or in containers for\ntesting and development purposes. This may be useful e.g. for checking\nfeatures-detection.
\n\nNFD-Master \n\nWhen running as a standalone container labeling is expected to fail because\nKubernetes API is not available. Thus, it is recommended to use -no-publish\ncommand line flag. E.g.
\n\n$ export NFD_CONTAINER_IMAGE = gcr.io/k8s-staging-nfd/node-feature-discovery:master\n$ docker run --rm --name = nfd-test ${ NFD_CONTAINER_IMAGE } nfd-master -no-publish \n2019/02/01 14:48:21 Node Feature Discovery Master <NFD_VERSION>\n2019/02/01 14:48:21 gRPC server serving on port: 8080\nNFD-Worker \n\nIn order to run nfd-worker as a “stand-alone” container against your\nstandalone nfd-master you need to run them in the same network namespace:
\n\n$ docker run --rm --network = container:nfd-test ${ NFD_CONTAINER_IMAGE } nfd-worker\n2019/02/01 14:48:56 Node Feature Discovery Worker <NFD_VERSION>\n...\nIf you just want to try out feature discovery without connecting to nfd-master,\npass the -no-publish flag to nfd-worker.
\n\nNOTE Some feature sources need certain directories and/or files from the\nhost mounted inside the NFD container. Thus, you need to provide Docker with the\ncorrect --volume options in order for them to work correctly when run\nstand-alone directly with docker run. See the\ndefault deployment \nfor up-to-date information about the required volume mounts.
\n\nNFD-Topology-Updater \n\nIn order to run nfd-topology-updater as a “stand-alone” container against your\nstandalone nfd-master you need to run them in the same network namespace:
\n\n$ docker run --rm --network = container:nfd-test ${ NFD_CONTAINER_IMAGE } nfd-topology-updater\n2019/02/01 14:48:56 Node Feature Discovery Topology Updater <NFD_VERSION>\n...\nIf you just want to try out feature discovery without connecting to nfd-master,\npass the -no-publish flag to nfd-topology-updater.
\n\nCommand line flags of nfd-topology-updater:
\n\n$ docker run --rm ${ NFD_CONTAINER_IMAGE } nfd-topology-updater -help \ndocker run --rm quay.io/swsehgal/node-feature-discovery:v0.10.0-devel-64-g93a0a9f-dirty nfd-topology-updater -help \nUsage of nfd-topology-updater:\n -add_dir_header \n If true , adds the file directory to the header of the log messages\n -alsologtostderr \n log to standard error as well as files\n -ca-file string\n Root certificate for verifying connections\n -cert-file string\n Certificate used for authenticating connections\n -key-file string\n Private key matching -cert-file \n -kubeconfig string\n Kube config file.\n -kubelet-config-file string\n Kubelet config file path. ( default \"/host-var/lib/kubelet/config.yaml\" ) \n -log_backtrace_at value\n when logging hits line file:N, emit a stack trace\n -log_dir string\n If non-empty, write log files in this directory\n -log_file string\n If non-empty, use this log file\n -log_file_max_size uint\n Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. ( default 1800) \n -logtostderr \n log to standard error instead of files ( default true ) \n -no-publish \n Do not publish discovered features to the cluster-local Kubernetes API server.\n -one_output \n If true , only write logs to their native severity level ( vs also writing to each lower severity level) \n -oneshot \n Update once and exit \n -podresources-socket string\n Pod Resource Socket path to use. ( default \"/host-var/lib/kubelet/pod-resources/kubelet.sock\" ) \n -server string\n NFD server address to connecto to. ( default \"localhost:8080\" ) \n -server-name-override string\n Hostname expected from server certificate, useful in testing\n -skip_headers \n If true , avoid header prefixes in the log messages\n -skip_log_headers \n If true , avoid headers when opening log files\n -sleep-interval duration\n Time to sleep between CR updates. Non-positive value implies no CR updatation ( i.e. infinite sleep ) . [ Default: 60s] ( default 1m0s) \n -stderrthreshold value\n logs at or above this threshold go to stderr ( default 2) \n -v value\n number for the log level verbosity\n -version \n Print version and exit.\n -vmodule value\n comma-separated list of pattern = N settings for file-filtered logging\n -watch-namespace string\n Namespace to watch pods ( for testing/debugging purpose) . Use * for all namespaces. ( default \"*\" ) \nNOTE:
\n\nNFD topology updater needs certain directories and/or files from the\nhost mounted inside the NFD container. Thus, you need to provide Docker with the\ncorrect --volume options in order for them to work correctly when run\nstand-alone directly with docker run. See the\ntemplate spec \nfor up-to-date information about the required volume mounts.
\n\nPodResource API is a prerequisite for nfd-topology-updater.\nPreceding Kubernetes v1.23, the kubelet must be started with the following flag:\n--feature-gates=KubeletPodResourcesGetAllocatable=true.\nStarting Kubernetes v1.23, the GetAllocatableResources is enabled by default\nthrough KubeletPodResourcesGetAllocatable feature gate .
\n\nDocumentation \n\nAll documentation resides under the\ndocs \ndirectory in the source tree. It is designed to be served as a html site by\nGitHub Pages .
\n\nBuilding the documentation is containerized in order to fix the build\nenvironment. The recommended way for developing documentation is to run:
\n\n\n\nThis will build the documentation in a container and serve it under\nlocalhost:4000/ making it easy to verify the results.\nAny changes made to the docs/ will automatically re-trigger a rebuild and are\nreflected in the served content and can be inspected with a simple browser\nrefresh.
\n\nIn order to just build the html documentation run:
\n\n\n\nThis will generate html documentation under docs/_site/.
\n\n\n","dir":"/advanced/","name":"developer-guide.md","path":"advanced/developer-guide.md","url":"/advanced/developer-guide.html"},{"title":"Introduction","layout":"default","sort":1,"content":"Introduction \n\nTable of contents \n\n\n NFD-Master NFD-Worker NFD-Topology-Updater Feature Discovery Node annotations NodeResourceTopology CR \n\nThis software enables node feature discovery for Kubernetes. It detects\nhardware features available on each node in a Kubernetes cluster, and\nadvertises those features using node labels.
\n\nNFD consists of three software components:
\n\n\n nfd-master \n nfd-worker \n nfd-topology-updater \n \n\nNFD-Master \n\nNFD-Master is the daemon responsible for communication towards the Kubernetes\nAPI. That is, it receives labeling requests from the worker and modifies node\nobjects accordingly.
\n\nNFD-Worker \n\nNFD-Worker is a daemon responsible for feature detection. It then communicates\nthe information to nfd-master which does the actual node labeling. One\ninstance of nfd-worker is supposed to be running on each node of the cluster,
\n\nNFD-Topology-Updater \n\nNFD-Topology-Updater is a daemon responsible for examining allocated\nresources on a worker node to account for resources available to be allocated\nto new pod on a per-zone basis (where a zone can be a NUMA node). It then\ncommunicates the information to nfd-master which does the\nNodeResourceTopology CR creation corresponding\nto all the nodes in the cluster. One instance of nfd-topology-updater is\nsupposed to be running on each node of the cluster.
\n\nFeature Discovery \n\nFeature discovery is divided into domain-specific feature sources:
\n\n\n CPU \n IOMMU \n Kernel \n Memory \n Network \n PCI \n Storage \n System \n USB \n Custom (rule-based custom features) \n Local (hooks for user-specific features) \n \n\nEach feature source is responsible for detecting a set of features which. in\nturn, are turned into node feature labels. Feature labels are prefixed with\nfeature.node.kubernetes.io/ and also contain the name of the feature source.\nNon-standard user-specific feature labels can be created with the local and\ncustom feature sources.
\n\nAn overview of the default feature labels:
\n\n{ \n \"feature.node.kubernetes.io/cpu-<feature-name>\" : \"true\" , \n \"feature.node.kubernetes.io/custom-<feature-name>\" : \"true\" , \n \"feature.node.kubernetes.io/iommu-<feature-name>\" : \"true\" , \n \"feature.node.kubernetes.io/kernel-<feature name>\" : \"<feature value>\" , \n \"feature.node.kubernetes.io/memory-<feature-name>\" : \"true\" , \n \"feature.node.kubernetes.io/network-<feature-name>\" : \"true\" , \n \"feature.node.kubernetes.io/pci-<device label>.present\" : \"true\" , \n \"feature.node.kubernetes.io/storage-<feature-name>\" : \"true\" , \n \"feature.node.kubernetes.io/system-<feature name>\" : \"<feature value>\" , \n \"feature.node.kubernetes.io/usb-<device label>.present\" : \"<feature value>\" , \n \"feature.node.kubernetes.io/<file name>-<feature name>\" : \"<feature value>\" \n } \n Node annotations \n\nNFD also annotates nodes it is running on:
\n\n\n \n \n Annotation \n Description \n \n \n \n \n [<instance>.]nfd.node.kubernetes.io/master.version \n Version of the nfd-master instance running on the node. Informative use only. \n \n \n [<instance>.]nfd.node.kubernetes.io/worker.version \n Version of the nfd-worker instance running on the node. Informative use only. \n \n \n [<instance>.]nfd.node.kubernetes.io/feature-labels \n Comma-separated list of node labels managed by NFD. NFD uses this internally so must not be edited by users. \n \n \n [<instance>.]nfd.node.kubernetes.io/extended-resources \n Comma-separated list of node extended resources managed by NFD. NFD uses this internally so must not be edited by users. \n \n \n
\n\nNOTE: the -instance
\n\nUnapplicable annotations are not created, i.e. for example master.version is\nonly created on nodes running nfd-master.
\n\nNodeResourceTopology CR \n\nWhen run with NFD-Topology-Updater, NFD creates CR instances corresponding to\nnode resource hardware topology such as:
\n\napiVersion : topology.node.k8s.io/v1alpha1 \nkind : NodeResourceTopology \nmetadata : \n name : node1 \ntopologyPolicies : [ \" SingleNUMANodeContainerLevel\" ] \nzones : \n - name : node-0 \n type : Node \n resources : \n - name : cpu \n capacity : 20 \n allocatable : 16 \n available : 10 \n - name : vendor/nic1 \n capacity : 3 \n allocatable : 3 \n available : 3 \n - name : node-1 \n type : Node \n resources : \n - name : cpu \n capacity : 30 \n allocatable : 30 \n available : 15 \n - name : vendor/nic2 \n capacity : 6 \n allocatable : 6 \n available : 6 \n - name : node-2 \n type : Node \n resources : \n - name : cpu \n capacity : 30 \n allocatable : 30 \n available : 15 \n - name : vendor/nic1 \n capacity : 3 \n allocatable : 3 \n available : 3 \nAdvanced \n\nAdvanced topics and reference.
\n","dir":"/advanced/","name":"index.md","path":"advanced/index.md","url":"/advanced/"},{"title":"Master cmdline reference","layout":"default","sort":2,"content":"Commandline flags of nfd-master \n\nTable of contents \n\n\n -h, -help -version -prune -port -instance -ca-file -cert-file -key-file -verify-node-name -no-publish -featurerules-controller -label-whitelist -resource-labels Logging \n\nTo quickly view available command line flags execute nfd-master -help.\nIn a docker container:
\n\ndocker run gcr.io/k8s-staging-nfd/node-feature-discovery:master nfd-master -help \n-h, -help \n\nPrint usage and exit.
\n\n-version \n\nPrint version and exit.
\n\n-prune \n\nThe -prune flag is a sub-command like option for cleaning up the cluster. It\ncauses nfd-master to remove all NFD related labels, annotations and extended\nresources from all Node objects of the cluster and exit.
\n\n-port \n\nThe -port flag specifies the TCP port that nfd-master listens for incoming requests.
\n\nDefault: 8080
\n\nExample:
\n\n\n\n-instance \n\nThe -instance flag makes it possible to run multiple NFD deployments in\nparallel. In practice, it separates the node annotations between deployments so\nthat each of them can store metadata independently. The instance name must\nstart and end with an alphanumeric character and may only contain alphanumeric\ncharacters, -, _ or ..
\n\nDefault: empty
\n\nExample:
\n\nnfd-master -instance = network\n-ca-file \n\nThe -ca-file is one of the three flags (together with -cert-file and\n-key-file) controlling master-worker mutual TLS authentication on the\nnfd-master side. This flag specifies the TLS root certificate that is used for\nauthenticating incoming connections. NFD-Worker side needs to have matching key\nand cert files configured in order for the incoming requests to be accepted.
\n\nDefault: empty
\n\nNote: Must be specified together with -cert-file and -key-file
\n\nExample:
\n\nnfd-master -ca-file = /opt/nfd/ca.crt -cert-file = /opt/nfd/master.crt -key-file = /opt/nfd/master.key\n-cert-file \n\nThe -cert-file is one of the three flags (together with -ca-file and\n-key-file) controlling master-worker mutual TLS authentication on the\nnfd-master side. This flag specifies the TLS certificate presented for\nauthenticating outgoing traffic towards nfd-worker.
\n\nDefault: empty
\n\nNote: Must be specified together with -ca-file and -key-file
\n\nExample:
\n\nnfd-master -cert-file = /opt/nfd/master.crt -key-file = /opt/nfd/master.key -ca-file = /opt/nfd/ca.crt\n-key-file \n\nThe -key-file is one of the three flags (together with -ca-file and\n-cert-file) controlling master-worker mutual TLS authentication on the\nnfd-master side. This flag specifies the private key corresponding the given\ncertificate file (-cert-file) that is used for authenticating outgoing\ntraffic.
\n\nDefault: empty
\n\nNote: Must be specified together with -cert-file and -ca-file
\n\nExample:
\n\nnfd-master -key-file = /opt/nfd/master.key -cert-file = /opt/nfd/master.crt -ca-file = /opt/nfd/ca.crt\n-verify-node-name \n\nThe -verify-node-name flag controls the NodeName based authorization of\nincoming requests and only has effect when mTLS authentication has been enabled\n(with -ca-file, -cert-file and -key-file). If enabled, the worker node\nname of the incoming must match with the CN or a SAN in its TLS certificate. Thus,\nworkers are only able to label the node they are running on (or the node whose\ncertificate they present).
\n\nNode Name based authorization is disabled by default.
\n\nDefault: false
\n\nExample:
\n\nnfd-master -verify-node-name -ca-file = /opt/nfd/ca.crt \\ \n -cert-file = /opt/nfd/master.crt -key-file = /opt/nfd/master.key\n-no-publish \n\nThe -no-publish flag disables updates to the Node objects in the Kubernetes\nAPI server, making a “dry-run” flag for nfd-master. No Labels, Annotations or\nExtendedResources of nodes are updated.
\n\nDefault: false
\n\nExample:
\n\n\n\n-featurerules-controller \n\nThe -featurerules-controller flag controlers the processing of\nNodeFeatureRule objects, effectively enabling/disabling labels from these\ncustom labeling rules.
\n\nDefault: true
\n\nExample:
\n\nnfd-master -featurerules-controller = false \n-label-whitelist \n\nThe -label-whitelist specifies a regular expression for filtering feature\nlabels based on their name. Each label must match against the given reqular\nexpression in order to be published.
\n\nNote: The regular expression is only matches against the “basename” part of the\nlabel, i.e. to the part of the name after ‘/’. The label namespace is omitted.
\n\nDefault: empty
\n\nExample:
\n\nnfd-master -label-whitelist = '.*cpuid\\.' \nThe -extra-label-ns flag specifies a comma-separated list of allowed feature\nlabel namespaces. By default, nfd-master only allows creating labels in the\ndefault feature.node.kubernetes.io and profile.node.kubernetes.io label\nnamespaces and their sub-namespaces (e.g. vendor.feature.node.kubernetes.io\nand sub.ns.profile.node.kubernetes.io). This option can be used to allow\nother vendor or application specific namespaces for custom labels from the\nlocal and custom feature sources.
\n\nThe same namespace control and this flag applies Extended Resources (created\nwith -resource-labels), too.
\n\nDefault: empty
\n\nExample:
\n\nnfd-master -extra-label-ns = vendor-1.com,vendor-2.io\n-resource-labels \n\nThe -resource-labels flag specifies a comma-separated list of features to be\nadvertised as extended resources instead of labels. Features that have integer\nvalues can be published as Extended Resources by listing them in this flag.
\n\nDefault: empty
\n\nExample:
\n\nnfd-master -resource-labels = vendor-1.com/feature-1,vendor-2.io/feature-2\nLogging \n\nThe following logging-related flags are inherited from the\nklog package.
\n\n\n\nIf true, adds the file directory to the header of the log messages.
\n\nDefault: false
\n\n-alsologtostderr \n\nLog to standard error as well as files.
\n\nDefault: false
\n\n-log_backtrace_at \n\nWhen logging hits line file:N, emit a stack trace.
\n\nDefault: empty
\n\n-log_dir \n\nIf non-empty, write log files in this directory.
\n\nDefault: empty
\n\n-log_file \n\nIf non-empty, use this log file.
\n\nDefault: empty
\n\n-log_file_max_size \n\nDefines the maximum size a log file can grow to. Unit is megabytes. If the\nvalue is 0, the maximum file size is unlimited.
\n\nDefault: 1800
\n\n-logtostderr \n\nLog to standard error instead of files
\n\nDefault: true
\n\n\n\nIf true, avoid header prefixes in the log messages.
\n\nDefault: false
\n\n\n\nIf true, avoid headers when opening log files.
\n\nDefault: false
\n\n-stderrthreshold \n\nLogs at or above this threshold go to stderr.
\n\nDefault: 2
\n\n-v \n\nNumber for the log level verbosity.
\n\nDefault: 0
\n\n-vmodule \n\nComma-separated list of pattern=N settings for file-filtered logging.
\n\nDefault: empty
\n","dir":"/advanced/","name":"master-commandline-reference.md","path":"advanced/master-commandline-reference.md","url":"/advanced/master-commandline-reference.html"},{"title":"Quick start","layout":"default","sort":2,"content":"Quick start \n\nMinimal steps to deploy latest released version of NFD in your cluster.
\n\nInstallation \n\nDeploy with kustomize – creates a new namespace, service and required RBAC\nrules and deploys nfd-master and nfd-worker daemons.
\n\nkubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref= master\nVerify \n\nWait until NFD master and NFD worker are running.
\n\n$ kubectl -n node-feature-discovery get ds,deploy\nNAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE\ndaemonset.apps/nfd-worker 2 2 2 2 2 <none> 10s\n\nNAME READY UP-TO-DATE AVAILABLE AGE\ndeployment.apps/nfd-master 1/1 1 1 17s\n\nCheck that NFD feature labels have been created
\n\n$ kubectl get no -o json | jq .items[].metadata.labels\n{ \n \"beta.kubernetes.io/arch\" : \"amd64\" ,\n \"beta.kubernetes.io/os\" : \"linux\" ,\n \"feature.node.kubernetes.io/cpu-cpuid.ADX\" : \"true\" ,\n \"feature.node.kubernetes.io/cpu-cpuid.AESNI\" : \"true\" ,\n \"feature.node.kubernetes.io/cpu-cpuid.AVX\" : \"true\" ,\n...\nUse node labels \n\nCreate a pod targeting a distinguishing feature (select a valid feature from\nthe list printed on the previous step)
\n\n$ cat << EOF | kubectl apply -f -\napiVersion: v1\nkind: Pod\nmetadata:\n name: feature-dependent-pod\nspec:\n containers:\n - image: k8s.gcr.io/pause\n name: pause\n nodeSelector:\n # Select a valid feature\n feature.node.kubernetes.io/cpu-cpuid.AESNI: 'true'\n EOF\n pod/feature-dependent-pod created\nSee that the pod is running on a desired node
\n\n$ kubectl get po feature-dependent-pod -o wide\nNAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES\nfeature-dependent-pod 1/1 Running 0 23s 10.36.0.4 node-2 <none> <none>\nAdditional Optional Installation Steps \n\nIn order to deploy nfd-master and nfd-topology-updater daemons\nuse topologyupdater overlay.
\n\nDeploy with kustomize – creates a new namespace, service and required RBAC\nrules and nfd-master and nfd-topology-updater daemons.
\n\nkubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref= master\nNOTE:
\n\nPodResource API is a prerequisite for nfd-topology-updater.
\n\nPreceding Kubernetes v1.23, the kubelet must be started with the following flag:
\n\n--feature-gates=KubeletPodResourcesGetAllocatable=true
\n\nStarting Kubernetes v1.23, the GetAllocatableResources is enabled by default\nthrough KubeletPodResourcesGetAllocatable feature gate .
\n\nVerify \n\nWait until NFD master and NFD topologyupdater are running.
\n\n$ kubectl -n node-feature-discovery get ds,deploy\nNAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE\ndaemonset.apps/nfd-topology-updater 2 2 2 2 2 <none> 5s\n\nNAME READY UP-TO-DATE AVAILABLE AGE\ndeployment.apps/nfd-master 1/1 1 1 17s\n\nCheck that the NodeResourceTopology CR instances are created
\n\n$ kubectl get noderesourcetopologies.topology.node.k8s.io\nNAME AGE\nkind-control-plane 23s\nkind-worker 23s\nShow the CR instances \n\n$ kubectl describe noderesourcetopologies.topology.node.k8s.io kind-control-plane\nName: kind-control-plane\nNamespace: default\nLabels: <none>\nAnnotations: <none>\nAPI Version: topology.node.k8s.io/v1alpha1\nKind: NodeResourceTopology\n...\nTopology Policies:\n SingleNUMANodeContainerLevel\nZones:\n Name: node-0\n Costs:\n node-0: 10\n node-1: 20\n Resources:\n Name: Cpu\n Allocatable: 3\n Capacity: 3\n Available: 3\n Name: vendor/nic1\n Allocatable: 2\n Capacity: 2\n Available: 2\n Name: vendor/nic2\n Allocatable: 2\n Capacity: 2\n Available: 2\n Type: Node\n Name: node-1\n Costs:\n node-0: 20\n node-1: 10\n Resources:\n Name: Cpu\n Allocatable: 4\n Capacity: 4\n Available: 4\n Name: vendor/nic1\n Allocatable: 2\n Capacity: 2\n Available: 2\n Name: vendor/nic2\n Allocatable: 2\n Capacity: 2\n Available: 2\n Type: Node\nEvents: <none>\nThe CR instances created can be used to gain insight into the allocatable\nresources along with the granularity of those resources at a per-zone level\n(represented by node-0 and node-1 in the above example) or can be used by an\nexternal entity (e.g. topology-aware scheduler plugin) to take an action based\non the gathered information.
\n\n\n","dir":"/get-started/","name":"quick-start.md","path":"get-started/quick-start.md","url":"/get-started/quick-start.html"},{"title":"Contributing","layout":"default","sort":3,"content":"Contributing \n\nYou can reach us via the following channels:
\n\n\n\nGovernance \n\nThis is a\nSIG-node \nsubproject, hosted under the\nKubernetes SIGs organization in Github.\nThe project was established in 2016 and was migrated to Kubernetes SIGs in 2018.
\n\nLicense \n\nThis is open source software released under the Apache 2.0 License .
\n","dir":"/contributing/","name":"index.md","path":"contributing/index.md","url":"/contributing/"},{"title":"Worker cmdline reference","layout":"default","sort":3,"content":"Commandline flags of nfd-worker \n\nTable of contents \n\n\n -h, -help -version -config -options -server -ca-file -cert-file -key-file -server-name-override -label-sources -sources -no-publish -label-whitelist -oneshot -sleep-interval Logging \n\nTo quickly view available command line flags execute nfd-worker -help.\nIn a docker container:
\n\ndocker run gcr.io/k8s-staging-nfd/node-feature-discovery:master nfd-worker -help \n-h, -help \n\nPrint usage and exit.
\n\n-version \n\nPrint version and exit.
\n\n-config \n\nThe -config flag specifies the path of the nfd-worker configuration file to\nuse.
\n\nDefault: /etc/kubernetes/node-feature-discovery/nfd-worker.conf
\n\nExample:
\n\nnfd-worker -config = /opt/nfd/worker.conf\n-options \n\nThe -options flag may be used to specify and override configuration file\noptions directly from the command line. The required format is the same as in\nthe config file i.e. JSON or YAML. Configuration options specified via this\nflag will override those from the configuration file:
\n\nDefault: empty
\n\nExample:
\n\nnfd-worker -options = '{\"sources\":{\"cpu\":{\"cpuid\":{\"attributeWhitelist\":[\"AVX\",\"AVX2\"]}}}}' \n-server \n\nThe -server flag specifies the address of the nfd-master endpoint where to\nconnect to.
\n\nDefault: localhost:8080
\n\nExample:
\n\nnfd-worker -server = nfd-master.nfd.svc.cluster.local:443\n-ca-file \n\nThe -ca-file is one of the three flags (together with -cert-file and\n-key-file) controlling the mutual TLS authentication on the worker side.\nThis flag specifies the TLS root certificate that is used for verifying the\nauthenticity of nfd-master.
\n\nDefault: empty
\n\nNote: Must be specified together with -cert-file and -key-file
\n\nExample:
\n\nnfd-worker -ca-file = /opt/nfd/ca.crt -cert-file = /opt/nfd/worker.crt -key-file = /opt/nfd/worker.key\n-cert-file \n\nThe -cert-file is one of the three flags (together with -ca-file and\n-key-file) controlling mutual TLS authentication on the worker side. This\nflag specifies the TLS certificate presented for authenticating outgoing\nrequests.
\n\nDefault: empty
\n\nNote: Must be specified together with -ca-file and -key-file
\n\nExample:
\n\nnfd-workerr -cert-file = /opt/nfd/worker.crt -key-file = /opt/nfd/worker.key -ca-file = /opt/nfd/ca.crt\n-key-file \n\nThe -key-file is one of the three flags (together with -ca-file and\n-cert-file) controlling the mutual TLS authentication on the worker side.\nThis flag specifies the private key corresponding the given certificate file\n(-cert-file) that is used for authenticating outgoing requests.
\n\nDefault: empty
\n\nNote: Must be specified together with -cert-file and -ca-file
\n\nExample:
\n\nnfd-worker -key-file = /opt/nfd/worker.key -cert-file = /opt/nfd/worker.crt -ca-file = /opt/nfd/ca.crt\n-server-name-override \n\nThe -server-name-override flag specifies the common name (CN) which to\nexpect from the nfd-master TLS certificate. This flag is mostly intended for\ndevelopment and debugging purposes.
\n\nDefault: empty
\n\nExample:
\n\nnfd-worker -server-name-override = localhost\n-label-sources \n\nThe -label-sources flag specifies a comma-separated list of enabled label\nsources. A special value all enables all sources. Consider using the\ncore.labelSources config file option, instead, allowing dynamic\nconfigurability.
\n\nNote: This flag takes precedence over the core.labelSources configuration\nfile option.
\n\nDefault: all
\n\nExample:
\n\nnfd-worker -label-sources = kernel,system,local\n-sources \n\nDEPRECATED : use -label-sources
\n\n-no-publish \n\nThe -no-publish flag disables all communication with the nfd-master, making\nit a “dry-run” flag for nfd-worker. NFD-Worker runs feature detection normally,\nbut no labeling requests are sent to nfd-master.
\n\nDefault: false
\n\nExample:
\n\n\n\n-label-whitelist \n\nThe -label-whitelist specifies a regular expression for filtering feature\nlabels based on their name. Each label must match against the given reqular\nexpression in order to be published.
\n\nNote: The regular expression is only matches against the “basename” part of the\nlabel, i.e. to the part of the name after ‘/’. The label namespace is omitted.
\n\nNote: This flag takes precedence over the core.labelWhiteList configuration\nfile option.
\n\nDefault: empty
\n\nExample:
\n\nnfd-worker -label-whitelist = '.*cpuid\\.' \nDEPRECATED : you should use the core.labelWhiteList option in the\nconfiguration file, instead.
\n\n-oneshot \n\nThe -oneshot flag causes nfd-worker to exit after one pass of feature\ndetection.
\n\nDefault: false
\n\nExample:
\n\nnfd-worker -oneshot -no-publish \n-sleep-interval \n\nThe -sleep-interval specifies the interval between feature re-detection (and\nnode re-labeling). A non-positive value implies infinite sleep interval, i.e.\nno re-detection or re-labeling is done.
\n\nNote: This flag takes precedence over the core.sleepInterval configuration\nfile option.
\n\nDefault: 60s
\n\nExample:
\n\nnfd-worker -sleep-interval = 1h\nDEPRECATED : you should use the core.sleepInterval option in the\nconfiguration file, instead.
\n\nLogging \n\nThe following logging-related flags are inherited from the\nklog package.
\n\nNote: The logger setup can also be specified via the core.klog configuration\nfile options. However, the command line flags take precedence over any\ncorresponding config file options specified.
\n\n\n\nIf true, adds the file directory to the header of the log messages.
\n\nDefault: false
\n\n-alsologtostderr \n\nLog to standard error as well as files.
\n\nDefault: false
\n\n-log_backtrace_at \n\nWhen logging hits line file:N, emit a stack trace.
\n\nDefault: empty
\n\n-log_dir \n\nIf non-empty, write log files in this directory.
\n\nDefault: empty
\n\n-log_file \n\nIf non-empty, use this log file.
\n\nDefault: empty
\n\n-log_file_max_size \n\nDefines the maximum size a log file can grow to. Unit is megabytes. If the\nvalue is 0, the maximum file size is unlimited.
\n\nDefault: 1800
\n\n-logtostderr \n\nLog to standard error instead of files
\n\nDefault: true
\n\n\n\nIf true, avoid header prefixes in the log messages.
\n\nDefault: false
\n\n\n\nIf true, avoid headers when opening log files.
\n\nDefault: false
\n\n-stderrthreshold \n\nLogs at or above this threshold go to stderr.
\n\nDefault: 2
\n\n-v \n\nNumber for the log level verbosity.
\n\nDefault: 0
\n\n-vmodule \n\nComma-separated list of pattern=N settings for file-filtered logging.
\n\nDefault: empty
\n","dir":"/advanced/","name":"worker-commandline-reference.md","path":"advanced/worker-commandline-reference.md","url":"/advanced/worker-commandline-reference.html"},{"title":"Deployment and usage","layout":"default","sort":3,"content":"Deployment and usage \n\nTable of contents \n\n\n Requirements Image variants \n Full Minimal \n Deployment options \n Operator Deployment with kustomize Deployment with Helm Build your own \n Usage \n NFD-Master NFD-Worker NFD-Topology-Updater Communication security with TLS \n Worker configuration Using node labels Uninstallation \n Operator was used for deployment Manual Removing feature labels \n \n\nRequirements \n\n\n Linux (x86_64/Arm64/Arm) \n kubectl v1.21 or\nlater (properly set up and configured to work with your Kubernetes cluster) \n\nImage variants \n\nNFD currently offers two variants of the container image. The “full” variant is\ncurrently deployed by default.
\n\nFull \n\nThis image is based on\ndebian:buster-slim and contains a full Linux\nsystem for running shell-based nfd-worker hooks and doing live debugging and\ndiagnosis of the NFD images.
\n\nMinimal \n\nThis is a minimal image based on\ngcr.io/distroless/base \nand only supports running statically linked binaries.
\n\nThe container image tag has suffix -minimal\n(e.g. gcr.io/k8s-staging-nfd/node-feature-discovery:master-minimal)
\n\nDeployment options \n\nOperator \n\nDeployment using the\nNode Feature Discovery Operator \nis recommended to be done via\noperatorhub.io .
\n\n\n You need to have\nOLM \ninstalled. If you don’t, take a look at the\nlatest release \nfor detailed instructions. \n \n Install the operator:
\n\n kubectl create -f https://operatorhub.io/install/nfd-operator.yaml\n \n \n Create NodeFeatureDiscovery resource (in nfd namespace here):
\n\n cat << EOF | kubectl apply -f -\n apiVersion: v1\n kind: Namespace\n metadata:\n name: nfd\n ---\n apiVersion: nfd.kubernetes.io/v1alpha1\n kind: NodeFeatureDiscovery\n metadata:\n name: my-nfd-deployment\n namespace: nfd\n EOF\n \n \n\nIn order to deploy the minimal image you need to add
\n\n image : gcr.io/k8s-staging-nfd/node-feature-discovery:master-minimal \nto the metadata of NodeFeatureDiscovery object above.
\n\nDeployment with kustomize \n\nThe kustomize overlays provided in the repo can be used directly:
\n\nkubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref= master\nThis will required RBAC rules and deploy nfd-master (as a deployment) and\nnfd-worker (as daemonset) in the node-feature-discovery namespace.
\n\nNOTE: nfd-topology-updater is not deployed as part of the default overlay.\nPlease refer to the Master Worker Topologyupdater \nand Topologyupdater below.
\n\nAlternatively you can clone the repository and customize the deployment by\ncreating your own overlays. For example, to deploy the minimal \nimage. See kustomize for more information about managing\ndeployment configurations.
\n\nDefault overlays \n\nThe NFD repository hosts a set of overlays for different usages and deployment\nscenarios under\ndeployment/overlays
\n\n\n\nMaster-worker pod \n\nYou can also run nfd-master and nfd-worker inside the same pod
\n\nkubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default-combined?ref= master\n\nThis creates a DaemonSet that runs nfd-worker and nfd-master in the same Pod.\nIn this case no nfd-master is run on the master node(s), but, the worker nodes\nare able to label themselves which may be desirable e.g. in single-node setups.
\n\nNOTE: nfd-topology-updater is not deployed by the default-combined overlay.\nTo enable nfd-topology-updater in this scenario,the users must customize the\ndeployment themselves.
\n\nWorker one-shot \n\nFeature discovery can alternatively be configured as a one-shot job.\nThe default-job overlay may be used to achieve this:
\n\nNUM_NODES = $( kubectl get no -o jsonpath = '{.items[*].metadata.name}' | wc -w ) \nkubectl kustomize https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default-job?ref= master | \\ \n sed s\"/NUM_NODES/ $NUM_NODES /\" | \\ \n kubectl apply -f -\nThe example above launches as many jobs as there are non-master nodes. Note that\nthis approach does not guarantee running once on every node. For example,\ntainted, non-ready nodes or some other reasons in Job scheduling may cause some\nnode(s) will run extra job instance(s) to satisfy the request.
\n\nMaster Worker Topologyupdater \n\nNFD Master, NFD worker and NFD Topologyupdater can be configured to be deployed\nas separate pods. The master-worker-topologyupdater overlay may be used to\nachieve this:
\n\nkubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/master-worker-topologyupdater?ref= master\n\nTopologyupdater \n\nIn order to deploy just NFD master and NFD Topologyupdater (without nfd-worker)\nuse the topologyupdater overlay:
\n\nkubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref= master\n\nNFD Topologyupdater can be configured along with the default overlay\n(which deploys NFD worker and NFD master) where all the software components\nare deployed as separate pods. The topologyupdater overlay may be used\nalong with default overlay to achieve this:
\n\n\nkubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref= master\nkubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref= master\n\nDeployment with Helm \n\nNode Feature Discovery Helm chart allow to easily deploy and manage NFD.
\n\nPrerequisites \n\nHelm package manager should be installed.
\n\nDeployment \n\nTo install the latest stable version:
\n\nexport NFD_NS = node-feature-discovery\nhelm repo add nfd https://kubernetes-sigs.github.io/node-feature-discovery/charts\nhelm repo update\nhelm install nfd/node-feature-discovery --namespace $NFD_NS --create-namespace --generate-name \nTo install the latest development version you need to clone the NFD Git\nrepository and install from there.
\n\ngit clone https://github.com/kubernetes-sigs/node-feature-discovery/\ncd node-feature-discovery/deployment/helm\nexport NFD_NS = node-feature-discovery\nhelm install node-feature-discovery ./node-feature-discovery/ --namespace $NFD_NS --create-namespace \nSee the configuration section below for instructions how to\nalter the deployment parameters.
\n\nIn order to deploy the minimal image you need to override the image\ntag:
\n\nhelm install node-feature-discovery ./node-feature-discovery/ --set image.tag= master-minimal --namespace $NFD_NS --create-namespace \nConfiguration \n\nYou can override values from values.yaml and provide a file with custom values:
\n\nexport NFD_NS = node-feature-discovery\nhelm install nfd/node-feature-discovery -f <path/to/custom/values.yaml> --namespace $NFD_NS --create-namespace \nTo specify each parameter separately you can provide them to helm install command:
\n\nexport NFD_NS = node-feature-discovery\nhelm install nfd/node-feature-discovery --set nameOverride = NFDinstance --set master.replicaCount= 2 --namespace $NFD_NS --create-namespace \nUninstalling the chart \n\nTo uninstall the node-feature-discovery deployment:
\n\nexport NFD_NS = node-feature-discovery\nhelm uninstall node-feature-discovery --namespace $NFD_NS \nThe command removes all the Kubernetes components associated with the chart and\ndeletes the release.
\n\nChart parameters \n\nIn order to tailor the deployment of the Node Feature Discovery to your cluster needs\nWe have introduced the following Chart parameters.
\n\nGeneral parameters \n\n\n \n \n Name \n Type \n Default \n description \n \n \n \n \n image.repositorystring \n gcr.io/k8s-staging-nfd/node-feature-discoveryNFD image repository \n \n \n image.tagstring \n masterNFD image tag \n \n \n image.pullPolicystring \n AlwaysImage pull policy \n \n \n imagePullSecretslist \n [] \n 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 \n \n \n serviceAccount.createbool \n true \n Specifies whether a service account should be created \n \n \n serviceAccount.annotationsdict \n {} \n Annotations to add to the service account \n \n \n serviceAccount.namestring \n \n The name of the service account to use. If not set and create is true, a name is generated using the fullname template \n \n \n rbacdict \n \n RBAC parameteres \n \n \n nameOverridestring \n \n Override the name of the chart \n \n \n fullnameOverridestring \n \n Override a default fully qualified app name \n \n \n nodeFeatureRule.createCRDbool \n true \n Specifies whether to create the NodeFeatureRule CRD \n \n \n
\n\nMaster pod parameters \n\n\n \n \n Name \n Type \n Default \n description \n \n \n \n \n master.*dict \n \n NFD master deployment configuration \n \n \n master.instancestring \n \n Instance name. Used to separate annotation namespaces for multiple parallel deployments \n \n \n master.extraLabelNsarray \n [] \n List of allowed extra label namespaces \n \n \n master.featureRulesControllerbool \n True \n Specifies whether the controller for processing of NodeFeatureRule objects is enable. \n \n \n master.replicaCountinteger \n 1 \n Number of desired pods. This is a pointer to distinguish between explicit zero and not specified \n \n \n master.podSecurityContextdict \n {} \n SecurityContext holds pod-level security attributes and common container settings \n \n \n master.service.typestring \n ClusterIP \n NFD master service type \n \n \n master.service.portinteger \n port \n NFD master service port \n \n \n master.resourcesdict \n {} \n NFD master pod resources management \n \n \n master.nodeSelectordict \n {} \n NFD master pod node selector \n \n \n master.tolerationsdict \n Scheduling to master node is disabled NFD master pod tolerations \n \n \n master.annotationsdict \n {} \n NFD master pod metadata \n \n \n master.affinitydict \n \n NFD master pod required node affinity \n \n \n
\n\nWorker pod parameters \n\n\n \n \n Name \n Type \n Default \n description \n \n \n \n \n worker.*dict \n \n NFD worker daemonset configuration \n \n \n worker.configdict \n \n NFD worker configuration \n \n \n worker.podSecurityContextdict \n {} \n SecurityContext holds pod-level security attributes and common container settings \n \n \n worker.securityContextdict \n {} \n Container security settings \n \n \n worker.resourcesdict \n {} \n NFD worker pod resources management \n \n \n worker.nodeSelectordict \n {} \n NFD worker pod node selector \n \n \n worker.tolerationsdict \n {} \n NFD worker pod node tolerations \n \n \n worker.annotationsdict \n {} \n NFD worker pod metadata \n \n \n
\n\nTopology updater parameters \n\n\n \n \n Name \n Type \n Default \n description \n \n \n \n \n topologyUpdater.*dict \n \n NFD Topology Updater configuration \n \n \n topologyUpdater.enablebool \n false \n Specifies whether the NFD Topology Updater should be created \n \n \n topologyUpdater.createCRDsbool \n false \n Specifies whether the NFD Topology Updater CRDs should be created \n \n \n topologyUpdater.serviceAccount.createbool \n true \n Specifies whether the service account for topology updater should be created \n \n \n topologyUpdater.serviceAccount.annotationsdict \n {} \n Annotations to add to the service account for topology updater \n \n \n topologyUpdater.serviceAccount.namestring \n \n The name of the service account for topology updater to use. If not set and create is true, a name is generated using the fullname template and -topology-updater suffix \n \n \n topologyUpdater.rbacdict \n \n RBAC parameteres for the topology updater \n \n \n topologyUpdater.rbac.createbool \n false \n Specifies whether the cluster role and binding for topology updater should be created \n \n \n topologyUpdater.kubeletConfigPathstring \n ”” \n Specifies the kubelet config host path \n \n \n topologyUpdater.kubeletPodResourcesSockPathstring \n ”” \n Specifies the kubelet sock path to read pod resources \n \n \n topologyUpdater.updateIntervalstring \n 60s \n Time to sleep between CR updates. Non-positive value implies no CR update. \n \n \n topologyUpdater.watchNamespacestring \n *Namespace to watch pods, * for all namespaces \n \n \n topologyUpdater.podSecurityContextdict \n {} \n SecurityContext holds pod-level security attributes and common container settings \n \n \n topologyUpdater.securityContextdict \n {} \n Container security settings \n \n \n topologyUpdater.resourcesdict \n {} \n Topology updater pod resources management \n \n \n topologyUpdater.nodeSelectordict \n {} \n Topology updater pod node selector \n \n \n topologyUpdater.tolerationsdict \n {} \n Topology updater pod node tolerations \n \n \n topologyUpdater.annotationsdict \n {} \n Topology updater pod metadata \n \n \n topologyUpdater.affinitydict \n {} \n Topology updater pod affinity \n \n \n
\n\nBuild your own \n\nIf you want to use the latest development version (master branch) you need to\nbuild your own custom image.\nSee the Developer Guide for instructions how to\nbuild images and deploy them on your cluster.
\n\nUsage \n\nNFD-Master \n\nNFD-Master runs as a deployment (with a replica count of 1), by default\nit prefers running on the cluster’s master nodes but will run on worker\nnodes if no master nodes are found.
\n\nFor High Availability, you should simply increase the replica count of\nthe deployment object. You should also look into adding\ninter-pod \naffinity to prevent masters from running on the same node.\nHowever note that inter-pod affinity is costly and is not recommended\nin bigger clusters.
\n\nNFD-Master listens for connections from nfd-worker(s) and connects to the\nKubernetes API server to add node labels advertised by them.
\n\nIf you have RBAC authorization enabled (as is the default e.g. with clusters\ninitialized with kubeadm) you need to configure the appropriate ClusterRoles,\nClusterRoleBindings and a ServiceAccount in order for NFD to create node\nlabels. The provided template will configure these for you.
\n\nNFD-Worker \n\nNFD-Worker is preferably run as a Kubernetes DaemonSet. This assures\nre-labeling on regular intervals capturing changes in the system configuration\nand makes sure that new nodes are labeled as they are added to the cluster.\nWorker connects to the nfd-master service to advertise hardware features.
\n\nWhen run as a daemonset, nodes are re-labeled at an default interval of 60s.\nThis can be changed by using the\ncore.sleepInterval-sleep-interval
\n\nThe worker configuration file is watched and re-read on every change which\nprovides a simple mechanism of dynamic run-time reconfiguration. See\nworker configuration for more details.
\n\nNFD-Topology-Updater \n\nNFD-Topology-Updater is preferably run as a Kubernetes DaemonSet. This assures\nre-examination (and CR updates) on regular intervals capturing changes in\nthe allocated resources and hence the allocatable resources on a per zone\nbasis. It makes sure that more CR instances are created as new nodes get\nadded to the cluster. Topology-Updater connects to the nfd-master service\nto create CR instances corresponding to nodes.
\n\nWhen run as a daemonset, nodes are re-examined for the allocated resources\n(to determine the information of the allocatable resources on a per zone basis\nwhere a zone can be a NUMA node) at an interval specified using the\n-sleep-interval option. The default sleep interval is set to 60s which is the\n the value when no -sleep-interval is specified.
\n\nCommunication security with TLS \n\nNFD supports mutual TLS authentication between the nfd-master and nfd-worker\ninstances. That is, nfd-worker and nfd-master both verify that the other end\npresents a valid certificate.
\n\nTLS authentication is enabled by specifying -ca-file, -key-file and\n-cert-file args, on both the nfd-master and nfd-worker instances.\nThe template specs provided with NFD contain (commented out) example\nconfiguration for enabling TLS authentication.
\n\nThe Common Name (CN) of the nfd-master certificate must match the DNS name of\nthe nfd-master Service of the cluster. By default, nfd-master only check that\nthe nfd-worker has been signed by the specified root certificate (-ca-file).\nAdditional hardening can be enabled by specifying -verify-node-name in\nnfd-master args, in which case nfd-master verifies that the NodeName presented\nby nfd-worker matches the Common Name (CN) or a Subject Alternative Name (SAN)\nof its certificate.
\n\nAutomated TLS certificate management using cert-manager \n\ncert-manager can be used to automate certificate\nmanagement between nfd-master and the nfd-worker pods.
\n\nNFD source code repository contains an example kustomize overlay that can be\nused to deploy NFD with cert-manager supplied certificates enabled. The\ninstructions below describe steps how to generate a self-signed CA certificate\nand set up cert-manager’s\nCA Issuer to sign\nCertificate requests for NFD components in node-feature-discovery\nnamespace.
\n\nkubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.5.1/cert-manager.yaml\nopenssl genrsa -out deployment/overlays/samples/cert-manager/tls.key 2048\nopenssl req -x509 -new -nodes -key deployment/overlays/samples/cert-manager/tls.key -subj \"/CN=nfd-ca\" \\ \n -days 10000 -out deployment/overlays/samples/cert-manager/tls.crt\nkubectl apply -k deployment/overlays/samples/cert-manager\nWorker configuration \n\nNFD-Worker supports dynamic configuration through a configuration file. The\ndefault location is /etc/kubernetes/node-feature-discovery/nfd-worker.conf,\nbut, this can be changed by specifying the-config command line flag.\nConfiguration file is re-read whenever it is modified which makes run-time\nre-configuration of nfd-worker straightforward.
\n\nWorker configuration file is read inside the container, and thus, Volumes and\nVolumeMounts are needed to make your configuration available for NFD. The\npreferred method is to use a ConfigMap which provides easy deployment and\nre-configurability.
\n\nThe provided nfd-worker deployment templates create an empty configmap and\nmount it inside the nfd-worker containers. In kustomize deployments,\nconfiguration can be edited with:
\n\nkubectl -n ${ NFD_NS } edit configmap nfd-worker-conf\nIn Helm deployments, Worker pod parameter \nworker.config can be used to edit the respective configuration.
\n\nSee\nnfd-worker configuration file reference \nfor more details.\nThe (empty-by-default)\nexample config \ncontains all available configuration options and can be used as a reference\nfor creating creating a configuration.
\n\nConfiguration options can also be specified via the -options command line\nflag, in which case no mounts need to be used. The same format as in the config\nfile must be used, i.e. JSON (or YAML). For example:
\n\n-options = '{\"sources\": { \"pci\": { \"deviceClassWhitelist\": [\"12\"] } } }' \nConfiguration options specified from the command line will override those read\nfrom the config file.
\n\nUsing node labels \n\nNodes with specific features can be targeted using the nodeSelector field. The\nfollowing example shows how to target nodes with Intel TurboBoost enabled.
\n\napiVersion : v1 \nkind : Pod \nmetadata : \n labels : \n env : test \n name : golang-test \nspec : \n containers : \n - image : golang \n name : go1 \n nodeSelector : \n feature.node.kubernetes.io/cpu-pstate.turbo : ' true' \nFor more details on targeting nodes, see\nnode selection .
\n\nUninstallation \n\nOperator was used for deployment \n\nIf you followed the deployment instructions above you can simply do:
\n\nkubectl -n nfd delete NodeFeatureDiscovery my-nfd-deployment\nOptionally, you can also remove the namespace:
\n\n\n\nSee the node-feature-discovery-operator and OLM project\ndocumentation for instructions for uninstalling the operator and operator\nlifecycle manager, respectively.
\n\nManual \n\nSimplest way is to invoke kubectl delete on the deployment files you used.\nBeware that this will also delete the namespace that NFD is running in. For\nexample, in case the default deployment from the repo was used:
\n\n\nkubectl delete -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref= master\nAlternatively you can delete create objects one-by-one, depending on the type\nof deployment, for example:
\n\nNFD_NS = node-feature-discovery\nkubectl -n $NFD_NS delete ds nfd-worker\nkubectl -n $NFD_NS delete deploy nfd-master\nkubectl -n $NFD_NS delete svc nfd-master\nkubectl -n $NFD_NS delete sa nfd-master\nkubectl delete clusterrole nfd-master\nkubectl delete clusterrolebinding nfd-master\nRemoving feature labels \n\nNFD-Master has a special -prune command line flag for removing all\nnfd-related node labels, annotations and extended resources from the cluster.
\n\nkubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prune?ref= master\nkubectl -n node-feature-discovery wait job.batch/nfd-prune --for = condition = complete && \\ \n kubectl delete -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prune?ref= master\nNOTE: You must run prune before removing the RBAC rules (serviceaccount,\nclusterrole and clusterrolebinding).
\n\n\n","dir":"/get-started/","name":"deployment-and-usage.md","path":"get-started/deployment-and-usage.md","url":"/get-started/deployment-and-usage.html"},{"title":"Worker config reference","layout":"default","sort":4,"content":"Configuration file reference of nfd-worker \n\nTable of contents \n\n\n core \n core.sleepInterval core.labelSources core.sources core.labelWhiteList core.noPublish core.klog \n sources \n sources.cpu sources.kernel soures.pci sources.usb sources.custom \n \n\nSee the\nsample configuration file \nfor a full example configuration.
\n\ncore \n\nThe core section contains common configuration settings that are not specific\nto any particular feature source.
\n\ncore.sleepInterval \n\ncore.sleepInterval specifies the interval between consecutive passes of\nfeature (re-)detection, and thus also the interval between node re-labeling. A\nnon-positive value implies infinite sleep interval, i.e. no re-detection or\nre-labeling is done.
\n\nNote: Overridden by the deprecated -sleep-interval command line flag (if\nspecified).
\n\nDefault: 60s
\n\nExample:
\n\ncore : \n sleepInterval : 60s \ncore.labelSources \n\ncore.labelSources specifies the list of enabled label sources. A special\nvalue all enables all sources.
\n\nNote: Overridden by the -label-sources command line flag (if specified).
\n\nDefault: [all]
\n\nExample:
\n\ncore : \n sources : \n - system \n - custom \ncore.sources \n\nDEPRECATED : use core.labelSources
\n\nNote: core.sources takes precedence over the core.labelSources\nconfiguration file option.
\n\ncore.labelWhiteList \n\ncore.labelWhiteList specifies a regular expression for filtering feature\nlabels based on the label name. Non-matching labels are not published.
\n\nNote: The regular expression is only matches against the “basename” part of the\nlabel, i.e. to the part of the name after ‘/’. The label prefix (or namespace)\nis omitted.
\n\nNote: Overridden by the deprecated -label-whitelist command line flag (if\nspecified).
\n\nDefault: null
\n\nExample:
\n\ncore : \n labelWhiteList : ' ^cpu-cpuid' \ncore.noPublish \n\nSetting core.noPublish to true disables all communication with the\nnfd-master. It is effectively a “dry-run” flag: nfd-worker runs feature\ndetection normally, but no labeling requests are sent to nfd-master.
\n\nNote: Overridden by the -no-publish command line flag (if specified).
\n\nDefault: false
\n\nExample:
\n\ncore : \n noPublish : true \ncore.klog \n\nThe following options specify the logger configuration. Most of which can be\ndynamically adjusted at run-time.
\n\nNote: The logger options can also be specified via command line flags which\ntake precedence over any corresponding config file options.
\n\n\n\nIf true, adds the file directory to the header of the log messages.
\n\nDefault: false
\n\nRun-time configurable: yes
\n\ncore.klog.alsologtostderr \n\nLog to standard error as well as files.
\n\nDefault: false
\n\nRun-time configurable: yes
\n\ncore.klog.logBacktraceAt \n\nWhen logging hits line file:N, emit a stack trace.
\n\nDefault: empty
\n\nRun-time configurable: yes
\n\ncore.klog.logDir \n\nIf non-empty, write log files in this directory.
\n\nDefault: empty
\n\nRun-time configurable: no
\n\ncore.klog.logFile \n\nIf non-empty, use this log file.
\n\nDefault: empty
\n\nRun-time configurable: no
\n\ncore.klog.logFileMaxSize \n\nDefines the maximum size a log file can grow to. Unit is megabytes. If the\nvalue is 0, the maximum file size is unlimited.
\n\nDefault: 1800
\n\nRun-time configurable: no
\n\ncore.klog.logtostderr \n\nLog to standard error instead of files
\n\nDefault: true
\n\nRun-time configurable: yes
\n\n\n\nIf true, avoid header prefixes in the log messages.
\n\nDefault: false
\n\nRun-time configurable: yes
\n\n\n\nIf true, avoid headers when opening log files.
\n\nDefault: false
\n\nRun-time configurable: no
\n\ncore.klog.stderrthreshold \n\nLogs at or above this threshold go to stderr (default 2)
\n\nRun-time configurable: yes
\n\ncore.klog.v \n\nNumber for the log level verbosity.
\n\nDefault: 0
\n\nRun-time configurable: yes
\n\ncore.klog.vmodule \n\nComma-separated list of pattern=N settings for file-filtered logging.
\n\nDefault: empty
\n\nRun-time configurable: yes
\n\nsources \n\nThe sources section contains feature source specific configuration parameters.
\n\nsources.cpu \n\nsources.cpu.cpuid \n\nsources.cpu.cpuid.attributeBlacklist \n\nPrevent publishing cpuid features listed in this option.
\n\nNote: overridden by sources.cpu.cpuid.attributeWhitelist (if specified)
\n\nDefault: [BMI1, BMI2, CLMUL, CMOV, CX16, ERMS, F16C, HTT, LZCNT, MMX, MMXEXT,\nNX, POPCNT, RDRAND, RDSEED, RDTSCP, SGX, SGXLC, SSE, SSE2, SSE3, SSE4.1,\nSSE4.2, SSSE3]
\n\nExample:
\n\nsources : \n cpu : \n cpuid : \n attributeBlacklist : [ MMX , MMXEXT ] \nsources.cpu.cpuid.attributeWhitelist \n\nOnly publish the cpuid features listed in this option.
\n\nNote: takes precedence over sources.cpu.cpuid.attributeBlacklist
\n\nDefault: empty
\n\nExample:
\n\nsources : \n cpu : \n cpuid : \n attributeWhitelist : [ AVX512BW , AVX512CD , AVX512DQ , AVX512F , AVX512VL ] \nsources.kernel \n\nsources.kernel.kconfigFile \n\nPath of the kernel config file. If empty, NFD runs a search in the well-known\nstandard locations.
\n\nDefault: empty
\n\nExample:
\n\nsources : \n kernel : \n kconfigFile : \" /path/to/kconfig\" \nsources.kernel.configOpts \n\nKernel configuration options to publish as feature labels.
\n\nDefault: [NO_HZ, NO_HZ_IDLE, NO_HZ_FULL, PREEMPT]
\n\nExample:
\n\nsources : \n kernel : \n configOpts : [ NO_HZ , X86 , DMI ] \nsoures.pci \n\nsoures.pci.deviceClassWhitelist \n\nList of PCI device class IDs for which to\npublish a label. Can be specified as a main class only (e.g. 03) or full\nclass-subclass combination (e.g. 0300) - the former implies that all\nsubclasses are accepted. The format of the labels can be further configured\nwith deviceLabelFields .
\n\nDefault: [\"03\", \"0b40\", \"12\"]
\n\nExample:
\n\nsources : \n pci : \n deviceClassWhitelist : [ \" 0200\" , \" 03\" ] \nsoures.pci.deviceLabelFields \n\nThe set of PCI ID fields to use when constructing the name of the feature\nlabel. Valid fields are class, vendor, device, subsystem_vendor and\nsubsystem_device.
\n\nDefault: [class, vendor]
\n\nExample:
\n\nsources : \n pci : \n deviceLabelFields : [ class , vendor , device ] \nWith the example config above NFD would publish labels like:\nfeature.node.kubernetes.io/pci-<class-id>_<vendor-id>_<device-id>.present=true
\n\nsources.usb \n\nsoures.usb.deviceClassWhitelist \n\nList of USB device class IDs for\nwhich to publish a feature label. The format of the labels can be further\nconfigured with deviceLabelFields .
\n\nDefault: [\"0e\", \"ef\", \"fe\", \"ff\"]
\n\nExample:
\n\nsources : \n usb : \n deviceClassWhitelist : [ \" ef\" , \" ff\" ] \nsoures.usb.deviceLabelFields \n\nThe set of USB ID fields from which to compose the name of the feature label.\nValid fields are class, vendor, device and serial.
\n\nDefault: [class, vendor, device]
\n\nExample:
\n\nsources : \n pci : \n deviceLabelFields : [ class , vendor ] \nWith the example config above NFD would publish labels like:\nfeature.node.kubernetes.io/usb-<class-id>_<vendor-id>.present=true
\n\nsources.custom \n\nList of rules to process in the custom feature source to create user-specific\nlabels. Refer to the documentation of the\ncustom feature source for details of\nthe available rules and their configuration.
\n\nDefault: empty
\n\nExample:
\n\nsource : \n custom : \n - name : \" my.custom.feature\" \n matchOn : \n - loadedKMod : [ \" e1000e\" ] \n - pciId : \n class : [ \" 0200\" ] \n vendor : [ \" 8086\" ] \nExamples and demos \n\nTable of contents \n\n\n Demos \n Usage demo Demo use case \n \n\nThis page contains usage examples and demos.
\n\nDemos \n\nUsage demo \n\n
\n\nDemo use case \n\nA demo on the benefits of using node feature discovery can be found in the\nsource code repository under\ndemo/ .
\n","dir":"/get-started/","name":"examples-and-demos.md","path":"get-started/examples-and-demos.md","url":"/get-started/examples-and-demos.html"},{"title":"Topology Updater Cmdline Reference","layout":"default","sort":5,"content":"NFD-Topology-Updater Commandline Flags \n\nTable of Contents \n\n\n NFD-Topology-Updater Commandline Flags \n -h, -help -version -server -ca-file -cert-file -key-file -server-name-override -no-publish -oneshot -sleep-interval -watch-namespace -kubelet-config-file -podresources-socket \n \n\nTo quickly view available command line flags execute nfd-topology-updater -help.\nIn a docker container:
\n\ndocker run gcr.io/k8s-staging-nfd/node-feature-discovery:master nfd-topology-updater -help \n-h, -help \n\nPrint usage and exit.
\n\n-version \n\nPrint version and exit.
\n\n-server \n\nThe -server flag specifies the address of the nfd-master endpoint where to\nconnect to.
\n\nDefault: localhost:8080
\n\nExample:
\n\nnfd-topology-updater -server = nfd-master.nfd.svc.cluster.local:443\n-ca-file \n\nThe -ca-file is one of the three flags (together with -cert-file and\n-key-file) controlling the mutual TLS authentication on the topology-updater side.\nThis flag specifies the TLS root certificate that is used for verifying the\nauthenticity of nfd-master.
\n\nDefault: empty
\n\nNote: Must be specified together with -cert-file and -key-file
\n\nExample:
\n\nnfd-topology-updater -ca-file = /opt/nfd/ca.crt -cert-file = /opt/nfd/updater.crt -key-file = /opt/nfd/updater.key\n-cert-file \n\nThe -cert-file is one of the three flags (together with -ca-file and\n-key-file) controlling mutual TLS authentication on the topology-updater\nside. This flag specifies the TLS certificate presented for authenticating\noutgoing requests.
\n\nDefault: empty
\n\nNote: Must be specified together with -ca-file and -key-file
\n\nExample:
\n\nnfd-topology-updater -cert-file = /opt/nfd/updater.crt -key-file = /opt/nfd/updater.key -ca-file = /opt/nfd/ca.crt\n-key-file \n\nThe -key-file is one of the three flags (together with -ca-file and\n-cert-file) controlling the mutual TLS authentication on topology-updater\nside. This flag specifies the private key corresponding the given certificate file\n(-cert-file) that is used for authenticating outgoing requests.
\n\nDefault: empty
\n\nNote: Must be specified together with -cert-file and -ca-file
\n\nExample:
\n\nnfd-topology-updater -key-file = /opt/nfd/updater.key -cert-file = /opt/nfd/updater.crt -ca-file = /opt/nfd/ca.crt\n-server-name-override \n\nThe -server-name-override flag specifies the common name (CN) which to\nexpect from the nfd-master TLS certificate. This flag is mostly intended for\ndevelopment and debugging purposes.
\n\nDefault: empty
\n\nExample:
\n\nnfd-topology-updater -server-name-override = localhost\n-no-publish \n\nThe -no-publish flag disables all communication with the nfd-master, making\nit a “dry-run” flag for nfd-topology-updater. NFD-Topology-Updater runs\nresource hardware topology detection normally, but no CR requests are sent to\nnfd-master.
\n\nDefault: false
\n\nExample:
\n\nnfd-topology-updater -no-publish \n-oneshot \n\nThe -oneshot flag causes nfd-topology-updater to exit after one pass of\nresource hardware topology detection.
\n\nDefault: false
\n\nExample:
\n\nnfd-topology-updater -oneshot -no-publish \n-sleep-interval \n\nThe -sleep-interval specifies the interval between resource hardware\ntopology re-examination (and CR updates). A non-positive value implies\ninfinite sleep interval, i.e. no re-detection is done.
\n\nDefault: 60s
\n\nExample:
\n\nnfd-topology-updater -sleep-interval = 1h\n-watch-namespace \n\nThe -watch-namespace specifies the namespace to ensure that resource\nhardware topology examination only happens for the pods running in the\nspecified namespace. Pods that are not running in the specified namespace\nare not considered during resource accounting. This is particularly useful\nfor testing/debugging purpose. A “*” value would mean that all the pods would\nbe considered during the accounting process.
\n\nDefault: “*”
\n\nExample:
\n\nnfd-topology-updater -watch-namespace = rte\n-kubelet-config-file \n\nThe -kubelet-config-file specifies the path to the Kubelet’s configuration\nfile.
\n\nDefault: /host-var/lib/kubelet/config.yaml
\n\nExample:
\n\nnfd-topology-updater -kubelet-config-file = /var/lib/kubelet/config.yaml\n-podresources-socket \n\nThe -podresources-socket specifies the path to the Unix socket where kubelet\nexports a gRPC service to enable discovery of in-use CPUs and devices, and to\nprovide metadata for them.
\n\nDefault: /host-var/lib/kubelet/pod-resources/kubelet.sock
\n\nExample:
\n\nnfd-topology-updater -podresources-socket = /var/lib/kubelet/pod-resources/kubelet.sock\nDeployment and usage · Node Feature Discovery 2016-2021, Kubernetes SIGs Revision
master
\ No newline at end of file
diff --git a/master/get-started/examples-and-demos.html b/master/get-started/examples-and-demos.html
index 1b1a8a933..b72a7491d 100644
--- a/master/get-started/examples-and-demos.html
+++ b/master/get-started/examples-and-demos.html
@@ -1 +1 @@
- Examples and demos · Node Feature Discovery Examples and demos Table of contents Demos Usage demo Demo use case This page contains usage examples and demos.
Demos Usage demo
Demo use case A demo on the benefits of using node feature discovery can be found in the source code repository under demo/ .
2016-2021, Kubernetes SIGs Revision
master
\ No newline at end of file
+ Examples and demos · Node Feature Discovery Examples and demos Table of contents Demos Usage demo Demo use case This page contains usage examples and demos.
Demos Usage demo
Demo use case A demo on the benefits of using node feature discovery can be found in the source code repository under demo/ .
2016-2021, Kubernetes SIGs Revision
master
\ No newline at end of file
diff --git a/master/get-started/features.html b/master/get-started/features.html
index 35a23ec12..b5a892cf7 100644
--- a/master/get-started/features.html
+++ b/master/get-started/features.html
@@ -1,5 +1,5 @@
- features.md · Node Feature Discovery – title: "Feature discovery" layout: default sort: 4 —
Feature discovery Table of contents Feature labels Feature sources CPU Custom IOMMU Kernel Memory Network PCI USB Storage System Local – user-specific features Extended resources Feature discovery in nfd-worker is performed by a set of separate modules called feature sources. Most of them are specifically responsible for certain domain of features (e.g. cpu). In addition there are two highly customizable feature sources that work accross the system.
Feature labels Each discovered feature is advertised a label in the Kubernetes Node object. The published node labels encode a few pieces of information:
Namespace all built-in labels use feature.node.kubernetes.io user-specified custom labels (custom and local feature sources) feature.node.kubernetes.io and profile.node.kubernetes.io plus their sub-namespaces (e.g. vendor.profile.node.kubernetes.io and sub.ns.profile.node.kubernetes.io) are allowed by defaultadditional namespaces may be enabled with the -extra-label-ns The source for each label (e.g. cpu). The name of the discovered feature as it appears in the underlying source, (e.g. cpuid.AESNI from cpu). The value of the discovered feature. Feature label names adhere to the following pattern:
<namespace>/<source name>-<feature name>[.<attribute name>]
-The last component (i.e. attribute-name) is optional, and only used if a feature logically has sub-hierarchy, e.g. sriov.capable and sriov.configure from the network source.
The -sources flag controls which sources to use for discovery.
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 option.
Feature sources CPU The cpu feature source supports the following labels:
Feature name Attribute Description cpuid <cpuid flag> CPU capability is supported hardware_multithreading Hardware multithreading, such as Intel HTT, enabled (number of logical CPUs is greater than physical CPUs) power sst_bf.enabled Intel SST-BF (Intel Speed Select Technology - Base frequency) enabled pstate status The status of the Intel pstate driver when in use and enabled, either ‘active' or ‘passive'. turbo Set to ‘true' if turbo frequencies are enabled in Intel pstate driver, set to ‘false' if they have been disabled. scaling_governor The value of the Intel pstate scaling_governor when in use, either ‘powersave' or ‘performance'. cstate enabled 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. rdt RDTMON Intel RDT Monitoring Technology RDTCMT Intel Cache Monitoring (CMT) RDTMBM Intel Memory Bandwidth Monitoring (MBM) RDTL3CA Intel L3 Cache Allocation Technology RDTL2CA Intel L2 Cache Allocation Technology RDTMBA Intel Memory Bandwidth Allocation (MBA) Technology sgx enabled Set to ‘true' if Intel SGX is enabled in BIOS (based a non-zero sum value of SGX EPC section sizes).
The (sub-)set of CPUID attributes to publish is configurable via the attributeBlacklist and attributeWhitelist cpuid options of the cpu source. If whitelist is specified, only whitelisted attributes will be published. With blacklist, only blacklisted attributes are filtered out. attributeWhitelist has priority over attributeBlacklist. For examples and more information about configurability, see configuration . 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.
NOTE The cpuid features advertise supported CPU capabilities, that is, a capability might be supported but not enabled.
X86 CPUID attributes (partial list) Attribute 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)
See the full list in github.com/klauspost/cpuid .
Arm CPUID attribute (partial list) Attribute 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 attribute (partial list) Attribute 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
Custom The Custom feature source allows the user to define features based on a mix of predefined rules. A rule is provided input witch affects its process of matching for a defined feature. The rules are specified in the nfd-worker configuration file. See configuration for instructions and examples how to set-up and manage the worker configuration.
To aid in making Custom Features clearer, we define a general and a per rule nomenclature, keeping things as consistent as possible.
Additional configuration directory Additionally to the rules defined in the nfd-worker configuration file, the Custom feature can read more configuration files located in the /etc/kubernetes/node-feature-discovery/custom.d/ directory. This makes more dynamic and flexible configuration easier. This directory must be available inside the NFD worker container, so Volumes and VolumeMounts must be used for mounting e.g. ConfigMap(s). The example deployment manifests provide an example (commented out) for providing Custom configuration with an additional ConfigMap, mounted into the custom.d directory.
General nomenclature & definitions Rule :Represents a matching logic that is used to match on a feature.
+ features.md · Node Feature Discovery – title: "Feature discovery" layout: default sort: 4 —
Feature discovery Table of contents Feature labels Feature sources CPU Custom IOMMU Kernel Memory Network PCI USB Storage System Local – user-specific features Extended resources Feature discovery in nfd-worker is performed by a set of separate modules called feature sources. Most of them are specifically responsible for certain domain of features (e.g. cpu). In addition there are two highly customizable feature sources that work accross the system.
Feature labels Each discovered feature is advertised a label in the Kubernetes Node object. The published node labels encode a few pieces of information:
Namespace all built-in labels use feature.node.kubernetes.io user-specified custom labels (custom and local feature sources) feature.node.kubernetes.io and profile.node.kubernetes.io plus their sub-namespaces (e.g. vendor.profile.node.kubernetes.io and sub.ns.profile.node.kubernetes.io) are allowed by defaultadditional namespaces may be enabled with the -extra-label-ns The source for each label (e.g. cpu). The name of the discovered feature as it appears in the underlying source, (e.g. cpuid.AESNI from cpu). The value of the discovered feature. Feature label names adhere to the following pattern:
<namespace>/<source name>-<feature name>[.<attribute name>]
+The last component (i.e. attribute-name) is optional, and only used if a feature logically has sub-hierarchy, e.g. sriov.capable and sriov.configure from the network source.
The -label-sources flag controls which sources to enable for label generation.
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 option.
Feature sources CPU The cpu feature source supports the following labels:
Feature name Attribute Description cpuid <cpuid flag> CPU capability is supported hardware_multithreading Hardware multithreading, such as Intel HTT, enabled (number of logical CPUs is greater than physical CPUs) power sst_bf.enabled Intel SST-BF (Intel Speed Select Technology - Base frequency) enabled pstate status The status of the Intel pstate driver when in use and enabled, either ‘active' or ‘passive'. turbo Set to ‘true' if turbo frequencies are enabled in Intel pstate driver, set to ‘false' if they have been disabled. scaling_governor The value of the Intel pstate scaling_governor when in use, either ‘powersave' or ‘performance'. cstate enabled 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. rdt RDTMON Intel RDT Monitoring Technology RDTCMT Intel Cache Monitoring (CMT) RDTMBM Intel Memory Bandwidth Monitoring (MBM) RDTL3CA Intel L3 Cache Allocation Technology RDTL2CA Intel L2 Cache Allocation Technology RDTMBA Intel Memory Bandwidth Allocation (MBA) Technology sgx enabled Set to ‘true' if Intel SGX is enabled in BIOS (based a non-zero sum value of SGX EPC section sizes).
The (sub-)set of CPUID attributes to publish is configurable via the attributeBlacklist and attributeWhitelist cpuid options of the cpu source. If whitelist is specified, only whitelisted attributes will be published. With blacklist, only blacklisted attributes are filtered out. attributeWhitelist has priority over attributeBlacklist. For examples and more information about configurability, see configuration . 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.
NOTE The cpuid features advertise supported CPU capabilities, that is, a capability might be supported but not enabled.
X86 CPUID attributes (partial list) Attribute 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)
See the full list in github.com/klauspost/cpuid .
Arm CPUID attribute (partial list) Attribute 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 attribute (partial list) Attribute 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
Custom The Custom feature source allows the user to define features based on a mix of predefined rules. A rule is provided input witch affects its process of matching for a defined feature. The rules are specified in the nfd-worker configuration file. See configuration for instructions and examples how to set-up and manage the worker configuration.
To aid in making Custom Features clearer, we define a general and a per rule nomenclature, keeping things as consistent as possible.
Additional configuration directory Additionally to the rules defined in the nfd-worker configuration file, the Custom feature can read more configuration files located in the /etc/kubernetes/node-feature-discovery/custom.d/ directory. This makes more dynamic and flexible configuration easier. This directory must be available inside the NFD worker container, so Volumes and VolumeMounts must be used for mounting e.g. ConfigMap(s). The example deployment manifests provide an example (commented out) for providing Custom configuration with an additional ConfigMap, mounted into the custom.d directory.
General nomenclature & definitions Rule :Represents a matching logic that is used to match on a feature.
Rule Input :The input a Rule is provided. This determines how a Rule performs the match operation.
Matcher :A composition of Rules, each Matcher may be composed of at most one instance of each Rule.
Rules are specified under sources.custom in the nfd-worker configuration file.
sources :
@@ -101,4 +101,4 @@ feature.node.kubernetes.io/override_source-OVERRIDE_VALUE=123
override.namespace/value=456
NFD tries to run any regular files found from the hooks directory. Any additional data files your hook might need (e.g. a configuration file) should be placed in a separate directory in order to avoid NFD unnecessarily trying to execute these. You can use a subdirectory under the hooks directory, for example /etc/kubernetes/node-feature-discovery/source.d/conf/.
NOTE! NFD will blindly run any executables placed/mounted in the hooks directory. It is the user's responsibility to review the hooks for e.g. possible security implications.
NOTE! Be careful when creating and/or updating hook or feature files while NFD is running. In order to avoid race conditions you should write into a temporary file (outside the source.d and features.d directories), and, atomically create/update the original file by doing a filesystem move operation.
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>
- 2016-2021, Kubernetes SIGs Revision
master
\ No newline at end of file
+ 2016-2021, Kubernetes SIGs Revision
master
\ No newline at end of file
diff --git a/master/get-started/features.md b/master/get-started/features.md
index 7fa16a8fb..e1f84ac8e 100644
--- a/master/get-started/features.md
+++ b/master/get-started/features.md
@@ -50,7 +50,8 @@ The last component (i.e. `attribute-name`) is optional, and only used if a
feature logically has sub-hierarchy, e.g. `sriov.capable` and
`sriov.configure` from the `network` source.
-The `-sources` flag controls which sources to use for discovery.
+The `-label-sources` flag controls which sources to enable for label
+generation.
*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
diff --git a/master/get-started/index.html b/master/get-started/index.html
index c8c8d3752..2ed233295 100644
--- a/master/get-started/index.html
+++ b/master/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:
Quick-start – the short-short version $ kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref= master
+ 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:
Quick-start – the short-short version $ kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref= master
namespace/node-feature-discovery created
serviceaccount/nfd-master created
clusterrole.rbac.authorization.k8s.io/nfd-master created
@@ -22,4 +22,4 @@
"feature.node.kubernetes.io/cpu-cpuid.AESNI" : "true" ,
...
- 2016-2021, Kubernetes SIGs Revision
master
\ No newline at end of file
+ 2016-2021, Kubernetes SIGs Revision
master
\ No newline at end of file
diff --git a/master/get-started/introduction.html b/master/get-started/introduction.html
index 30eea45d7..88e2fb0b8 100644
--- a/master/get-started/introduction.html
+++ b/master/get-started/introduction.html
@@ -1,4 +1,4 @@
- Introduction · Node Feature Discovery Introduction Table of contents NFD-Master NFD-Worker NFD-Topology-Updater Feature Discovery Node annotations NodeResourceTopology CR 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.
NFD consists of three software components:
nfd-master nfd-worker nfd-topology-updater 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 communicates the information to nfd-master which does the NodeResourceTopology CR creation corresponding to all the nodes in the cluster. One instance of nfd-topology-updater is supposed to be running on each node of the cluster.
Feature Discovery Feature discovery is divided into domain-specific feature sources:
CPU IOMMU 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 NFD-Master NFD-Worker NFD-Topology-Updater Feature Discovery Node annotations NodeResourceTopology CR 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.
NFD consists of three software components:
nfd-master nfd-worker nfd-topology-updater 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 communicates the information to nfd-master which does the NodeResourceTopology CR creation corresponding to all the nodes in the cluster. One instance of nfd-topology-updater is supposed to be running on each node of the cluster.
Feature Discovery Feature discovery is divided into domain-specific feature sources:
CPU IOMMU 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/iommu-<feature-name>" : "true" ,
@@ -50,4 +50,4 @@
capacity : 3
allocatable : 3
available : 3
- 2016-2021, Kubernetes SIGs Revision
master
\ No newline at end of file
+ 2016-2021, Kubernetes SIGs Revision
master
\ No newline at end of file
diff --git a/master/get-started/quick-start.html b/master/get-started/quick-start.html
index bcdaad371..dfd4d4a71 100644
--- a/master/get-started/quick-start.html
+++ b/master/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= master
+ 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= master
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
@@ -91,4 +91,4 @@ Zones:
Available: 2
Type: Node
Events: <none>
-The CR instances created can be used to gain insight into the allocatable resources along with the granularity of those resources at a per-zone level (represented by node-0 and node-1 in the above example) or can be used by an external entity (e.g. topology-aware scheduler plugin) to take an action based on the gathered information.
2016-2021, Kubernetes SIGs Revision
master
\ No newline at end of file
+The CR instances created can be used to gain insight into the allocatable resources along with the granularity of those resources at a per-zone level (represented by node-0 and node-1 in the above example) or can be used by an external entity (e.g. topology-aware scheduler plugin) to take an action based on the gathered information.
2016-2021, Kubernetes SIGs Revision
master
\ No newline at end of file
diff --git a/master/search.html b/master/search.html
index dfd3e3a33..97083f85f 100644
--- a/master/search.html
+++ b/master/search.html
@@ -1 +1 @@
- Search · Node Feature Discovery 2016-2021, Kubernetes SIGs Revision
master
\ No newline at end of file
+ Search · Node Feature Discovery 2016-2021, Kubernetes SIGs Revision
master
\ No newline at end of file
diff --git a/master/sitemap.xml b/master/sitemap.xml
index 3958e53ec..2ecc50ce6 100644
--- a/master/sitemap.xml
+++ b/master/sitemap.xml
@@ -1 +1 @@
- https://kubernetes-sigs.github.com/node-feature-discovery/master/get-started/features.html 1.0 2021-12-01T08:54:43-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/get-started/ 1.0 2021-12-01T08:54:43-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/advanced/developer-guide.html 1.0 2021-12-01T08:54:43-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/get-started/introduction.html 1.0 2021-12-01T08:54:43-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/advanced/ 0.1 2021-12-01T08:54:43-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/advanced/master-commandline-reference.html 1.0 2021-12-01T08:54:43-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/get-started/quick-start.html 1.0 2021-12-01T08:54:43-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/contributing/ 0.5 2021-12-01T08:54:43-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/advanced/worker-commandline-reference.html 1.0 2021-12-01T08:54:43-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/get-started/deployment-and-usage.html 1.0 2021-12-01T08:54:43-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/advanced/worker-configuration-reference.html 1.0 2021-12-01T08:54:43-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/get-started/examples-and-demos.html 0.5 2021-12-01T08:54:43-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/advanced/topology-updater-commandline-reference.html 1.0 2021-12-01T08:54:43-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/get-started/features.html 1.0 2021-12-01T09:34:39-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/get-started/ 1.0 2021-12-01T09:34:39-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/advanced/developer-guide.html 1.0 2021-12-01T09:34:39-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/get-started/introduction.html 1.0 2021-12-01T09:34:39-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/advanced/ 0.1 2021-12-01T09:34:39-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/advanced/master-commandline-reference.html 1.0 2021-12-01T09:34:39-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/get-started/quick-start.html 1.0 2021-12-01T09:34:39-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/contributing/ 0.5 2021-12-01T09:34:39-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/advanced/worker-commandline-reference.html 1.0 2021-12-01T09:34:39-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/get-started/deployment-and-usage.html 1.0 2021-12-01T09:34:39-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/advanced/worker-configuration-reference.html 1.0 2021-12-01T09:34:39-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/get-started/examples-and-demos.html 0.5 2021-12-01T09:34:39-06:00 https://kubernetes-sigs.github.com/node-feature-discovery/master/advanced/topology-updater-commandline-reference.html 1.0 2021-12-01T09:34:39-06:00