404
Not Found
![\"asciicast\"](\"https://asciinema.org/a/247316.svg\")
Not Found
Not Found
You can reach us via the following channels:
This is a SIG-node subproject, hosted under the Kubernetes SIGs organization in Github. The project was established in 2016 and was migrated to Kubernetes SIGs in 2018.
This is open source software released under the Apache 2.0 License.
You can reach us via the following channels:
This is a SIG-node subproject, hosted under the Kubernetes SIGs organization in Github. The project was established in 2016 and was migrated to Kubernetes SIGs in 2018.
This is open source software released under the Apache 2.0 License.
Features are advertised as labels in the Kubernetes Node object.
\n\nLabel creation in nfd-worker is performed by a set of separate modules called\nlabel sources. The\ncore.labelSources\nconfiguration option (or\n-label-sources\nflag) of nfd-worker controls which sources to enable for label generation.
All built-in labels use the feature.node.kubernetes.io label namespace and\nhave the following format.
feature.node.kubernetes.io/<feature> = <value>\n\n\n\nNOTE: 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\n
\n-label-whitelist\nflag of nfd-master or\ncore.labelWhiteList\noption of nfd-worker.
| Feature name | \nValue | \nDescription | \n
|---|---|---|
cpu-cpuid.<cpuid-flag> | \n true | \nCPU capability is supported. NOTE: the capability might be supported but not enabled. | \n
cpu-hardware_multithreading | \n true | \nHardware multithreading, such as Intel HTT, enabled (number of logical CPUs is greater than physical CPUs) | \n
cpu-coprocessor.nx_gzip | \n true | \nNest Accelerator for GZIP is supported(Power). | \n
cpu-power.sst_bf.enabled | \n true | \nIntel SST-BF (Intel Speed Select Technology - Base frequency) enabled | \n
cpu-pstate.status | \n string | \nThe status of the Intel pstate driver when in use and enabled, either ‘active’ or ‘passive’. | \n
cpu-pstate.turbo | \n bool | \nSet to ‘true’ if turbo frequencies are enabled in Intel pstate driver, set to ‘false’ if they have been disabled. | \n
cpu-pstate.scaling_governor | \n string | \nThe value of the Intel pstate scaling_governor when in use, either ‘powersave’ or ‘performance’. | \n
cpu-cstate.enabled | \n bool | \nSet 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
cpu-rdt.<rdt-flag> | \n true | \nIntel RDT capability is supported. See RDT flags for details. | \n
cpu-security.sgx.enabled | \n true | \nSet to ‘true’ if Intel SGX is enabled in BIOS (based a non-zero sum value of SGX EPC section sizes). | \n
cpu-security.se.enabled | \n true | \nSet to ‘true’ if IBM Secure Execution for Linux (IBM Z & LinuxONE) is available and enabled (requires /sys/firmware/uv/prot_virt_host facility) | \n
cpu-security.tdx.enabled | \n true | \nSet to ‘true’ if Intel TDX is available on the host and has been enabled (requires /sys/module/kvm_intel/parameters/tdx). | \n
cpu-sgx.enabled | \n true | \nDEPRECATED: use cpu-security.sgx.enabled instead. | \n
cpu-se.enabled | \n true | \nDEPRECATED: use cpu-security.se.enabled instead. | \n
cpu-model.vendor_id | \n string | \nComparable CPU vendor ID. | \n
cpu-model.family | \n int | \nCPU family. | \n
cpu-model.id | \n int | \nCPU model number. | \n
The CPU label source is configurable, see\nworker configuration and\nsources.cpu\nconfiguration options for details.
| Flag | \nDescription | \n
|---|---|
| ADX | \nMulti-Precision Add-Carry Instruction Extensions (ADX) | \n
| AESNI | \nAdvanced Encryption Standard (AES) New Instructions (AES-NI) | \n
| AVX | \nAdvanced Vector Extensions (AVX) | \n
| AVX2 | \nAdvanced Vector Extensions 2 (AVX2) | \n
| AVXVNNI | \nAVX (VEX encoded) VNNI neural network instructions | \n
| AMXBF16 | \nAdvanced Matrix Extension, tile multiplication operations on BFLOAT16 numbers | \n
| AMXINT8 | \nAdvanced Matrix Extension, tile multiplication operations on 8-bit integers | \n
| AMXFP16 | \nAdvanced Matrix Extension, tile multiplication operations on FP16 numbers | \n
| AMXTILE | \nAdvanced Matrix Extension, base tile architecture support | \n
| AVX512BF16 | \nAVX-512 BFLOAT16 instructions | \n
| AVX512BITALG | \nAVX-512 bit Algorithms | \n
| AVX512BW | \nAVX-512 byte and word Instructions | \n
| AVX512CD | \nAVX-512 conflict detection instructions | \n
| AVX512DQ | \nAVX-512 doubleword and quadword instructions | \n
| AVX512ER | \nAVX-512 exponential and reciprocal instructions | \n
| AVX512F | \nAVX-512 foundation | \n
| AVX512FP16 | \nAVX-512 FP16 instructions | \n
| AVX512IFMA | \nAVX-512 integer fused multiply-add instructions | \n
| AVX512PF | \nAVX-512 prefetch instructions | \n
| AVX512VBMI | \nAVX-512 vector bit manipulation instructions | \n
| AVX512VBMI2 | \nAVX-512 vector bit manipulation instructions, version 2 | \n
| AVX512VL | \nAVX-512 vector length extensions | \n
| AVX512VNNI | \nAVX-512 vector neural network instructions | \n
| AVX512VP2INTERSECT | \nAVX-512 intersect for D/Q | \n
| AVX512VPOPCNTDQ | \nAVX-512 vector population count doubleword and quadword | \n
| AVXIFMA | \nAVX-IFMA instructions | \n
| AVXNECONVERT | \nAVX-NE-CONVERT instructions | \n
| AVXVNNIINT8 | \nAVX-VNNI-INT8 instructions | \n
| CMPCCXADD | \nCMPCCXADD instructions | \n
| ENQCMD | \nEnqueue Command | \n
| GFNI | \nGalois Field New Instructions | \n
| HYPERVISOR | \nRunning under hypervisor | \n
| MSRLIST | \nRead/Write List of Model Specific Registers | \n
| PREFETCHI | \nPREFETCHIT0/1 instructions | \n
| VAES | \nAVX-512 vector AES instructions | \n
| VPCLMULQDQ | \nCarry-less multiplication quadword | \n
| WRMSRNS | \nNon-Serializing Write to Model Specific Register | \n
By default, the following CPUID flags have been blacklisted: BMI1, BMI2, CLMUL,\nCMOV, CX16, ERMS, F16C, HTT, LZCNT, MMX, MMXEXT, NX, POPCNT, RDRAND, RDSEED,\nRDTSCP, SGX, SSE, SSE2, SSE3, SSE4, SSE42 and SSSE3. See\nsources.cpu\nconfiguration options to change the behavior.
See the full list in github.com/klauspost/cpuid.
\n\n| Flag | \nDescription | \n
|---|---|
| IDIVA | \nInteger divide instructions available in ARM mode | \n
| IDIVT | \nInteger divide instructions available in Thumb mode | \n
| THUMB | \nThumb instructions | \n
| FASTMUL | \nFast multiplication | \n
| VFP | \nVector floating point instruction extension (VFP) | \n
| VFPv3 | \nVector floating point extension v3 | \n
| VFPv4 | \nVector floating point extension v4 | \n
| VFPD32 | \nVFP with 32 D-registers | \n
| HALF | \nHalf-word loads and stores | \n
| EDSP | \nDSP extensions | \n
| NEON | \nNEON SIMD instructions | \n
| LPAE | \nLarge Physical Address Extensions | \n
| Flag | \nDescription | \n
|---|---|
| AES | \nAnnouncing the Advanced Encryption Standard | \n
| EVSTRM | \nEvent Stream Frequency Features | \n
| FPHP | \nHalf Precision(16bit) Floating Point Data Processing Instructions | \n
| ASIMDHP | \nHalf Precision(16bit) Asimd Data Processing Instructions | \n
| ATOMICS | \nAtomic Instructions to the A64 | \n
| ASIMRDM | \nSupport for Rounding Double Multiply Add/Subtract | \n
| PMULL | \nOptional Cryptographic and CRC32 Instructions | \n
| JSCVT | \nPerform Conversion to Match Javascript | \n
| DCPOP | \nPersistent Memory Support | \n
| Flag | \nDescription | \n
|---|---|
| RDTMON | \nIntel RDT Monitoring Technology | \n
| RDTCMT | \nIntel Cache Monitoring (CMT) | \n
| RDTMBM | \nIntel Memory Bandwidth Monitoring (MBM) | \n
| RDTL3CA | \nIntel L3 Cache Allocation Technology | \n
| RDTl2CA | \nIntel L2 Cache Allocation Technology | \n
| RDTMBA | \nIntel Memory Bandwidth Allocation (MBA) Technology | \n
| Feature | \nValue | \nDescription | \n
|---|---|---|
kernel-config.<option> | \n true | \nKernel config option is enabled (set ‘y’ or ‘m’). Default options are NO_HZ, NO_HZ_IDLE, NO_HZ_FULL and PREEMPT | \n
kernel-selinux.enabled | \n true | \nSelinux is enabled on the node | \n
kernel-version.full | \n string | \nFull kernel version as reported by /proc/sys/kernel/osrelease (e.g. ‘4.5.6-7-g123abcde’) | \n
kernel-version.major | \n string | \nFirst component of the kernel version (e.g. ‘4’) | \n
kernel-version.minor | \n string | \nSecond component of the kernel version (e.g. ‘5’) | \n
kernel-version.revision | \n string | \nThird component of the kernel version (e.g. ‘6’) | \n
The kernel label source is configurable, see\nworker configuration and\nsources.kernel\nconfiguration options for details.
| Feature | \nValue | \nDescription | \n
|---|---|---|
memory-numa | \n true | \nMultiple memory nodes i.e. NUMA architecture detected | \n
memory-nv.present | \n true | \nNVDIMM device(s) are present | \n
memory-nv.dax | \n true | \nNVDIMM region(s) configured in DAX mode are present | \n
| Feature | \nValue | \nDescription | \n
|---|---|---|
network-sriov.capable | \n true | \nSingle Root Input/Output Virtualization (SR-IOV) enabled Network Interface Card(s) present | \n
network-sriov.configured | \n true | \nSR-IOV virtual functions have been configured | \n
| Feature | \nValue | \nDescription | \n
|---|---|---|
pci-<device label>.present | \n true | \nPCI device is detected | \n
pci-<device label>.sriov.capable | \n true | \nSingle Root Input/Output Virtualization (SR-IOV) enabled PCI device present | \n
<device label> is format is configurable and set to <class>_<vendor> by\ndefault. For more more details about configuration of the pci labels, see\nsources.pci options\nand worker configuration\ninstructions.
| Feature | \nValue | \nDescription | \n
|---|---|---|
usb-<device label>.present | \n true | \nUSB device is detected | \n
<device label> is format is configurable and set to\n<class>_<vendor>_<device> by default. For more more details about\nconfiguration of the usb labels, see\nsources.usb options\nand worker configuration\ninstructions.
| Feature | \nValue | \nDescription | \n
|---|---|---|
storage-nonrotationaldisk | \n true | \nNon-rotational disk, like SSD, is present in the node | \n
| Feature | \nValue | \nDescription | \n
|---|---|---|
system-os_release.ID | \n string | \nOperating system identifier | \n
system-os_release.VERSION_ID | \n string | \nOperating system version identifier (e.g. ‘6.7’) | \n
system-os_release.VERSION_ID.major | \n string | \nFirst component of the OS version id (e.g. ‘6’) | \n
system-os_release.VERSION_ID.minor | \n string | \nSecond component of the OS version id (e.g. ‘7’) | \n
The custom label source is designed for creating\nuser defined labels. However, it has a few statically\ndefined built-in labels:
\n\n| Feature | \nValue | \nDescription | \n
|---|---|---|
custom-rdma.capable | \n true | \nThe node has an RDMA capable Network adapter | \n
custom-rdma.enabled | \n true | \nThe node has the needed RDMA modules loaded to run RDMA traffic | \n
NFD has many extension points for creating vendor and application specific\nlabels. See the customization guide for\ndetailed documentation.
\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.
An 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.
Similar 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.
Example usage of the command line arguments, using a new namespace:\nnfd-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\nlabels exist:
\n\n sgx.some.ns/epc: <label value>\n feature.node.kubernetes.io/my_source-my.feature: <label value>\nWelcome to Node Feature Discovery – a Kubernetes add-on for detecting hardware\nfeatures and system configuration!
\n\nContinue to:
\n\nIntroduction for more details on the\nproject.
\nQuick start for quick step-by-step\ninstructions on how to get NFD running on your cluster.
\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 nodes -o json | jq .items[].metadata.labels\n {\n \"kubernetes.io/arch\": \"amd64\",\n \"kubernetes.io/os\": \"linux\",\n \"feature.node.kubernetes.io/cpu-cpuid.ADX\": \"true\",\n \"feature.node.kubernetes.io/cpu-cpuid.AESNI\": \"true\",\n...\n\nNFD currently offers two variants of the container image. The “minimal” variant is\ncurrently deployed by default. Released container images are available for\nx86_64 and Arm64 architectures.
\n\nThis is a minimal image based on\ngcr.io/distroless/base\nand only supports running statically linked binaries.
\n\nFor backwards compatibility a container image tag with suffix -minimal\n(e.g. gcr.io/k8s-staging-nfd/node-feature-discovery:master-minimal) is provided.
This image is based on debian:bullseye-slim\nand contains a full Linux system for running shell-based nfd-worker hooks and\ndoing live debugging and diagnosis of the NFD images.
\n\nThe container image tag has suffix -full\n(e.g. gcr.io/k8s-staging-nfd/node-feature-discovery:master-full).
This 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 and optionally node taints.
\n\nNFD consists of four software components:
\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 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 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\ncreates or updates a\nNodeResourceTopology custom\nresource object specific to this node. One instance of nfd-topology-updater is\nsupposed to be running on each node of the cluster.
\n\nNFD-Topology-GC is a daemon responsible for cleaning obsolete\nNodeResourceTopology objects,\nobsolete means that there is no corresponding worker node.
\n\nOne instance of nfd-topology-gc is supposed to be running in the cluster.
\n\nFeature discovery is divided into domain-specific feature sources:
\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.
An 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/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}\nNFD also annotates nodes it is running on:
\n\n| Annotation | \nDescription | \n
|---|---|
| [<instance>.]nfd.node.kubernetes.io/master.version | \nVersion of the nfd-master instance running on the node. Informative use only. | \n
| [<instance>.]nfd.node.kubernetes.io/worker.version | \nVersion of the nfd-worker instance running on the node. Informative use only. | \n
| [<instance>.]nfd.node.kubernetes.io/feature-labels | \nComma-separated list of node labels managed by NFD. NFD uses this internally so must not be edited by users. | \n
| [<instance>.]nfd.node.kubernetes.io/extended-resources | \nComma-separated list of node extended resources managed by NFD. NFD uses this internally so must not be edited by users. | \n
NOTE: the -instance\ncommand line flag affects the annotation names
Unapplicable annotations are not created, i.e. for example master.version is\nonly created on nodes running nfd-master.
\n\nNFD takes use of some Kubernetes Custom Resources.
\n\nNodeFeatures (EXPERIMENTAL)\ncan be used for representing node features and requesting node labels to be\ngenerated.
\n\nNFD-Master uses NodeFeatureRules\nfor custom labeling of nodes.
\n\nNFD-Topology-Updater creates\nNodeResourceTopology objects\nthat describe the hardware topology of node resources.
\n","dir":"/get-started/","name":"introduction.md","path":"get-started/introduction.md","url":"/get-started/introduction.html"},{"title":"Master cmdline reference","layout":"default","sort":1,"content":"To quickly view available command line flags execute nfd-master -help.\nIn a docker container:
docker run gcr.io/k8s-staging-nfd/node-feature-discovery:master nfd-master -help\nPrint usage and exit.
\n\nPrint version and exit.
\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.
The -port flag specifies the TCP port that nfd-master listens for incoming requests.
Default: 8080
\n\nExample:
\n\nnfd-master -port=443\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 ..
Default: empty
\n\nExample:
\n\nnfd-master -instance=network\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.
Default: empty
\n\nNote: Must be specified together with -cert-file and -key-file
Example:
\n\nnfd-master -ca-file=/opt/nfd/ca.crt -cert-file=/opt/nfd/master.crt -key-file=/opt/nfd/master.key\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.
Default: empty
\n\nNote: Must be specified together with -ca-file and -key-file
Example:
\n\nnfd-master -cert-file=/opt/nfd/master.crt -key-file=/opt/nfd/master.key -ca-file=/opt/nfd/ca.crt\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.
Default: empty
\n\nNote: Must be specified together with -cert-file and -ca-file
Example:
\n\nnfd-master -key-file=/opt/nfd/master.key -cert-file=/opt/nfd/master.crt -ca-file=/opt/nfd/ca.crt\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).
Node 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\nThe -enable-nodefeature-api flag enables the\nNodeFeature CRD API for receiving\nfeature requests. This will also automatically disable the gRPC interface.
Default: false
\n\nExample:
\n\nnfd-master -enable-nodefeature-api\nThe -enable-taints flag enables/disables node tainting feature of NFD.
Default: false
\n\nExample:
\n\nnfd-master -enable-taints=true\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.
Default: false
\n\nExample:
\n\nnfd-master -no-publish\nThe -crd-controller flag specifies whether the NFD CRD API controller is\nenabled or not. The controller is responsible for processing\nNodeFeature and\nNodeFeatureRule objects.
Default: true
\n\nExample:
\n\nnfd-master -crd-controller=false\nDEPRECATED: use -crd-controller instead.
The -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.
Note: 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. This option can be used to allow\nother vendor or application specific namespaces for custom labels from the\nlocal and custom feature sources, even though these labels were denied using\nthe deny-label-ns flag.
The same namespace control and this flag applies Extended Resources (created\nwith -resource-labels), too.
Default: empty
\n\nExample:
\n\nnfd-master -extra-label-ns=vendor-1.com,vendor-2.io\nThe -deny-label-ns flag specifies a comma-separated list of excluded\nlabel namespaces. By default, nfd-master allows creating labels in all\nnamespaces, excluding kubernetes.io namespace and its sub-namespaces\n(i.e. *.kubernetes.io). However, you should note that\nkubernetes.io and its sub-namespaces are always denied.\nFor example, nfd-master -deny-label-ns=\"\" would still disallow\nkubernetes.io and *.kubernetes.io.\nThis option can be used to exclude some vendors or application specific\nnamespaces.\nNote that the namespaces feature.node.kubernetes.io and profile.node.kubernetes.io\nand their sub-namespaces are always allowed and cannot be denied.
Default: empty
\n\nExample:
\n\nnfd-master -deny-label-ns=*.vendor.com,vendor-2.io\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.
Default: empty
\n\nExample:
\n\nnfd-master -resource-labels=vendor-1.com/feature-1,vendor-2.io/feature-2\nThe following logging-related flags are inherited from the\nklog package.
\n\nIf true, adds the file directory to the header of the log messages.
\n\nDefault: false
\n\nLog to standard error as well as files.
\n\nDefault: false
\n\nWhen logging hits line file:N, emit a stack trace.
\n\nDefault: empty
\n\nIf non-empty, write log files in this directory.
\n\nDefault: empty
\n\nIf non-empty, use this log file.
\n\nDefault: empty
\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\nLog to standard error instead of files
\n\nDefault: true
\n\nIf true, avoid header prefixes in the log messages.
\n\nDefault: false
\n\nIf true, avoid headers when opening log files.
\n\nDefault: false
\n\nLogs at or above this threshold go to stderr.
\n\nDefault: 2
\n\nNumber for the log level verbosity.
\n\nDefault: 0
\n\nComma-separated list of pattern=N settings for file-filtered logging.
Default: empty
\n","dir":"/reference/","name":"master-commandline-reference.md","path":"reference/master-commandline-reference.md","url":"/reference/master-commandline-reference.html"},{"title":"Using node labels","layout":"default","sort":2,"content":"Nodes with specific features can be targeted using the nodeSelector field. The\nfollowing example shows how to target nodes with Intel TurboBoost enabled.
apiVersion: 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","dir":"/usage/","name":"using-labels.md","path":"usage/using-labels.md","url":"/usage/using-labels.html"},{"title":"Kustomize","layout":"default","sort":2,"content":"Kustomize provides easy\ndeployment of NFD. Customization of the deployment is done by maintaining\ndeclarative overlays on top of the base overlays in NFD.
\n\nTo follow the deployment instructions here,\nkubectl v1.21 or\nlater is required.
\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.
NOTE: nfd-topology-updater is not deployed as part of the default overlay.\nPlease refer to the Master Worker Topologyupdater\nand Topologyupdater below.
Alternatively you can clone the repository and customize the deployment by\ncreating your own overlays. For example, to deploy the\nminimal image. See kustomize for more\ninformation about managing deployment configurations.
\n\nThe NFD repository hosts a set of overlays for different usages and deployment\nscenarios under\ndeployment/overlays
default:\ndefault deployment of nfd-worker as a daemonset, described abovedefault-combined\nsee Master-worker pod belowdefault-job:\nsee Worker one-shot belowmaster-worker-topologyupdater:\nsee Master Worker Topologyupdater belowtopologyupdater:\nsee Topology Updater belowprune:\nclean up the cluster after uninstallation, see\nRemoving feature labelssamples/cert-manager:\nan example for supplementing the default deployment with cert-manager for TLS\nauthentication, see\nAutomated TLS certificate management using cert-manager\nfor detailssamples/custom-rules:\nan example for spicing up the default deployment with a separately managed\nconfigmap of custom labeling rules, see\nCustom feature source for more information about\ncustom node labelsYou 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\nFeature discovery can alternatively be configured as a one-shot job.\nThe default-job overlay may be used to achieve this:
NUM_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\nNFD-Master, nfd-worker and nfd-topology-updater can be configured to be\ndeployed as separate pods. The master-worker-topologyupdater overlay may be\nused to achieve this:
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/master-worker-topologyupdater?ref=master\n\nIn order to deploy just nfd-topology-updater (without nfd-master and nfd-worker)\nuse the topologyupdater overlay:
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref=master\n\nNFD-Topology-Updater 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;
\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\nSimplest way is to invoke kubectl delete on the overlay that was used for\ndeployment. Beware that this will also delete the namespace that NFD is\nrunning in. For example, in case the default overlay from the repo was used:
kubectl 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\nMinimal steps to deploy latest released version of NFD in your cluster.
\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\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 \"kubernetes.io/arch\": \"amd64\",\n \"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...\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: registry.k8s.io/pause\n name: pause\n nodeSelector:\n # Select a valid feature\n feature.node.kubernetes.io/cpu-cpuid.AESNI: 'true'\nEOF\npod/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>\nIn order to deploy nfd-topology-updater use the topologyupdater kustomize\noverlay.
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref=master\nWait until nfd-topology-updater is running.
\n\n$ kubectl -n node-feature-discovery get ds\nNAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE\ndaemonset.apps/nfd-topology-updater 2 2 2 2 2 <none> 5s\n\nCheck that the NodeResourceTopology objects are created
\n\n$ kubectl get noderesourcetopologies.topology.node.k8s.io\nNAME AGE\nkind-control-plane 23s\nkind-worker 23s\nSee Image variants for description of the different NFD\ncontainer images available.
\n\nUsing Kustomize provides straightforward deployment with\nkubectl integration and declarative customization.
Using Helm provides easy management of NFD deployments with nice\nconfiguration management and easy upgrades.
\n\nUsing Operator provides deployment and configuration management via\nCRDs.
\n","dir":"/deployment/","name":"index.md","path":"deployment/index.md","url":"/deployment/"},{"title":"Worker cmdline reference","layout":"default","sort":2,"content":"To quickly view available command line flags execute nfd-worker -help.\nIn a docker container:
docker run gcr.io/k8s-staging-nfd/node-feature-discovery:master nfd-worker -help\nPrint usage and exit.
\n\nPrint version and exit.
\n\nThe -config flag specifies the path of the nfd-worker configuration file to\nuse.
Default: /etc/kubernetes/node-feature-discovery/nfd-worker.conf
\n\nExample:
\n\nnfd-worker -config=/opt/nfd/worker.conf\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:
Default: empty
\n\nExample:
\n\nnfd-worker -options='{\"sources\":{\"cpu\":{\"cpuid\":{\"attributeWhitelist\":[\"AVX\",\"AVX2\"]}}}}'\nThe -server flag specifies the address of the nfd-master endpoint where to\nconnect to.
Default: localhost:8080
\n\nExample:
\n\nnfd-worker -server=nfd-master.nfd.svc.cluster.local:443\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.
Default: empty
\n\nNote: Must be specified together with -cert-file and -key-file
Example:
\n\nnfd-worker -ca-file=/opt/nfd/ca.crt -cert-file=/opt/nfd/worker.crt -key-file=/opt/nfd/worker.key\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.
Default: empty
\n\nNote: Must be specified together with -ca-file and -key-file
Example:
\n\nnfd-workerr -cert-file=/opt/nfd/worker.crt -key-file=/opt/nfd/worker.key -ca-file=/opt/nfd/ca.crt\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.
Default: empty
\n\nNote: Must be specified together with -cert-file and -ca-file
Example:
\n\nnfd-worker -key-file=/opt/nfd/worker.key -cert-file=/opt/nfd/worker.crt -ca-file=/opt/nfd/ca.crt\nThe -kubeconfig flag specifies the kubeconfig to use for connecting to the\nKubernetes API server. It is only needed for manipulating\nNodeFeature objects, and thus the flag\nonly takes effect when\n-enable-nodefeature-api) is specified. An empty\nvalue (which is also the default) implies in-cluster kubeconfig.
Default: empty
\n\nExample:
\n\nnfd-worker -kubeconfig ${HOME}/.kube/config\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.
Default: empty
\n\nExample:
\n\nnfd-worker -server-name-override=localhost\nThe -feature-sources flag specifies a comma-separated list of enabled feature\nsources. A special value all enables all sources. Prefixing a source name\nwith - indicates that the source will be disabled instead - this is only\nmeaningful when used in conjunction with all. This command line flag allows\ncompletely disabling the feature detection so that neither standard feature\nlabels are generated nor the raw feature data is available for custom rule\nprocessing. Consider using the core.featureSources config file option,\ninstead, allowing dynamic configurability.
Note: This flag takes precedence over the core.featureSources configuration\nfile option.
Default: all
\n\nExample:
\n\nnfd-worker -feature-sources=all,-pci\nThe -label-sources flag specifies a comma-separated list of enabled label\nsources. A special value all enables all sources. Prefixing a source name\nwith - indicates that the source will be disabled instead - this is only\nmeaningful when used in conjunction with all. Consider using the\ncore.labelSources config file option, instead, allowing dynamic\nconfigurability.
Note: This flag takes precedence over the core.labelSources configuration\nfile option.
Default: all
\n\nExample:
\n\nnfd-worker -label-sources=kernel,system,local\nThe -enable-nodefeature-api flag enables the experimental\nNodeFeature CRD API\nfor communicating with nfd-master. This will also automatically disable the\ngRPC communication to nfd-master. When enabled, nfd-worker will create per-node\nNodeFeature objects the contain all discovered node features and the set of\nfeature labels to be created.
Default: false
\n\nExample:
\n\nnfd-worker -enable-nodefeature-api\nThe -no-publish flag disables all communication with the nfd-master and the\nKubernetes API server. It is effectively a “dry-run” flag for nfd-worker.\nNFD-Worker runs feature detection normally, but no labeling requests are sent\nto nfd-master and no NodeFeature objects are created or updated in the API\nserver.
Note: This flag takes precedence over the\ncore.noPublish\nconfiguration file option.
Default: false
\n\nExample:
\n\nnfd-worker -no-publish\nThe -oneshot flag causes nfd-worker to exit after one pass of feature\ndetection.
Default: false
\n\nExample:
\n\nnfd-worker -oneshot -no-publish\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.
If true, adds the file directory to the header of the log messages.
\n\nDefault: false
\n\nLog to standard error as well as files.
\n\nDefault: false
\n\nWhen logging hits line file:N, emit a stack trace.
\n\nDefault: empty
\n\nIf non-empty, write log files in this directory.
\n\nDefault: empty
\n\nIf non-empty, use this log file.
\n\nDefault: empty
\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\nLog to standard error instead of files
\n\nDefault: true
\n\nIf true, avoid header prefixes in the log messages.
\n\nDefault: false
\n\nIf true, avoid headers when opening log files.
\n\nDefault: false
\n\nLogs at or above this threshold go to stderr.
\n\nDefault: 2
\n\nNumber for the log level verbosity.
\n\nDefault: 0
\n\nComma-separated list of pattern=N settings for file-filtered logging.
Default: empty
\n","dir":"/reference/","name":"worker-commandline-reference.md","path":"reference/worker-commandline-reference.md","url":"/reference/worker-commandline-reference.html"},{"title":"NFD-Master","layout":"default","sort":3,"content":"NFD-Master is responsible for connecting to the Kubernetes API server and\nupdating node objects. More specifically, it modifies node labels, taints and\nextended resources based on requests from nfd-workers and 3rd party extensions.
\n\nEXPERIMENTAL\nController for NodeFeature\nobjects can be enabled with the\n-enable-nodefeature-api\ncommand line flag. When enabled, features from NodeFeature objects are used as\nthe input for the NodeFeatureRule\nprocessing pipeline. In addition, any labels listed in the NodeFeature object\nare created on the node (note the allowed\nlabel namespaces are controlled).
\n\n\nNOTE: NodeFeature API must also be enabled in nfd-worker with\nits
\n-enable-nodefeature-api\nflag.
NFD-Master acts as the controller for\nNodeFeatureRule objects.\nIt applies the rules specified in NodeFeatureRule objects on raw feature data\nand creates node labels accordingly. The feature data used as the input can be\nreceived from nfd-worker instances through the gRPC interface or from\nNodeFeature objects. The latter\nrequires that the NodeFeaure controller has been\nenabled.
\n\n\n\n\nNOTE: when gRPC is used for communicating the features (the default\nmechanism), (re-)labelling only happens when a request is received from\nnfd-worker. That is, in practice rules are evaluated and labels for each node\nare created on intervals specified by the\n
\ncore.sleepInterval\nconfiguration option of nfd-worker instances. This means that modification or\ncreation of NodeFeatureRule objects does not instantly cause the node\nlabels to be updated. Instead, the changes only come visible in node labels\nas nfd-worker instances send their labelling requests. This limitation is not\npresent when gRPC interface is disabled\nand NodeFeature API is used.
NFD-Master runs as a deployment, 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\n\n\n\nNOTE: If the NodeFeature controller is enabled the\nreplica count should be 1.
\n
If 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","dir":"/usage/","name":"nfd-master.md","path":"usage/nfd-master.md","url":"/usage/nfd-master.html"},{"title":"Usage","layout":"default","sort":3,"content":"Usage instructions.
\n","dir":"/usage/","name":"index.md","path":"usage/index.md","url":"/usage/"},{"title":"Worker config reference","layout":"default","sort":3,"content":"See the\nsample configuration file\nfor a full example configuration.
\n\nThe core section contains common configuration settings that are not specific\nto any particular feature source.
core.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.
Default: 60s
Example:
\n\ncore:\n sleepInterval: 60s\ncore.featureSources specifies the list of enabled feature sources. A special\nvalue all enables all sources. Prefixing a source name with - indicates\nthat the source will be disabled instead - this is only meaningful when used in\nconjunction with all. This option allows completely disabling the feature\ndetection so that neither standard feature labels are generated nor the raw\nfeature data is available for custom rule processing.
Default: [all]
Example:
\n\ncore:\n # Enable all but cpu and local sources\n featureSources:\n - \"all\"\n - \"-cpu\"\n - \"-local\"\ncore:\n # Enable only cpu and local sources\n featureSources:\n - \"cpu\"\n - \"local\"\ncore.labelSources specifies the list of enabled label sources. A special\nvalue all enables all sources. Prefixing a source name with - indicates\nthat the source will be disabled instead - this is only meaningful when used in\nconjunction with all. This configuration option affects the generation of\nnode labels but not the actual discovery of the underlying feature data that is\nused e.g. in custom/NodeFeatureRule rules.
Note: Overridden by the -label-sources command line flag and\nthe core.sources configurations option (if either of them is specified).
Default: [all]
Example:
\n\ncore:\n # Enable all but cpu and system sources\n labelSources:\n - \"all\"\n - \"-cpu\"\n - \"-system\"\ncore:\n # Enable only cpu and system sources\n labelSources:\n - \"cpu\"\n - \"system\"\nDEPRECATED: use core.labelSources instead.
Note: core.sources takes precedence over the core.labelSources\nconfiguration file option.
core.labelWhiteList specifies a regular expression for filtering feature\nlabels based on the label name. Non-matching labels are not published.
Note: 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\nDefault: null
Example:
\n\ncore:\n labelWhiteList: '^cpu-cpuid'\nSetting core.noPublish to true disables all communication with the\nnfd-master and the Kubernetes API server. It is effectively a “dry-run” option.\nNFD-Worker runs feature detection normally, but no labeling requests are sent\nto nfd-master and no NodeFeature\nobjects are created or updated in the API server.
Note: Overridden by the\n-no-publish command line flag (if\nspecified).
Default: false
Example:
\n\ncore:\n noPublish: true\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\nIf true, adds the file directory to the header of the log messages.
\n\nDefault: false
Run-time configurable: yes
\n\nLog to standard error as well as files.
\n\nDefault: false
Run-time configurable: yes
\n\nWhen logging hits line file:N, emit a stack trace.
\n\nDefault: empty
\n\nRun-time configurable: yes
\n\nIf non-empty, write log files in this directory.
\n\nDefault: empty
\n\nRun-time configurable: no
\n\nIf non-empty, use this log file.
\n\nDefault: empty
\n\nRun-time configurable: no
\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
Run-time configurable: no
\n\nLog to standard error instead of files
\n\nDefault: true
Run-time configurable: yes
\n\nIf true, avoid header prefixes in the log messages.
\n\nDefault: false
Run-time configurable: yes
\n\nIf true, avoid headers when opening log files.
\n\nDefault: false
Run-time configurable: no
\n\nLogs at or above this threshold go to stderr (default 2)
\n\nRun-time configurable: yes
\n\nNumber for the log level verbosity.
\n\nDefault: 0
Run-time configurable: yes
\n\nComma-separated list of pattern=N settings for file-filtered logging.
Default: empty
\n\nRun-time configurable: yes
\n\nThe sources section contains feature source specific configuration parameters.
Prevent publishing cpuid features listed in this option.
\n\nNote: overridden by sources.cpu.cpuid.attributeWhitelist (if specified)
Default: [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]
Example:
\n\nsources:\n cpu:\n cpuid:\n attributeBlacklist: [MMX, MMXEXT]\nOnly publish the cpuid features listed in this option.
\n\nNote: takes precedence over sources.cpu.cpuid.attributeBlacklist
Default: empty
\n\nExample:
\n\nsources:\n cpu:\n cpuid:\n attributeWhitelist: [AVX512BW, AVX512CD, AVX512DQ, AVX512F, AVX512VL]\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\"\nKernel configuration options to publish as feature labels.
\n\nDefault: [NO_HZ, NO_HZ_IDLE, NO_HZ_FULL, PREEMPT]
Example:
\n\nsources:\n kernel:\n configOpts: [NO_HZ, X86, DMI]\nConfiguration option to disable/enable hooks execution. Enabled by default.\nHooks are DEPRECATED since v0.12.0 release and support will be removed in a\nfuture release. Use\nfeature files instead.
\n\nNote: The default NFD container image only supports statically linked binaries.\nUse the full image variant for a\nslightly more extensive environment that additionally supports bash and perl\nruntimes.
\n\nRelated tracking issues:
\n\nExample:
\n\nsources:\n local:\n hooksEnabled: true # true by default\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.
Default: [\"03\", \"0b40\", \"12\"]
Example:
\n\nsources:\n pci:\n deviceClassWhitelist: [\"0200\", \"03\"]\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.
Default: [class, vendor]
Example:
\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
List 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\"]
Example:
\n\nsources:\n usb:\n deviceClassWhitelist: [\"ef\", \"ff\"]\nThe set of USB ID fields from which to compose the name of the feature label.\nValid fields are class, vendor, device and serial.
Default: [class, vendor, device]
Example:
\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
List of rules to process in the custom feature source to create user-specific\nlabels. Refer to the documentation of the\ncustom feature source for\ndetails of the available rules and their configuration.
\n\nDefault: empty
\n\nExample:
\n\nsources:\n custom:\n - name: \"my custom rule\"\n labels:\n my-custom-feature: \"true\"\n matchFeatures:\n - feature: kernel.loadedmodule\n matchExpressions:\n e1000e: {op: Exists}\n - feature: pci.device\n matchExpressions:\n class: {op: In, value: [\"0200\"]}\n vendor: {op: In, value: [\"8086\"]}\nNode Feature Discovery Helm chart allow to easily deploy and manage NFD.
\n\n\n\n\nNOTE: NFD is not ideal for other Helm charts to depend on as that may result\nin multiple parallel NFD deployments in the same cluster which is not fully\nsupported by the NFD Helm chart.
\n
Helm package manager should be installed.
\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\noverride the image tag:
\n\nhelm install node-feature-discovery ./node-feature-discovery/ --set image.tag=master-minimal --namespace $NFD_NS --create-namespace\nYou can override values from values.yaml and provide a file with custom values:
export 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\nTo uninstall the node-feature-discovery deployment:
export 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\nIn order to tailor the deployment of the Node Feature Discovery to your cluster needs\nWe have introduced the following Chart parameters.
\n\n| Name | \nType | \nDefault | \ndescription | \n
|---|---|---|---|
image.repository | \n string | \ngcr.io/k8s-staging-nfd/node-feature-discovery | \n NFD image repository | \n
image.tag | \n string | \nmaster | \n NFD image tag | \n
image.pullPolicy | \n string | \nAlways | \n Image pull policy | \n
imagePullSecrets | \n list | \n[] | \nImagePullSecrets 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
nameOverride | \n string | \n\n | Override the name of the chart | \n
fullnameOverride | \n string | \n\n | Override a default fully qualified app name | \n
tls.enable | \n bool | \nfalse | \nSpecifies whether to use TLS for communications between components | \n
tls.certManager | \n bool | \nfalse | \nIf enabled, requires cert-manager to be installed and will automatically create the required TLS certificates | \n
enableNodeFeatureApi | \n bool | \nfalse | \nEnable the NodeFeature CRD API for communicating node features. This will automatically disable the gRPC communication. | \n
| Name | \nType | \nDefault | \ndescription | \n
|---|---|---|---|
master.* | \n dict | \n\n | NFD master deployment configuration | \n
master.port | \n integer | \n\n | Specifies the TCP port that nfd-master listens for incoming requests. | \n
master.instance | \n string | \n\n | Instance name. Used to separate annotation namespaces for multiple parallel deployments | \n
master.extraLabelNs | \n array | \n[] | \nList of allowed extra label namespaces | \n
master.resourceLabels | \n array | \n[] | \nList of labels to be registered as extended resources | \n
master.crdController | \n bool | \nnull | \nSpecifies whether the NFD CRD API controller is enabled. If not set, controller will be enabled if master.instance is empty. | \n
master.featureRulesController | \n bool | \nnull | \nDEPRECATED: use master.crdController instead | \n
master.replicaCount | \n integer | \n1 | \nNumber of desired pods. This is a pointer to distinguish between explicit zero and not specified | \n
master.podSecurityContext | \n dict | \n{} | \nPodSecurityContext holds pod-level security attributes and common container settings | \n
master.securityContext | \n dict | \n{} | \nContainer security settings | \n
master.serviceAccount.create | \n bool | \ntrue | \nSpecifies whether a service account should be created | \n
master.serviceAccount.annotations | \n dict | \n{} | \nAnnotations to add to the service account | \n
master.serviceAccount.name | \n string | \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
master.rbac.create | \n bool | \ntrue | \nSpecifies whether to create RBAC configuration for nfd-master | \n
master.service.type | \n string | \nClusterIP | \nNFD master service type | \n
master.service.port | \n integer | \n8080 | \nNFD master service port | \n
master.resources | \n dict | \n{} | \nNFD master pod resources management | \n
master.nodeSelector | \n dict | \n{} | \nNFD master pod node selector | \n
master.tolerations | \n dict | \nScheduling to master node is disabled | \nNFD master pod tolerations | \n
master.annotations | \n dict | \n{} | \nNFD master pod annotations | \n
master.affinity | \n dict | \n\n | NFD master pod required node affinity | \n
master.deploymentAnnotations | \n dict | \n{} | \nNFD master deployment annotations | \n
| Name | \nType | \nDefault | \ndescription | \n
|---|---|---|---|
worker.* | \n dict | \n\n | NFD worker daemonset configuration | \n
worker.config | \n dict | \n\n | NFD worker configuration | \n
worker.podSecurityContext | \n dict | \n{} | \nPodSecurityContext holds pod-level security attributes and common container settings | \n
worker.securityContext | \n dict | \n{} | \nContainer security settings | \n
worker.serviceAccount.create | \n bool | \ntrue | \nSpecifies whether a service account for nfd-worker should be created | \n
worker.serviceAccount.annotations | \n dict | \n{} | \nAnnotations to add to the service account for nfd-worker | \n
worker.serviceAccount.name | \n string | \n\n | The name of the service account to use for nfd-worker. If not set and create is true, a name is generated using the fullname template (suffixed with -worker) | \n
worker.rbac.create | \n bool | \ntrue | \nSpecifies whether to create RBAC configuration for nfd-worker | \n
worker.mountUsrSrc | \n bool | \nfalse | \nSpecifies whether to allow users to mount the hostpath /user/src. Does not work on systems without /usr/src AND a read-only /usr | \n
worker.resources | \n dict | \n{} | \nNFD worker pod resources management | \n
worker.nodeSelector | \n dict | \n{} | \nNFD worker pod node selector | \n
worker.tolerations | \n dict | \n{} | \nNFD worker pod node tolerations | \n
worker.priorityClassName | \n string | \n\n | NFD worker pod priority class | \n
worker.annotations | \n dict | \n{} | \nNFD worker pod annotations | \n
worker.daemonsetAnnotations | \n dict | \n{} | \nNFD worker daemonset annotations | \n
| Name | \nType | \nDefault | \ndescription | \n
|---|---|---|---|
topologyUpdater.* | \n dict | \n\n | NFD Topology Updater configuration | \n
topologyUpdater.enable | \n bool | \nfalse | \nSpecifies whether the NFD Topology Updater should be created | \n
topologyUpdater.createCRDs | \n bool | \nfalse | \nSpecifies whether the NFD Topology Updater CRDs should be created | \n
topologyUpdater.serviceAccount.create | \n bool | \ntrue | \nSpecifies whether the service account for topology updater should be created | \n
topologyUpdater.serviceAccount.annotations | \n dict | \n{} | \nAnnotations to add to the service account for topology updater | \n
topologyUpdater.serviceAccount.name | \n string | \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
topologyUpdater.rbac.create | \n bool | \nfalse | \nSpecifies whether to create RBAC configuration for topology updater | \n
topologyUpdater.kubeletConfigPath | \n string | \n”” | \nSpecifies the kubelet config host path | \n
topologyUpdater.kubeletPodResourcesSockPath | \n string | \n”” | \nSpecifies the kubelet sock path to read pod resources | \n
topologyUpdater.updateInterval | \n string | \n60s | \nTime to sleep between CR updates. Non-positive value implies no CR update. | \n
topologyUpdater.watchNamespace | \n string | \n* | \n Namespace to watch pods, * for all namespaces | \n
topologyUpdater.podSecurityContext | \n dict | \n{} | \nPodSecurityContext holds pod-level security attributes and common container settings | \n
topologyUpdater.securityContext | \n dict | \n{} | \nContainer security settings | \n
topologyUpdater.resources | \n dict | \n{} | \nTopology updater pod resources management | \n
topologyUpdater.nodeSelector | \n dict | \n{} | \nTopology updater pod node selector | \n
topologyUpdater.tolerations | \n dict | \n{} | \nTopology updater pod node tolerations | \n
topologyUpdater.annotations | \n dict | \n{} | \nTopology updater pod annotations | \n
topologyUpdater.affinity | \n dict | \n{} | \nTopology updater pod affinity | \n
topologyUpdater.config | \n dict | \n\n | configuration | \n
topologyUpdater.podSetFingerprint | \n bool | \nfalse | \nEnables compute and report of pod fingerprint in NRT objects. | \n
| Name | \nType | \nDefault | \ndescription | \n
|---|---|---|---|
topologyGC.* | \n dict | \n\n | NFD Topology Garbage Collector configuration | \n
topologyGC.enable | \n bool | \ntrue | \nSpecifies whether the NFD Topology Garbage Collector should be created | \n
topologyGC.serviceAccount.create | \n bool | \ntrue | \nSpecifies whether the service account for topology garbage collector should be created | \n
topologyGC.serviceAccount.annotations | \n dict | \n{} | \nAnnotations to add to the service account for topology garbage collector | \n
topologyGC.serviceAccount.name | \n string | \n\n | The name of the service account for topology garbage collector to use. If not set and create is true, a name is generated using the fullname template and -topology-gc suffix | \n
topologyGC.rbac.create | \n bool | \nfalse | \nSpecifies whether to create RBAC configuration for topology garbage collector | \n
topologyGC.interval | \n string | \n1h | \nTime between periodic garbage collector runs | \n
topologyGC.podSecurityContext | \n dict | \n{} | \nPodSecurityContext holds pod-level security attributes and common container settings | \n
topologyGC.securityContext | \n dict | \n{} | \nContainer security settings | \n
topologyGC.resources | \n dict | \n{} | \nTopology garbage collector pod resources management | \n
topologyGC.nodeSelector | \n dict | \n{} | \nTopology garbage collector pod node selector | \n
topologyGC.tolerations | \n dict | \n{} | \nTopology garbage collector pod node tolerations | \n
topologyGC.annotations | \n dict | \n{} | \nTopology garbage collector pod annotations | \n
topologyGC.affinity | \n dict | \n{} | \nTopology garbage collector pod affinity | \n
To quickly view available command line flags execute nfd-topology-updater -help.\nIn a docker container:
docker run gcr.io/k8s-staging-nfd/node-feature-discovery:master \\\nnfd-topology-updater -help\nPrint usage and exit.
\n\nPrint version and exit.
\n\nThe -config flag specifies the path of the nfd-topology-updater\nconfiguration file to use.
Default: /etc/kubernetes/node-feature-discovery/nfd-topology-updater.conf
\n\nExample:
\n\nnfd-topology-updater -config=/opt/nfd/nfd-topology-updater.conf\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.
Default: false
\n\nExample:
\n\nnfd-topology-updater -no-publish\nThe -oneshot flag causes nfd-topology-updater to exit after one pass of\nresource hardware topology detection.
Default: false
\n\nExample:
\n\nnfd-topology-updater -oneshot -no-publish\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.
Default: 60s
\n\nExample:
\n\nnfd-topology-updater -sleep-interval=1h\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.
Default: “*”
\n\nExample:
\n\nnfd-topology-updater -watch-namespace=rte\nThe -kubelet-config-uri specifies the path to the Kubelet’s configuration.\nNote that the URi could either be a local host file or an HTTP endpoint.
Default: https://${NODE_NAME}:10250/configz
Example:
\n\nnfd-topology-updater -kubelet-config-uri=file:///var/lib/kubelet/config.yaml\nThe -api-auth-token-file specifies the path to the api auth token file\nwhich is used to retrieve Kubelet’s configuration from Kubelet secure port,\nonly taking effect when -kubelet-config-uri is https.\nNote that this token file must bind to a role that has the get capability to\nnodes/proxy resources.
Default: /var/run/secrets/kubernetes.io/serviceaccount/token
Example:
\n\nnfd-topology-updater -token-file=/var/run/secrets/kubernetes.io/serviceaccount/token\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.
Default: /host-var/lib/kubelet/pod-resources/kubelet.sock
\n\nExample:
\n\nnfd-topology-updater -podresources-socket=/var/lib/kubelet/pod-resources/kubelet.sock\nEnbles the compute and report the pod set fingerprint in the NRT.\nA pod fingerprint is a compact representation of the “node state” regarding resources.
\n\nDefault: false
Example:
\n\nnfd-topology-updater -pods-fingerprint\nThe Node Feature Discovery Operator automates installation,\nconfiguration and updates of NFD using a specific NodeFeatureDiscovery custom\nresource. This also provides good support for managing NFD as a dependency of\nother operators.
\n\nDeployment using the\nNode Feature Discovery Operator\nis recommended to be done via\noperatorhub.io.
\n\nInstall the operator:
\n\nkubectl create -f https://operatorhub.io/install/nfd-operator.yaml\nCreate NodeFeatureDiscovery object (in nfd namespace here):
cat << EOF | kubectl apply -f -\napiVersion: v1\nkind: Namespace\nmetadata:\n name: nfd\n---\napiVersion: nfd.kubernetes.io/v1\nkind: NodeFeatureDiscovery\nmetadata:\n name: my-nfd-deployment\n namespace: nfd\nspec:\n operand:\n image: gcr.io/k8s-staging-nfd/node-feature-discovery:master\n imagePullPolicy: IfNotPresent\nEOF\nIn order to deploy the minimal image you need to use
\n\n image: gcr.io/k8s-staging-nfd/node-feature-discovery:master-minimal\nin the NodeFeatureDiscovery object above.
If 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\nkubectl delete ns nfd\nSee the node-feature-discovery-operator and OLM project\ndocumentation for instructions for uninstalling the operator and operator\nlifecycle manager, respectively.
\n\n\n","dir":"/deployment/","name":"operator.md","path":"deployment/operator.md","url":"/deployment/operator.html"},{"title":"NFD-Worker","layout":"default","sort":4,"content":"NFD-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\nconfig option.
The 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-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.
Worker 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,\nWorker pod parameter\nworker.config can be used to edit the respective configuration.
See\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 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:
-options='{\"sources\": { \"pci\": { \"deviceClassWhitelist\": [\"12\"] } } }'\nConfiguration options specified from the command line will override those read\nfrom the config file.
\n","dir":"/usage/","name":"nfd-worker.md","path":"usage/nfd-worker.md","url":"/usage/nfd-worker.html"},{"title":"Reference","layout":"default","sort":4,"content":"Command line and configuration reference.
\n","dir":"/reference/","name":"index.md","path":"reference/index.md","url":"/reference/"},{"title":"TLS authentication","layout":"default","sort":5,"content":"NFD 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. The\ntemplate specs provided with NFD contain (commented out) example configuration\nfor enabling TLS authentication.
The 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).
\n\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. Note that -verify-node-name complicates certificate\nmanagement and is not yet supported in the helm or kustomize deployment\nmethods.
cert-manager can be used to automate certificate\nmanagement between nfd-master and the nfd-worker pods.
\n\nThe NFD source code repository contains an example kustomize overlay and helm\nchart that can be used to deploy NFD with cert-manager supplied certificates\nenabled.
\n\nTo install cert-manager itself can be done as easily as this, below, or you\ncan refer to their documentation for other installation methods such as the\nhelm chart they provide.
kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.6.1/cert-manager.yaml\nTo use the kustomize overlay to install node-feature-discovery with TLS enabled,\nyou may use the following:
\n\nkubectl apply -k deployment/overlays/samples/cert-manager\nTo make use of the helm chart, override values.yaml to enable both the\ntls.enabled and tls.certManager options. Note that if you do not enable\ntls.certManager, helm will successfully install the application, but\ndeployment will wait until certificates are manually created, as demonstrated\nbelow.
See the sample installation commands in the Helm Deployment\nand Configuration sections above for how to either override\nindividual values, or provide a yaml file with which to override default\nvalues.
\n\nIf you do not with to make use of cert-manager, the certificates can be\nmanually created and stored as secrets within the NFD namespace.
\n\nCreate a CA certificate
\n\nopenssl req -x509 -newkey rsa:4096 -keyout ca.key -nodes \\\n -subj \"/CN=nfd-ca\" -days 10000 -out ca.crt\nCreate a common openssl config file.
\n\ncat <<EOF > nfd-common.conf\n[ req ]\ndefault_bits = 4096\nprompt = no\ndefault_md = sha256\nreq_extensions = req_ext\ndistinguished_name = dn\n\n[ dn ]\nC = XX\nST = some-state\nL = some-city\nO = some-company\nOU = node-feature-discovery\n\n[ req_ext ]\nsubjectAltName = @alt_names\n\n[ v3_ext ]\nauthorityKeyIdentifier=keyid,issuer:always\nbasicConstraints=CA:FALSE\nkeyUsage=keyEncipherment,dataEncipherment\nextendedKeyUsage=serverAuth,clientAuth\nsubjectAltName=@alt_names\nEOF\nNow, create the nfd-master certificate.
\n\ncat <<EOF > nfd-master.conf\n.include nfd-common.conf\n\n[ dn ]\nCN = nfd-master\n\n[ alt_names ]\nDNS.1 = nfd-master\nDNS.2 = nfd-master.node-feature-discovery.svc.cluster.local\nDNS.3 = localhost\nEOF\n\nopenssl req -new -newkey rsa:4096 -keyout nfd-master.key -nodes -out nfd-master.csr -config nfd-master.conf\nCreate certificates for nfd-worker and nfd-topology-updater
\n\ncat <<EOF > nfd-worker.conf\n.include nfd-common.conf\n\n[ dn ]\nCN = nfd-worker\n\n[ alt_names ]\nDNS.1 = nfd-worker\nDNS.2 = nfd-worker.node-feature-discovery.svc.cluster.local\nEOF\n\n# Config for topology updater is identical except for the DN and alt_names\nsed -e 's/worker/topology-updater/g' < nfd-worker.conf > nfd-topology-updater.conf\n\nopenssl req -new -newkey rsa:4096 -keyout nfd-worker.key -nodes -out nfd-worker.csr -config nfd-worker.conf\nopenssl req -new -newkey rsa:4096 -keyout nfd-topology-updater.key -nodes -out nfd-topology-updater.csr -config nfd-topology-updater.conf\nNow, sign the certificates with the CA created earlier.
\n\nfor cert in nfd-master nfd-worker nfd-topology-updater; do\n echo signing $cert\n openssl x509 -req -in $cert.csr -CA ca.crt -CAkey ca.key \\\n -CAcreateserial -out $cert.crt -days 10000 \\\n -extensions v3_ext -extfile $cert.conf\ndone\nFinally, turn these certificates into secrets.
\n\nfor cert in nfd-master nfd-worker nfd-topology-updater; do\n echo creating secret for $cert in node-feature-discovery namespace\n cat <<EOF | kubectl create -n node-feature-discovery -f -\n---\napiVersion: v1\nkind: Secret\ntype: kubernetes.io/tls\nmetadata:\n name: ${cert}-cert\ndata:\n ca.crt: $( cat ca.crt | base64 -w 0 )\n tls.crt: $( cat $cert.crt | base64 -w 0 )\n tls.key: $( cat $cert.key | base64 -w 0 )\nEOF\n\ndone\nSee the\nsample configuration file\nfor a full example configuration.
\n\nThe excludeList specifies a key-value map of allocated resources\nthat should not be examined by the topology-updater\nagent per node.\nEach key is a node name with a value as a list of resources\nthat should not be examined by the agent for that specific node.
Default: empty
\n\nExample:
\n\nexcludeList:\n nodeA: [hugepages-2Mi]\n nodeB: [memory]\n nodeC: [cpu, hugepages-2Mi]\nexcludeList.* is a special value that use to specify all nodes.\nA resource that would be listed under this key, would be excluded from all nodes.
Default: empty
\n\nExample:
\n\nexcludeList:\n '*': [hugepages-2Mi]\nNFD-Topology-Updater is preferably run as a Kubernetes DaemonSet. This assures\nre-examination on regular intervals, capturing changes in the allocated\nresources and hence the allocatable resources on a per zone basis by updating\nNodeResourceTopology custom resources.\nIt makes sure that new NodeResourceTopology instances are created for each new\nnodes that get added to the cluster.
\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\noption. The default sleep interval is set to 60s which is the value when no\n-sleep-interval is specified.\nIn addition, it can avoid examining specific allocated resources\ngiven a configuration of resources to exclude via -excludeList
Kubelet PodResource API is a prerequisite for\nnfd-topology-updater to be able to run.
\n\nPreceding Kubernetes v1.23, the kubelet must be started with\n--feature-gates=KubeletPodResourcesGetAllocatable=true.
Starting from Kubernetes v1.23, the KubeletPodResourcesGetAllocatable\nfeature gate. is enabled by default
NFD-Topology-Updater supports configuration through a configuration file. The\ndefault location is /etc/kubernetes/node-feature-discovery/topology-updater.conf,\nbut, this can be changed by specifying the-config command line flag.
\n\n\nNOTE: unlike nfd-worker,\ndynamic configuration updates are not currently supported.
\n
Topology-Updater configuration file is read inside the container,\nand thus, Volumes and VolumeMounts are needed\nto make your configuration available for NFD.\nThe preferred method is to use a ConfigMap\nwhich provides easy deployment and re-configurability.
\n\nThe provided nfd-topology-updater deployment templates\ncreate an empty configmap\nand mount it inside the nfd-topology-updater containers.\nIn kustomize deployments, configuration can be edited with:
\n\nkubectl -n ${NFD_NS} edit configmap nfd-topology-updater-conf\nIn Helm deployments,\nTopology Updater parameters\ntoplogyUpdater.config can be used to edit the respective configuration.
See\nnfd-topology-updater 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 a configuration.
\n\n\n","dir":"/usage/","name":"nfd-topology-updater.md","path":"usage/nfd-topology-updater.md","url":"/usage/nfd-topology-updater.html"},{"title":"Developer guide","layout":"default","sort":5,"content":"git clone https://github.com/kubernetes-sigs/node-feature-discovery\ncd node-feature-discovery\nSee customizing the build below for altering the\ncontainer image registry, for example.
\n\nmake\nOptional, this example with Docker.
\n\ndocker push <IMAGE_TAG>\nThe default set of architectures enabled for mulit-arch builds are linux/amd64\nand linux/arm64. If more architectures are needed one can override the\nIMAGE_ALL_PLATFORMS variable with a comma separated list of OS/ARCH tuples.
make image-all\nCurrently docker does not support loading of manifest-lists meaning the images\nare not shown when executing docker images, see:\nbuildx issue #59.
make push-all\nThe resulting container image can be used in the same way on each arch by pulling\ne.g. node-feature-discovery:master without specifying the\narchitecture. The manifest-list will take care of providing the right\narchitecture image.
To use your published image from the step above instead of the\nregistry.k8s.io/nfd/node-feature-discovery image, edit image\nattribute in the spec template(s) to the new location\n(<registry-name>/<image-name>[:<version>]).
The 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.
K8S_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.
You can also build the binaries locally
\n\nmake build\nThis will compile binaries under bin/
There 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| Variable | \nDescription | \nDefault value | \n
|---|---|---|
| HOSTMOUNT_PREFIX | \nPrefix of system directories for feature discovery (local builds) | \n/ (local builds) /host- (container builds) | \n
| IMAGE_BUILD_CMD | \nCommand to build the image | \ndocker build | \n
| IMAGE_BUILD_EXTRA_OPTS | \nExtra options to pass to build command | \nempty | \n
| IMAGE_BUILDX_CMD | \nCommand to build and push multi-arch images with buildx | \nDOCKER_CLI_EXPERIMENTAL=enabled docker buildx build –platform=${IMAGE_ALL_PLATFORMS} –progress=auto –pull | \n
| IMAGE_ALL_PLATFORMS | \nComma separated list of OS/ARCH tuples for mulit-arch builds | \nlinux/amd64,linux/arm64 | \n
| IMAGE_PUSH_CMD | \nCommand to push the image to remote registry | \ndocker push | \n
| IMAGE_REGISTRY | \nContainer image registry to use | \nregistry.k8s.io/nfd | \n
| IMAGE_TAG_NAME | \nContainer image tag name | \n<nfd version> | \n
| IMAGE_EXTRA_TAG_NAMES | \nAdditional container image tag(s) to create when building image | \nempty | \n
| K8S_NAMESPACE | \nnfd-master and nfd-worker namespace | \nnode-feature-discovery | \n
| KUBECONFIG | \nKubeconfig for running e2e-tests | \nempty | \n
| E2E_TEST_CONFIG | \nParameterization file of e2e-tests (see example) | \nempty | \n
| E2E_PULL_IF_NOT_PRESENT | \nTrue-ish value makes the image pull policy IfNotPresent (to be used only in e2e tests) | \nfalse | \n
| OPENSHIFT | \nNon-empty value enables OpenShift specific support (currently only effective in e2e tests) | \nempty | \n
For 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\nvia environment
\n\n IMAGE_BUILD_CMD=\"buildah bud\" make\nby overriding the variable value
\n\n make IMAGE_BUILD_CMD=\"buildah bud\"\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\nmake test\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\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\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.
$ 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\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.
NOTE 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.
In 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.
NOTE:
\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.
PodResource 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.
Another option for building NFD locally is via Tilt tool, which can build container\nimages, push them to a local registry and reload your Kubernetes pods automatically.\nWhen using Tilt, you don’t have to build container images and re-deploy your pods\nmanually but instead let the Tilt take care of it. Tiltfile is a configuration file\nfor the Tilt and is located at the root directory. To develop NFD with Tilt, follow\nthe steps below.
\n\nTo start up your Tilt development environment, just run
\n\ntilt up\nat the root of your local NFD codebase. Tilt will start a web interface in the\nlocalhost and port 10350. From the web interface, you are able to see how NFD worker\nand master are progressing, watch their build and runtime logs. Once your code changes\nare saved locally, Tilt will notice it and re-build the container image from the\ncurrent code, push the image to the registry and re-deploy NFD pods with the latest\ncontainer image.
\n\nTo override environment variables used in the Tiltfile during image build,\nexport them in your current terminal before starting Tilt.
\n\nexport IMAGE_TAG_NAME=\"v1\"\ntilt up\nThis will override the default value(master) of IMAGE_TAG_NAME variable defined\nin the Tiltfile.
All 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\nmake site-serve\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.
In order to just build the html documentation run:
\n\nmake site-build\nThis will generate html documentation under docs/_site/.
You can reach us via the following channels:
\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\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":"Uninstallation","layout":"default","sort":6,"content":"Follow the uninstallation instructions of the deployment method used\n(kustomize,\nhelm or\noperator).
\n\nNFD-Master has a special -prune command line flag for removing all\nnfd-related node labels, annotations and extended resources from the cluster.
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prune?ref=master\nkubectl -n node-feature-discovery wait job.batch/nfd-master --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","dir":"/deployment/","name":"uninstallation.md","path":"deployment/uninstallation.md","url":"/deployment/uninstallation.html"},{"title":"Topology Garbage Collector Cmdline Reference","layout":"default","sort":6,"content":"To quickly view available command line flags execute nfd-topology-gc -help.\nIn a docker container:
docker run gcr.io/k8s-staging-nfd/node-feature-discovery:master \\\nnfd-topology-gc -help\nPrint usage and exit.
\n\nPrint version and exit.
\n\nThe -gc-interval specifies the interval between periodic garbage collector runs.
Default: 1h
\n\nExample:
\n\nnfd-topology-gc -gc-interval=1h\nNFD-Topology-Garbage-Collector is preferably run as a Kubernetes deployment\nwith one replica. It makes sure that all\nNodeResourceTopology\nhave corresponding worker nodes and removes stale objects for worker nodes\nwhich are no longer part of Kubernetes cluster.
\n\nThis service watches for Node deletion events and removes NodeResourceTopology\nobjects upon them. It is also running periodically to make sure no event was\nmissed or NodeResourceTopology object was created without corresponding worker\nnode. The default garbage collector interval is set to 1h which is the value\nwhen no -gc-interval is specified.
\n\nIn Helm deployments,\n(see Topology Garbage Collector\nfor parameters). NFD-Topology-Garbage-Collector will only be deployed when\ntopologyUpdater.enable is set to true.
\n","dir":"/usage/","name":"nfd-topology-gc.md","path":"usage/nfd-topology-gc.md","url":"/usage/nfd-topology-gc.html"},{"title":"CRDs","layout":"default","sort":7,"content":"NFD uses some Kubernetes custom resources.
\n\nEXPERIMENTAL\nNodeFeature is an NFD-specific custom resource for communicating node\nfeatures and node labeling requests. Support for NodeFeature objects is\ndisabled by default. If enabled, nfd-master watches for NodeFeature objects,\nlabels nodes as specified and uses the listed features as input when evaluating\nNodeFeatureRules. NodeFeature objects can be used for\nimplementing 3rd party extensions (see\ncustomization guide for more\ndetails).
\n\napiVersion: nfd.k8s-sigs.io/v1alpha1\nkind: NodeFeature\nmetadata:\n labels:\n nfd.node.kubernetes.io/node-name: node-1\n name: node-1-vendor-features\nspec:\n features:\n instances:\n vendor.device:\n elements:\n - attributes:\n model: \"xpu-1\"\n memory: \"4000\"\n type: \"fast\"\n - attributes:\n model: \"xpu-2\"\n memory: \"16000\"\n type: \"slow\"\n labels:\n vendor-xpu-present: \"true\"\nNodeFeatureRule is an NFD-specific custom resource that is designed for\nrule-based custom labeling of nodes. NFD-Master watches for NodeFeatureRule\nobjects in the cluster and labels nodes according to the rules within. Some use\ncases are e.g. application specific labeling in a specific environments or\nbeing distributed by hardware vendors to create specific labels for their\ndevices.
\n\napiVersion: nfd.k8s-sigs.io/v1alpha1\nkind: NodeFeatureRule\nmetadata:\n name: example-rule\nspec:\n rules:\n - name: \"example rule\"\n labels:\n \"example-custom-feature\": \"true\"\n # Label is created if all of the rules below match\n matchFeatures:\n # Match if \"veth\" kernel module is loaded\n - feature: kernel.loadedmodule\n matchExpressions:\n veth: {op: Exists}\n # Match if any PCI device with vendor 8086 exists in the system\n - feature: pci.device\n matchExpressions:\n vendor: {op: In, value: [\"8086\"]}\nSee the\nCustomization guide\nfor full documentation of the NodeFeatureRule resource and its usage.
\n\nWhen run with NFD-Topology-Updater, NFD creates NodeResourceTopology objects\ncorresponding to node 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\nThe NodeResourceTopology objects created by NFD can be used to gain insight\ninto the allocatable resources along with the granularity of those resources at\na per-zone level (represented by node-0 and node-1 in the above example) or can\nbe used by an external entity (e.g. topology-aware scheduler plugin) to take an\naction based on the gathered information.
\n\n\n","dir":"/usage/","name":"custom-resources.md","path":"usage/custom-resources.md","url":"/usage/custom-resources.html"},{"title":"Customization guide","layout":"default","sort":8,"content":"NFD provides multiple extension points for vendor and application specific\nlabeling:
\n\nNodeFeature (EXPERIMENTAL) objects can be\nused to communicate “raw” node features and node labeling requests to\nnfd-master.NodeFeatureRule objects provide a way to\ndeploy custom labeling rules via the Kubernetes APIlocal feature source of nfd-worker creates\nlabels by executing hooks and reading filescustom feature source of nfd-worker creates\nlabels based on user-specified rulesEXPERIMENTAL\nNodeFeature objects provide a way for 3rd party extensions to advertise custom\nfeatures, both as “raw” features that serve as input to\nNodeFeatureRule objects and as feature\nlabels directly.
\n\nNote that RBAC rules must be created for each extension for them to be able to\ncreate and manipulate NodeFeature objects in their namespace.
\n\nSupport for NodeFeature CRD API is enabled with the -enable-nodefeature-api\ncommand line flag. This flag must be specified for both nfd-master and\nnfd-worker as it will disable the gRPC communication between them.
Consider the following referential example:
\n\napiVersion: nfd.k8s-sigs.io/v1alpha1\nkind: NodeFeature\nmetadata:\n labels:\n nfd.node.kubernetes.io/node-name: node-1\n name: vendor-features-for-node-1\nspec:\n # Features for NodeFeatureRule matching\n features:\n flags:\n vendor.flags:\n elements:\n feature-x: {}\n feature-y: {}\n attributes:\n vendor.config:\n elements:\n setting-a: \"auto\"\n knob-b: \"123\"\n instances:\n vendor.devices:\n elements:\n - attributes:\n model: \"dev-1000\"\n vendor: \"acme\"\n - attributes:\n model: \"dev-2000\"\n vendor: \"acme\"\n # Labels to be created\n labels:\n vendor-feature.enabled: \"true\"\nThe object targets node named node-1. It lists two “flag type” features under\nthe vendor.flags domain, two “attribute type” features and uder the\nvendor.config domain and two “instance type” features under the\nvendor.devices domain. This features will not be directly affecting the node\nlabels but they will be used as input when be\nNodeFeatureRule object are evaluated.
In addition the example requests directly the\nfeature.node.kubenernetes.io/vendor-feature.enabled=true node label to be\ncreated.
The nfd.node.kubernetes.io/node-name=<node-name> must be in place for each\nNodeFeature objectt as NFD uses it to determine the node which it is targeting.
Features are divided into three different types:
\n\nNodeFeatureRule objects provide an easy way to create vendor or application\nspecific labels and taints. It uses a flexible rule-based mechanism for creating\nlabels and optionally taints based on node features.
Consider the following referential example:
\n\napiVersion: nfd.k8s-sigs.io/v1alpha1\nkind: NodeFeatureRule\nmetadata:\n name: my-sample-rule-object\nspec:\n rules:\n - name: \"my sample rule\"\n labels:\n \"my-sample-feature\": \"true\"\n matchFeatures:\n - feature: kernel.loadedmodule\n matchExpressions:\n dummy: {op: Exists}\n - feature: kernel.config\n matchExpressions:\n X86: {op: In, value: [\"y\"]}\nIt specifies one rule which creates node label\nfeature.node.kubenernetes.io/my-sample-feature=true if both of the following\nconditions are true (matchFeatures implements a logical AND over the\nmatchers):
dummy network driver module has been loaded=yCreate a NodeFeatureRule with a yaml file:
kubectl apply -f https://raw.githubusercontent.com/kubernetes-sigs/node-feature-discovery/master/examples/nodefeaturerule.yaml\nNow, on X86 platforms the feature label appears after doing modprobe dummy on\na system and correspondingly the label is removed after rmmod dummy. Note a\nre-labeling delay up to the sleep-interval of nfd-worker (1 minute by default).
See Label rule format for detailed description of\navailable fields and how to write labeling rules.
\nThis feature is experimental.
\n\nIn some circumstances it is desirable keep nodes with specialized hardware away from\nrunning general workload and instead leave them for workloads that need the specialized\nhardware. One way to achieve it is to taint the nodes with the specialized hardware\nand add corresponding toleration to pods that require the special hardware. NFD\noffers node tainting functionality which is disabled by default. User can define\none or more custom taints via the taints field of the NodeFeatureRule CR. The\nsame rule-based mechanism is applied here and the NFD taints only rule matching nodes.
To enable the tainting feature, --enable-taints flag needs to be set to true.\nIf the flag --enable-taints is set to false (i.e. disabled), taints defined in\nthe NodeFeatureRule CR have no effect and will be ignored by the NFD master.
NOTE: Before enabling any taints, make sure to edit nfd-worker daemonset to\ntolerate the taints to be created. Otherwise, already running pods that do not\ntolerate the taint are evicted immediately from the node including the nfd-worker\npod.
\n\nExample NodeFeatureRule with custom taints:
\n\napiVersion: nfd.k8s-sigs.io/v1alpha1\nkind: NodeFeatureRule\nmetadata:\n name: my-sample-rule-object\nspec:\n rules:\n - name: \"my sample taint rule\"\n taints:\n - effect: PreferNoSchedule\n key: \"feature.node.kubernetes.io/special-node\"\n value: \"true\"\n - effect: NoExecute\n key: \"feature.node.kubernetes.io/dedicated-node\"\n matchFeatures:\n - feature: kernel.loadedmodule\n matchExpressions:\n dummy: {op: Exists}\n - feature: kernel.config\n matchExpressions:\n X86: {op: In, value: [\"y\"]}\nIn this example, if the my sample taint rule rule is matched, feature.node.kubernetes.io/pci-0300_1d0f.present=true:NoExecute\nand feature.node.kubernetes.io/cpu-cpuid.ADX:NoExecute taints are set on the node.
NFD-Worker has a special feature source named local which is an integration\npoint for external feature detectors. It provides a mechanism for pluggable\nextensions, allowing the creation of new user-specific features and even\noverriding built-in labels.
The local feature source has two methods for detecting features, hooks and\nfeature files. The features discovered by the local source can further be\nused in label rules specified in\nNodeFeatureRule objects and the\ncustom feature source.
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.
Consider a shell script\n/etc/kubernetes/node-feature-discovery/source.d/my-hook.sh having the\nfollowing stdout output, or alternatively, a plaintext file\n/etc/kubernetes/node-feature-discovery/features.d/my-features having the\nfollowing contents:
my-feature.1\nmy-feature.2=myvalue\nmy.namespace/my-feature.3=456\nThis will translate into the following node labels:
\n\nfeature.node.kubernetes.io/my-feature.1: \"true\"\nfeature.node.kubernetes.io/my-feature.2: \"myvalue\"\nmy.namespace/my-feature.3: \"456\"\nDEPRECATED The local source executes hooks found in\n/etc/kubernetes/node-feature-discovery/source.d/. The hook files must be\nexecutable and they are supposed to print all discovered features in stdout.\nSince NFD v0.13 the default container image only supports statically linked ELF\nbinaries.
stderr output of hooks is propagated to NFD log so it can be used for\ndebugging and logging.
NFD tries to execute any regular files found from the hooks directory.\nAny additional data files the hook might need (e.g. a configuration file)\nshould be placed in a separate directory in order to avoid NFD unnecessarily\ntrying to execute them. A subdirectory under the hooks directory can be used,\nfor example /etc/kubernetes/node-feature-discovery/source.d/conf/.
NOTE: Hooks are being DEPRECATED and will be removed in a future release.\nFor backward compatibility, currently hooks are enabled by default and can be\ndisabled via sources.local.hooksEnabled field in the worker configuration.
sources:\n local:\n hooksEnabled: true # true by default at this point\nNOTE: 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\nNOTE: The full image variant\nprovides backwards-compatibility with older NFD versions by including a more\nexpanded environment, supporting bash and perl runtimes.
\n\nThe local source reads files found in\n/etc/kubernetes/node-feature-discovery/features.d/.
The hook stdout and feature files are expected to contain features in simple\nkey-value pairs, separated by newlines:
\n\n<name>[=<value>]\nThe label value defaults to true, if not specified.
Label namespace may be specified with <namespace>/<name>[=<value>].
The standard NFD deployments contain hostPath mounts for\n/etc/kubernetes/node-feature-discovery/source.d/ and\n/etc/kubernetes/node-feature-discovery/features.d/, making these directories\nfrom the host available inside the nfd-worker container.
One use case for the hooks and/or feature files is detecting features in other\nPods outside NFD, e.g. in Kubernetes device plugins. By using the same\nhostPath mounts for /etc/kubernetes/node-feature-discovery/source.d/ and\n/etc/kubernetes/node-feature-discovery/features.d/ in the side-car (e.g.\ndevice plugin) creates a shared area for deploying hooks and feature files to\nNFD. NFD will periodically scan the directories and run any hooks and read any\nfeature files it finds.
The custom feature source in nfd-worker provides a rule-based mechanism for\nlabel creation, similar to the\nNodeFeatureRule objects. The difference is\nthat the rules are specified in the worker configuration instead of a\nKubernetes API object.
See worker configuration\nfor instructions how to set-up and manage the worker configuration.
\n\nConsider the following referential configuration for nfd-worker:
\n\ncore:\n labelSources: [\"custom\"]\nsources:\n custom:\n - name: \"my sample rule\"\n labels:\n \"my-sample-feature\": \"true\"\n matchFeatures:\n - feature: kernel.loadedmodule\n matchExpressions:\n dummy: {op: Exists}\n - feature: kernel.config\n matchExpressions:\n X86: {op: In, value: [\"y\"]}\nIt specifies one rule which creates node label\nfeature.node.kubenernetes.io/my-sample-feature=true if both of the following\nconditions are true (matchFeatures implements a logical AND over the\nmatchers):
dummy network driver module has been loaded=yIn addition, the configuration only enables the custom source, disabling all\nbuilt-in labels.
Now, on X86 platforms the feature label appears after doing modprobe dummy on\na system and correspondingly the label is removed after rmmod dummy. Note a\nre-labeling delay up to the sleep-interval of nfd-worker (1 minute by default).
In addition to the rules defined in the nfd-worker configuration file, the\ncustom feature source 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.
As an example, consider having file\n/etc/kubernetes/node-feature-discovery/custom.d/my-rule.yaml with the\nfollowing content:
- name: \"my e1000 rule\"\n labels:\n \"e1000.present\": \"true\"\n matchFeatures:\n - feature: kernel.loadedmodule\n matchExpressions:\n e1000: {op: Exists}\nThis simple rule will create feature.node.kubenernetes.io/e1000.present=true\nlabel if the e1000 kernel module has been loaded.
The\nsamples/custom-rules\nkustomize overlay sample contains an example for deploying a custom rule from a\nConfigMap.
Feature labels have the following format:
\n\n<namespace>/<name> = <value>\nThe namespace part (i.e. prefix) of the labels is controlled by nfd:
\n\nfeature.node.kubernetes.io. This is also\nthe default for user defined features that don’t specify any namespace.-deny-label-ns\ncommand line flag of nfd-master\n -extra-label-ns\ncommand line flag of nfd-master.\ne.g: nfd-master -deny-label-ns=\"*\" -extra-label-ns=example.comThis section describes the rule format used in\nNodeFeatureRule objects and in the\nconfiguration of the custom feature source.
It is based on a generic feature matcher that covers all features discovered by\nnfd-worker. The rules rely on a unified data model of the available features\nand a generic expression-based format. Features that can be used in the rules\nare described in detail in available features below.
\n\nTake this rule as a referential example:
\n\n - name: \"my feature rule\"\n labels:\n \"my-special-feature\": \"my-value\"\n matchFeatures:\n - feature: cpu.cpuid\n matchExpressions:\n AVX512F: {op: Exists}\n - feature: kernel.version\n matchExpressions:\n major: {op: In, value: [\"5\"]}\n minor: {op: Gt, value: [\"1\"]}\n - feature: pci.device\n matchExpressions:\n vendor: {op: In, value: [\"8086\"]}\n class: {op: In, value: [\"0200\"]}\nThis will yield feature.node.kubenernetes.io/my-special-feature=my-value node\nlabel if all of these are true (matchFeatures implements a logical AND over\nthe matchers):
The .name field is required and used as an identifier of the rule.
The .labels is a map of the node labels to create if the rule matches.
The .labelsTemplate field specifies a text template for dynamically creating\nlabels based on the matched features. See templating for\ndetails.
NOTE The labels field has priority over labelsTemplate, i.e.\nlabels specified in the labels field will override anything\noriginating from labelsTemplate.
taints is a list of taint entries and each entry can have key, value and effect,\nwhere the value is optional. Effect could be NoSchedule, PreferNoSchedule\nor NoExecute. To learn more about the meaning of these effects, check out k8s documentation.
NOTE taints field is not available for the custom rules of nfd-worker and only\nfor NodeFeatureRule objects.
\n\nThe .vars field is a map of values (key-value pairs) to store for subsequent\nrules to use. In other words, these are variables that are not advertised as\nnode labels. See backreferences for more details on the\nusage of vars.
The .varsTemplate field specifies a text template for dynamically creating\nvars based on the matched features. See templating for details\non using templates and backreferences for more details on\nthe usage of vars.
NOTE The vars field has priority over varsTemplate, i.e.\nvars specified in the vars field will override anything originating from\nvarsTemplate.
The .matchFeatures field specifies a feature matcher, consisting of a list of\nfeature matcher terms. It implements a logical AND over the terms i.e. all\nof them must match in order for the rule to trigger.
matchFeatures:\n - feature: <feature-name>\n matchExpressions:\n <key>:\n op: <op>\n value:\n - <value-1>\n - ...\nThe .matchFeatures[].feature field specifies the feature against which to\nmatch.
The .matchFeatures[].matchExpressions field specifies a map of expressions\nwhich to evaluate against the elements of the feature.
In each MatchExpression op specifies the operator to apply. Valid values are\ndescribed below.
| Operator | \nNumber of values | \nMatches when | \n
|---|---|---|
In | \n 1 or greater | \nInput is equal to one of the values | \n
NotIn | \n 1 or greater | \nInput is not equal to any of the values | \n
InRegexp | \n 1 or greater | \nValues of the MatchExpression are treated as regexps and input matches one or more of them | \n
Exists | \n 0 | \nThe key exists | \n
DoesNotExist | \n 0 | \nThe key does not exists | \n
Gt | \n 1 | \nInput is greater than the value. Both the input and value must be integer numbers. | \n
Lt | \n 1 | \nInput is less than the value. Both the input and value must be integer numbers. | \n
GtLt | \n 2 | \nInput is between two values. Both the input and value must be integer numbers. | \n
IsTrue | \n 0 | \nInput is equal to “true” | \n
IsFalse | \n 0 | \nInput is equal “false” | \n
The value field of MatchExpression is a list of string arguments to the\noperator.
The behavior of MatchExpression depends on the feature type:\nfor flag and attribute features the MatchExpression operates on the feature\nelement whose name matches the <key>. However, for instance features all\nMatchExpressions are evaluated against the attributes of each instance\nseparately.
The .matchAny field is a list of of matchFeatures\nmatchers. A logical OR is applied over the matchers, i.e. at least one of them\nmust match in order for the rule to trigger.
Consider the following example:
\n\n matchAny:\n - matchFeatures:\n - feature: kernel.loadedmodule\n matchExpressions:\n kmod-1: {op: Exists}\n - feature: pci.device\n matchExpressions:\n vendor: {op: In, value: [\"0eee\"]}\n class: {op: In, value: [\"0200\"]}\n - matchFeatures:\n - feature: kernel.loadedmodule\n matchExpressions:\n kmod-2: {op: Exists}\n - feature: pci.device\n matchExpressions:\n vendor: {op: In, value: [\"0fff\"]}\n class: {op: In, value: [\"0200\"]}\nThis matches if kernel module kmod-1 is loaded and a network controller from\nvendor 0eee is present, OR, if kernel module kmod-2 has been loaded and a\nnetwork controller from vendor 0fff is present (OR both of these conditions are\ntrue).
\n\nThe following features are available for matching:
\n\n| Feature | \nFeature type | \nElements | \nValue type | \nDescription | \n
|---|---|---|---|---|
cpu.cpuid | \n flag | \n\n | \n | Supported CPU capabilities | \n
| \n | \n | <cpuid-flag> | \n \n | CPUID flag is present | \n
cpu.cstate | \n attribute | \n\n | \n | Status of cstates in the intel_idle cpuidle driver | \n
| \n | \n | enabled | \n bool | \n‘true’ if cstates are set, otherwise ‘false’. Does not exist of intel_idle driver is not active. | \n
cpu.model | \n attribute | \n\n | \n | CPU model related attributes | \n
| \n | \n | family | \n int | \nCPU family | \n
| \n | \n | vendor_id | \n string | \nCPU vendor ID | \n
| \n | \n | id | \n int | \nCPU model ID | \n
cpu.pstate | \n attribute | \n\n | \n | State of the Intel pstate driver. Does not exist if the driver is not enabled. | \n
| \n | \n | status | \n string | \nStatus of the driver, possible values are ‘active’ and ‘passive’ | \n
| \n | \n | turbo | \n bool | \n‘true’ if turbo frequencies are enabled, otherwise ‘false’ | \n
| \n | \n | scaling | \n string | \nActive scaling_governor, possible values are ‘powersave’ or ‘performance’. | \n
cpu.rdt | \n flag | \n\n | \n | Intel RDT capabilities supported by the system | \n
| \n | \n | <rdt-flag> | \n \n | RDT capability is supported, see RDT flags for details | \n
cpu.security | \n attribute | \n\n | \n | Features related to security and trusted execution environments | \n
| \n | \n | sgx.enabled | \n bool | \ntrue if Intel SGX (Software Guard Extensions) has been enabled, otherwise does not exist | \n
| \n | \n | se.enabled | \n bool | \ntrue if IBM Secure Execution for Linux is available and has been enabled, otherwise does not exist | \n
| \n | \n | tdx.enabled | \n bool | \ntrue if Intel TDX (Trusted Domain Extensions) is available on the host and has been enabled, otherwise does not exist | \n
cpu.sgx | \n attribute | \n\n | \n | DEPRECATED: replaced by cpu.security feature | \n
| \n | \n | enabled | \n bool | \nDEPRECATED: use sgx.enabled from cpu.security instead | \n
cpu.sst | \n attribute | \n\n | \n | Intel SST (Speed Select Technology) capabilities | \n
| \n | \n | bf.enabled | \n bool | \ntrue if Intel SST-BF (Intel Speed Select Technology - Base frequency) has been enabled, otherwise does not exist | \n
cpu.se | \n attribute | \n\n | \n | DEPRECATED: replaced by cpu.security feature | \n
| \n | \n | enabled | \n bool | \nDEPRECATED: use se.enabled from cpu.security instead | \n
cpu.topology | \n attribute | \n\n | \n | CPU topology related features | \n
| \n | \n | hardware_multithreading | \n bool | \nHardware multithreading, such as Intel HTT, is enabled | \n
cpu.coprocessor | \n attribute | \n\n | \n | CPU Coprocessor related features | \n
| \n | \n | nx_gzip | \n bool | \nNest Accelerator GZIP support is enabled | \n
kernel.config | \n attribute | \n\n | \n | Kernel configuration options | \n
| \n | \n | <config-flag> | \n string | \nValue of the kconfig option | \n
kernel.loadedmodule | \n flag | \n\n | \n | Loaded kernel modules | \n
| \n | \n | mod-name | \n \n | Kernel module <mod-name> is loaded | \n
kernel.selinux | \n attribute | \n\n | \n | Kernel SELinux related features | \n
| \n | \n | enabled | \n bool | \ntrue if SELinux has been enabled and is in enforcing mode, otherwise false | \n
kernel.version | \n attribute | \n\n | \n | Kernel version information | \n
| \n | \n | full | \n string | \nFull kernel version (e.g. ‘4.5.6-7-g123abcde’) | \n
| \n | \n | major | \n int | \nFirst component of the kernel version (e.g. ‘4’) | \n
| \n | \n | minor | \n int | \nSecond component of the kernel version (e.g. ‘5’) | \n
| \n | \n | revision | \n int | \nThird component of the kernel version (e.g. ‘6’) | \n
local.label | \n attribute | \n\n | \n | Features from hooks and feature files, i.e. labels from the local feature source | \n
| \n | \n | <label-name> | \n string | \nLabel <label-name> created by the local feature source, value equals the value of the label | \n
memory.nv | \n instance | \n\n | \n | NVDIMM devices present in the system | \n
| \n | \n | <sysfs-attribute> | \n string | \nValue of the sysfs device attribute, available attributes: devtype, mode | \n
memory.numa | \n attribute | \n\n | \n | NUMA nodes | \n
| \n | \n | is_numa | \n bool | \ntrue if NUMA architecture, false otherwise | \n
| \n | \n | node_count | \n int | \nNumber of NUMA nodes | \n
network.device | \n instance | \n\n | \n | Physical (non-virtual) network interfaces present in the system | \n
| \n | \n | name | \n string | \nName of the network interface | \n
| \n | \n | <sysfs-attribute> | \n string | \nSysfs network interface attribute, available attributes: operstate, speed, sriov_numvfs, sriov_totalvfs | \n
pci.device | \n instance | \n\n | \n | PCI devices present in the system | \n
| \n | \n | <sysfs-attribute> | \n string | \nValue of the sysfs device attribute, available attributes: class, vendor, device, subsystem_vendor, subsystem_device, sriov_totalvfs, iommu_group/type, iommu/intel-iommu/version | \n
storage.device | \n instance | \n\n | \n | Block storage devices present in the system | \n
| \n | \n | name | \n string | \nName of the block device | \n
| \n | \n | <sysfs-attribute> | \n string | \nSysfs network interface attribute, available attributes: dax, rotational, nr_zones, zoned | \n
system.osrelease | \n attribute | \n\n | \n | System identification data from /etc/os-release | \n
| \n | \n | <parameter> | \n string | \nOne parameter from /etc/os-release | \n
system.name | \n attribute | \n\n | \n | System name information | \n
| \n | \n | nodename | \n string | \nName of the kubernetes node object | \n
usb.device | \n instance | \n\n | \n | USB devices present in the system | \n
| \n | \n | <sysfs-attribute> | \n string | \nValue of the sysfs device attribute, available attributes: class, vendor, device, serial | \n
rule.matched | \n attribute | \n\n | \n | Previously matched rules | \n
| \n | \n | <label-or-var> | \n string | \nLabel or var from a preceding rule that matched | \n
Rules support template-based creation of labels and vars with the\n.labelsTemplate and .varsTemplate fields. These makes it possible to\ndynamically generate labels and vars based on the features that matched.
The template must expand into a simple format with <key>=<value> pairs\nseparated by newline.
Consider the following example:\n
\n\n labelsTemplate: |\n {{ range .pci.device }}vendor-{{ .class }}-{{ .device }}.present=true\n {{ end }}\n matchFeatures:\n - feature: pci.device\n matchExpressions:\n class: {op: InRegexp, value: [\"^02\"]}\n vendor: [\"0fff\"]\nThe rule above will create individual labels\nfeature.node.kubernetes.io/vendor-<class-id>-<device-id>.present=true for\neach network controller device (device class starting with 02) from vendor\n0ffff.
All the matched features of each feature matcher term under matchFeatures\nfields are available for the template engine. Matched features can be\nreferenced with {{ .<feature-name> }} in the template, and\nthe available data could be described in yaml as follows:
.\n <key-feature>:\n - Name: <matched-key>\n - ...\n\n <value-feature>:\n - Name: <matched-key>\n Value: <matched-value>\n - ...\n\n <instance-feature>:\n - <attribute-1-name>: <attribute-1-value>\n <attribute-2-name>: <attribute-2-value>\n ...\n - ...\nThat is, the per-feature data is a list of objects whose data fields depend on\nthe type of the feature:
\n\nA simple example of a template utilizing name and value from an attribute\nfeature:\n
\n\n labelsTemplate: |\n {{ range .system.osrelease }}system-{{ .Name }}={{ .Value }}\n {{ end }}\n matchFeatures:\n - feature: system.osRelease\n matchExpressions:\n ID: {op: Exists}\n VERSION_ID.major: {op: Exists}\nNOTE In case of matchAny is specified, the template is executed separately\nagainst each individual matchFeatures field and the final set of labels will\nbe superset of all these separate template expansions. E.g. consider the\nfollowing:
- name: <name>\n labelsTemplate: <template>\n matchFeatures: <matcher#1>\n matchAny:\n - matchFeatures: <matcher#2>\n - matchFeatures: <matcher#3>\nIn the example above (assuming the overall result is a match) the template\nwould be executed on matcher#1 as well as on matcher#2 and/or matcher#3\n(depending on whether both or only one of them match). All the labels from\nthese separate expansions would be created, i.e. the end result would be a\nunion of all the individual expansions.
\n\nRule templates use the Golang text/template\npackage and all its built-in functionality (e.g. pipelines and functions) can\nbe used. An example template taking use of the built-in len function,\nadvertising the number of PCI network controllers from a specific vendor:\n
labelsTemplate: |\n num-intel-network-controllers={{ .pci.device | len }}\n matchFeatures:\n - feature: pci.device\n matchExpressions:\n vendor: {op: In, value: [\"8086\"]}\n class: {op: In, value: [\"0200\"]}\n\nImaginative template pipelines are possible, but care must be taken in order to\nproduce understandable and maintainable rule sets.
\n\nRules support referencing the output of preceding rules. This enables\nsophisticated scenarios where multiple rules are combined together\nto for more complex heuristics than a single rule can provide. The labels and\nvars created by the execution of preceding rules are available as a special\nrule.matched feature.
Consider the following configuration:
\n\n - name: \"my kernel label rule\"\n labels:\n kernel-feature: \"true\"\n matchFeatures:\n - feature: kernel.version\n matchExpressions:\n major: {op: Gt, value: [\"4\"]}\n\n - name: \"my var rule\"\n vars:\n nolabel-feature: \"true\"\n matchFeatures:\n - feature: cpu.cpuid\n matchExpressions:\n AVX512F: {op: Exists}\n - feature: pci.device\n matchExpressions:\n vendor: {op: In, value: [\"0fff\"]}\n device: {op: In, value: [\"1234\", \"1235\"]}\n\n - name: \"my high level feature rule\"\n labels:\n high-level-feature: \"true\"\n matchFeatures:\n - feature: rule.matched\n matchExpressions:\n kernel-feature: {op: IsTrue}\n nolabel-feature: {op: IsTrue}\nThe feature.node.kubernetes.io/high-level-feature = true label depends on thw\ntwo previous rules.
Note that when referencing rules across multiple\nNodeFeatureRule objects attention must be\npaid to the ordering. NodeFeatureRule objects are processed in alphabetical\norder (based on their .metadata.name).
Some more configuration examples below.
\n\nMatch certain CPUID features:
\n\n - name: \"example cpuid rule\"\n labels:\n my-special-cpu-feature: \"true\"\n matchFeatures:\n - feature: cpu.cpuid\n matchExpressions:\n AESNI: {op: Exists}\n AVX: {op: Exists}\nRequire a certain loaded kernel module and OS version:
\n\n - name: \"my multi-feature rule\"\n labels:\n my-special-multi-feature: \"true\"\n matchFeatures:\n - feature: kernel.loadedmodule\n matchExpressions:\n e1000: {op: Exists}\n - feature: system.osrelease\n matchExpressions:\n NAME: {op: InRegexp, values: [\"^openSUSE\"]}\n VERSION_ID.major: {op: Gt, values: [\"14\"]}\nRequire a loaded kernel module and two specific PCI devices (both of which\nmust be present):
\n\n - name: \"my multi-device rule\"\n labels:\n my-multi-device-feature: \"true\"\n matchFeatures:\n - feature: kernel.loadedmodule\n matchExpressions:\n my-driver-module: {op: Exists}\n - pci.device:\n vendor: \"0fff\"\n device: \"1234\"\n - pci.device:\n vendor: \"0fff\"\n device: \"abcd\"\nDEPRECATED: use the new rule syntax instead.
\n\nThe custom source supports the legacy matchOn rule syntax for\nbackwards-compatibility.
To aid in making the legacy rule syntax clearer, we define a general and a per\nrule nomenclature, keeping things as consistent as possible.
\n\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.\nRules are specified under sources.custom in the nfd-worker configuration\nfile.
sources:\n custom:\n - name: <feature name>\n value: <optional feature value, defaults to \"true\">\n matchOn:\n - <Rule-1>: <Rule-1 Input>\n [<Rule-2>: <Rule-2 Input>]\n - <Matcher-2>\n - ...\n - ...\n - <Matcher-N>\n - <custom feature 2>\n - ...\n - ...\n - <custom feature M>\nThe label is constructed by adding custom- prefix to the name field, label\nvalue defaults to true if not specified in the rule spec:
feature.node.kubernetes.io/custom-<name> = <value>\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\nAttribute :A PCI attribute.\nElement :An identifier of the PCI attribute.\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.
pciId :\n class: [<class id>, ...]\n vendor: [<vendor id>, ...]\n device: [<device id>, ...]\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\nAttribute :A USB attribute.\nElement :An identifier of the USB attribute.\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.
usbId :\n class: [<class id>, ...]\n vendor: [<vendor id>, ...]\n device: [<device id>, ...]\n serial: [<serial>, ...]\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\nElement :A kernel module\nThe LoadedKMod Rule allows matching the loaded kernel modules in the system\nagainst a provided list of Elements.
\n\nloadedKMod : [<kernel module>, ...]\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\nElement :A CPUID flag\nThe Rule allows matching the available CPUID flags in the system against a\nprovided list of Elements.
\n\ncpuId : [<CPUID flag string>, ...]\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\nElement :A Kconfig option\nThe Rule allows matching the kconfig options in the system against a provided\nlist of Elements.
\n\nkConfig: [<kernel config option ('y' or 'm') or '=<value>'>, ...]\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 =<value> in the kernel.
Element :A nodename regexp pattern\nThe Rule allows matching the node’s name against a provided list of Elements.
\n\nnodename: [ <nodename regexp pattern>, ... ]\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\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.*\" ]\nIn the example above:
\n\nfeature.node.kubernetes.io/custom-my.kernel.feature=true if the node has\nkmod1 AND kmod2 kernel modules loaded.feature.node.kubernetes.io/custom-my.pci.feature=true if the node contains\na PCI device with a PCI vendor ID of 15b3 AND PCI device ID of 1014 OR\n1017.feature.node.kubernetes.io/custom-my.usb.feature=true if the node contains\na USB device with a USB vendor ID of 1d6b AND USB device ID of 0003.feature.node.kubernetes.io/custom-my.combined.feature=true if\nvendor_kmod1 AND vendor_kmod2 kernel modules are loaded AND the node\ncontains a PCI device\nwith a PCI vendor ID of 15b3 AND PCI device ID of 1014 or 1017.vendor.feature.node.kubernetes.io/accumulated.feature=true if\nsome_kmod1 AND some_kmod2 kernel modules are loaded OR the node\ncontains a PCI device\nwith a PCI vendor ID of 15b3 AND PCI device ID of 1014 OR 1017.feature.node.kubernetes.io/custom-my.kernel.featureneedscpu=true if\nKVM_INTEL kernel config is enabled AND the node CPU supports VMX\nvirtual machine extensionsfeature.node.kubernetes.io/custom-my.kernel.modulecompiler=true if the\nin-tree kmod1 kernel module is loaded AND it’s built with\nGCC_VERSION=100101.profile.node.kubernetes.io/my-datacenter=datacenter-1 if the node’s name\nmatches the node-datacenter1-rack.*-server.* pattern, e.g.\nnode-datacenter1-rack2-server42This page contains usage examples and demos.
\n\n
A demo on the benefits of using node feature discovery can be found in the\nsource code repository under\ndemo/.
\n","dir":"/usage/","name":"examples-and-demos.md","path":"usage/examples-and-demos.md","url":"/usage/examples-and-demos.html"}] \ No newline at end of file +[{"title":"Feature labels","layout":"default","sort":1,"content":"Features are advertised as labels in the Kubernetes Node object.
\n\nLabel creation in nfd-worker is performed by a set of separate modules called\nlabel sources. The\ncore.labelSources\nconfiguration option (or\n-label-sources\nflag) of nfd-worker controls which sources to enable for label generation.
All built-in labels use the feature.node.kubernetes.io label namespace and\nhave the following format.
feature.node.kubernetes.io/<feature> = <value>\n\n\n\nNOTE: 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\n
\n-label-whitelist\nflag of nfd-master or\ncore.labelWhiteList\noption of nfd-worker.
| Feature name | \nValue | \nDescription | \n
|---|---|---|
cpu-cpuid.<cpuid-flag> | \n true | \nCPU capability is supported. NOTE: the capability might be supported but not enabled. | \n
cpu-hardware_multithreading | \n true | \nHardware multithreading, such as Intel HTT, enabled (number of logical CPUs is greater than physical CPUs) | \n
cpu-coprocessor.nx_gzip | \n true | \nNest Accelerator for GZIP is supported(Power). | \n
cpu-power.sst_bf.enabled | \n true | \nIntel SST-BF (Intel Speed Select Technology - Base frequency) enabled | \n
cpu-pstate.status | \n string | \nThe status of the Intel pstate driver when in use and enabled, either ‘active’ or ‘passive’. | \n
cpu-pstate.turbo | \n bool | \nSet to ‘true’ if turbo frequencies are enabled in Intel pstate driver, set to ‘false’ if they have been disabled. | \n
cpu-pstate.scaling_governor | \n string | \nThe value of the Intel pstate scaling_governor when in use, either ‘powersave’ or ‘performance’. | \n
cpu-cstate.enabled | \n bool | \nSet 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
cpu-rdt.<rdt-flag> | \n true | \nIntel RDT capability is supported. See RDT flags for details. | \n
cpu-security.sgx.enabled | \n true | \nSet to ‘true’ if Intel SGX is enabled in BIOS (based a non-zero sum value of SGX EPC section sizes). | \n
cpu-security.se.enabled | \n true | \nSet to ‘true’ if IBM Secure Execution for Linux (IBM Z & LinuxONE) is available and enabled (requires /sys/firmware/uv/prot_virt_host facility) | \n
cpu-security.tdx.enabled | \n true | \nSet to ‘true’ if Intel TDX is available on the host and has been enabled (requires /sys/module/kvm_intel/parameters/tdx). | \n
cpu-sgx.enabled | \n true | \nDEPRECATED: use cpu-security.sgx.enabled instead. | \n
cpu-se.enabled | \n true | \nDEPRECATED: use cpu-security.se.enabled instead. | \n
cpu-model.vendor_id | \n string | \nComparable CPU vendor ID. | \n
cpu-model.family | \n int | \nCPU family. | \n
cpu-model.id | \n int | \nCPU model number. | \n
The CPU label source is configurable, see\nworker configuration and\nsources.cpu\nconfiguration options for details.
| Flag | \nDescription | \n
|---|---|
| ADX | \nMulti-Precision Add-Carry Instruction Extensions (ADX) | \n
| AESNI | \nAdvanced Encryption Standard (AES) New Instructions (AES-NI) | \n
| AVX | \nAdvanced Vector Extensions (AVX) | \n
| AVX2 | \nAdvanced Vector Extensions 2 (AVX2) | \n
| AVXVNNI | \nAVX (VEX encoded) VNNI neural network instructions | \n
| AMXBF16 | \nAdvanced Matrix Extension, tile multiplication operations on BFLOAT16 numbers | \n
| AMXINT8 | \nAdvanced Matrix Extension, tile multiplication operations on 8-bit integers | \n
| AMXFP16 | \nAdvanced Matrix Extension, tile multiplication operations on FP16 numbers | \n
| AMXTILE | \nAdvanced Matrix Extension, base tile architecture support | \n
| AVX512BF16 | \nAVX-512 BFLOAT16 instructions | \n
| AVX512BITALG | \nAVX-512 bit Algorithms | \n
| AVX512BW | \nAVX-512 byte and word Instructions | \n
| AVX512CD | \nAVX-512 conflict detection instructions | \n
| AVX512DQ | \nAVX-512 doubleword and quadword instructions | \n
| AVX512ER | \nAVX-512 exponential and reciprocal instructions | \n
| AVX512F | \nAVX-512 foundation | \n
| AVX512FP16 | \nAVX-512 FP16 instructions | \n
| AVX512IFMA | \nAVX-512 integer fused multiply-add instructions | \n
| AVX512PF | \nAVX-512 prefetch instructions | \n
| AVX512VBMI | \nAVX-512 vector bit manipulation instructions | \n
| AVX512VBMI2 | \nAVX-512 vector bit manipulation instructions, version 2 | \n
| AVX512VL | \nAVX-512 vector length extensions | \n
| AVX512VNNI | \nAVX-512 vector neural network instructions | \n
| AVX512VP2INTERSECT | \nAVX-512 intersect for D/Q | \n
| AVX512VPOPCNTDQ | \nAVX-512 vector population count doubleword and quadword | \n
| AVXIFMA | \nAVX-IFMA instructions | \n
| AVXNECONVERT | \nAVX-NE-CONVERT instructions | \n
| AVXVNNIINT8 | \nAVX-VNNI-INT8 instructions | \n
| CMPCCXADD | \nCMPCCXADD instructions | \n
| ENQCMD | \nEnqueue Command | \n
| GFNI | \nGalois Field New Instructions | \n
| HYPERVISOR | \nRunning under hypervisor | \n
| MSRLIST | \nRead/Write List of Model Specific Registers | \n
| PREFETCHI | \nPREFETCHIT0/1 instructions | \n
| VAES | \nAVX-512 vector AES instructions | \n
| VPCLMULQDQ | \nCarry-less multiplication quadword | \n
| WRMSRNS | \nNon-Serializing Write to Model Specific Register | \n
By default, the following CPUID flags have been blacklisted: BMI1, BMI2, CLMUL,\nCMOV, CX16, ERMS, F16C, HTT, LZCNT, MMX, MMXEXT, NX, POPCNT, RDRAND, RDSEED,\nRDTSCP, SGX, SSE, SSE2, SSE3, SSE4, SSE42 and SSSE3. See\nsources.cpu\nconfiguration options to change the behavior.
See the full list in github.com/klauspost/cpuid.
\n\n| Flag | \nDescription | \n
|---|---|
| IDIVA | \nInteger divide instructions available in ARM mode | \n
| IDIVT | \nInteger divide instructions available in Thumb mode | \n
| THUMB | \nThumb instructions | \n
| FASTMUL | \nFast multiplication | \n
| VFP | \nVector floating point instruction extension (VFP) | \n
| VFPv3 | \nVector floating point extension v3 | \n
| VFPv4 | \nVector floating point extension v4 | \n
| VFPD32 | \nVFP with 32 D-registers | \n
| HALF | \nHalf-word loads and stores | \n
| EDSP | \nDSP extensions | \n
| NEON | \nNEON SIMD instructions | \n
| LPAE | \nLarge Physical Address Extensions | \n
| Flag | \nDescription | \n
|---|---|
| AES | \nAnnouncing the Advanced Encryption Standard | \n
| EVSTRM | \nEvent Stream Frequency Features | \n
| FPHP | \nHalf Precision(16bit) Floating Point Data Processing Instructions | \n
| ASIMDHP | \nHalf Precision(16bit) Asimd Data Processing Instructions | \n
| ATOMICS | \nAtomic Instructions to the A64 | \n
| ASIMRDM | \nSupport for Rounding Double Multiply Add/Subtract | \n
| PMULL | \nOptional Cryptographic and CRC32 Instructions | \n
| JSCVT | \nPerform Conversion to Match Javascript | \n
| DCPOP | \nPersistent Memory Support | \n
| Flag | \nDescription | \n
|---|---|
| RDTMON | \nIntel RDT Monitoring Technology | \n
| RDTCMT | \nIntel Cache Monitoring (CMT) | \n
| RDTMBM | \nIntel Memory Bandwidth Monitoring (MBM) | \n
| RDTL3CA | \nIntel L3 Cache Allocation Technology | \n
| RDTl2CA | \nIntel L2 Cache Allocation Technology | \n
| RDTMBA | \nIntel Memory Bandwidth Allocation (MBA) Technology | \n
| Feature | \nValue | \nDescription | \n
|---|---|---|
kernel-config.<option> | \n true | \nKernel config option is enabled (set ‘y’ or ‘m’). Default options are NO_HZ, NO_HZ_IDLE, NO_HZ_FULL and PREEMPT | \n
kernel-selinux.enabled | \n true | \nSelinux is enabled on the node | \n
kernel-version.full | \n string | \nFull kernel version as reported by /proc/sys/kernel/osrelease (e.g. ‘4.5.6-7-g123abcde’) | \n
kernel-version.major | \n string | \nFirst component of the kernel version (e.g. ‘4’) | \n
kernel-version.minor | \n string | \nSecond component of the kernel version (e.g. ‘5’) | \n
kernel-version.revision | \n string | \nThird component of the kernel version (e.g. ‘6’) | \n
The kernel label source is configurable, see\nworker configuration and\nsources.kernel\nconfiguration options for details.
| Feature | \nValue | \nDescription | \n
|---|---|---|
memory-numa | \n true | \nMultiple memory nodes i.e. NUMA architecture detected | \n
memory-nv.present | \n true | \nNVDIMM device(s) are present | \n
memory-nv.dax | \n true | \nNVDIMM region(s) configured in DAX mode are present | \n
| Feature | \nValue | \nDescription | \n
|---|---|---|
network-sriov.capable | \n true | \nSingle Root Input/Output Virtualization (SR-IOV) enabled Network Interface Card(s) present | \n
network-sriov.configured | \n true | \nSR-IOV virtual functions have been configured | \n
| Feature | \nValue | \nDescription | \n
|---|---|---|
pci-<device label>.present | \n true | \nPCI device is detected | \n
pci-<device label>.sriov.capable | \n true | \nSingle Root Input/Output Virtualization (SR-IOV) enabled PCI device present | \n
<device label> is format is configurable and set to <class>_<vendor> by\ndefault. For more more details about configuration of the pci labels, see\nsources.pci options\nand worker configuration\ninstructions.
| Feature | \nValue | \nDescription | \n
|---|---|---|
usb-<device label>.present | \n true | \nUSB device is detected | \n
<device label> is format is configurable and set to\n<class>_<vendor>_<device> by default. For more more details about\nconfiguration of the usb labels, see\nsources.usb options\nand worker configuration\ninstructions.
| Feature | \nValue | \nDescription | \n
|---|---|---|
storage-nonrotationaldisk | \n true | \nNon-rotational disk, like SSD, is present in the node | \n
| Feature | \nValue | \nDescription | \n
|---|---|---|
system-os_release.ID | \n string | \nOperating system identifier | \n
system-os_release.VERSION_ID | \n string | \nOperating system version identifier (e.g. ‘6.7’) | \n
system-os_release.VERSION_ID.major | \n string | \nFirst component of the OS version id (e.g. ‘6’) | \n
system-os_release.VERSION_ID.minor | \n string | \nSecond component of the OS version id (e.g. ‘7’) | \n
The custom label source is designed for creating\nuser defined labels. However, it has a few statically\ndefined built-in labels:
\n\n| Feature | \nValue | \nDescription | \n
|---|---|---|
custom-rdma.capable | \n true | \nThe node has an RDMA capable Network adapter | \n
custom-rdma.enabled | \n true | \nThe node has the needed RDMA modules loaded to run RDMA traffic | \n
NFD has many extension points for creating vendor and application specific\nlabels. See the customization guide for\ndetailed documentation.
\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.
An 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.
Similar 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.
Example usage of the command line arguments, using a new namespace:\nnfd-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\nlabels exist:
\n\n sgx.some.ns/epc: <label value>\n feature.node.kubernetes.io/my_source-my.feature: <label value>\nWelcome to Node Feature Discovery – a Kubernetes add-on for detecting hardware\nfeatures and system configuration!
\n\nContinue to:
\n\nIntroduction for more details on the\nproject.
\nQuick start for quick step-by-step\ninstructions on how to get NFD running on your cluster.
\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 nodes -o json | jq .items[].metadata.labels\n {\n \"kubernetes.io/arch\": \"amd64\",\n \"kubernetes.io/os\": \"linux\",\n \"feature.node.kubernetes.io/cpu-cpuid.ADX\": \"true\",\n \"feature.node.kubernetes.io/cpu-cpuid.AESNI\": \"true\",\n...\n\nNFD currently offers two variants of the container image. The “minimal” variant is\ncurrently deployed by default. Released container images are available for\nx86_64 and Arm64 architectures.
\n\nThis is a minimal image based on\ngcr.io/distroless/base\nand only supports running statically linked binaries.
\n\nFor backwards compatibility a container image tag with suffix -minimal\n(e.g. gcr.io/k8s-staging-nfd/node-feature-discovery:master-minimal) is provided.
This image is based on debian:bullseye-slim\nand contains a full Linux system for running shell-based nfd-worker hooks and\ndoing live debugging and diagnosis of the NFD images.
\n\nThe container image tag has suffix -full\n(e.g. gcr.io/k8s-staging-nfd/node-feature-discovery:master-full).
This 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 and optionally node taints.
\n\nNFD consists of four software components:
\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 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 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\ncreates or updates a\nNodeResourceTopology custom\nresource object specific to this node. One instance of nfd-topology-updater is\nsupposed to be running on each node of the cluster.
\n\nNFD-Topology-GC is a daemon responsible for cleaning obsolete\nNodeResourceTopology objects,\nobsolete means that there is no corresponding worker node.
\n\nOne instance of nfd-topology-gc is supposed to be running in the cluster.
\n\nFeature discovery is divided into domain-specific feature sources:
\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.
An 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/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}\nNFD also annotates nodes it is running on:
\n\n| Annotation | \nDescription | \n
|---|---|
| [<instance>.]nfd.node.kubernetes.io/master.version | \nVersion of the nfd-master instance running on the node. Informative use only. | \n
| [<instance>.]nfd.node.kubernetes.io/worker.version | \nVersion of the nfd-worker instance running on the node. Informative use only. | \n
| [<instance>.]nfd.node.kubernetes.io/feature-labels | \nComma-separated list of node labels managed by NFD. NFD uses this internally so must not be edited by users. | \n
| [<instance>.]nfd.node.kubernetes.io/extended-resources | \nComma-separated list of node extended resources managed by NFD. NFD uses this internally so must not be edited by users. | \n
NOTE: the -instance\ncommand line flag affects the annotation names
Unapplicable annotations are not created, i.e. for example master.version is\nonly created on nodes running nfd-master.
\n\nNFD takes use of some Kubernetes Custom Resources.
\n\nNodeFeatures (EXPERIMENTAL)\ncan be used for representing node features and requesting node labels to be\ngenerated.
\n\nNFD-Master uses NodeFeatureRules\nfor custom labeling of nodes.
\n\nNFD-Topology-Updater creates\nNodeResourceTopology objects\nthat describe the hardware topology of node resources.
\n","dir":"/get-started/","name":"introduction.md","path":"get-started/introduction.md","url":"/get-started/introduction.html"},{"title":"Master cmdline reference","layout":"default","sort":1,"content":"To quickly view available command line flags execute nfd-master -help.\nIn a docker container:
docker run gcr.io/k8s-staging-nfd/node-feature-discovery:master nfd-master -help\nPrint usage and exit.
\n\nPrint version and exit.
\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.
The -port flag specifies the TCP port that nfd-master listens for incoming requests.
Default: 8080
\n\nExample:
\n\nnfd-master -port=443\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 ..
Default: empty
\n\nExample:
\n\nnfd-master -instance=network\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.
Default: empty
\n\nNote: Must be specified together with -cert-file and -key-file
Example:
\n\nnfd-master -ca-file=/opt/nfd/ca.crt -cert-file=/opt/nfd/master.crt -key-file=/opt/nfd/master.key\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.
Default: empty
\n\nNote: Must be specified together with -ca-file and -key-file
Example:
\n\nnfd-master -cert-file=/opt/nfd/master.crt -key-file=/opt/nfd/master.key -ca-file=/opt/nfd/ca.crt\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.
Default: empty
\n\nNote: Must be specified together with -cert-file and -ca-file
Example:
\n\nnfd-master -key-file=/opt/nfd/master.key -cert-file=/opt/nfd/master.crt -ca-file=/opt/nfd/ca.crt\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).
Node 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\nThe -enable-nodefeature-api flag enables the\nNodeFeature CRD API for receiving\nfeature requests. This will also automatically disable the gRPC interface.
Default: false
\n\nExample:
\n\nnfd-master -enable-nodefeature-api\nThe -enable-taints flag enables/disables node tainting feature of NFD.
Default: false
\n\nExample:
\n\nnfd-master -enable-taints=true\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.
Default: false
\n\nExample:
\n\nnfd-master -no-publish\nThe -crd-controller flag specifies whether the NFD CRD API controller is\nenabled or not. The controller is responsible for processing\nNodeFeature and\nNodeFeatureRule objects.
Default: true
\n\nExample:
\n\nnfd-master -crd-controller=false\nDEPRECATED: use -crd-controller instead.
The -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.
Note: 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. This option can be used to allow\nother vendor or application specific namespaces for custom labels from the\nlocal and custom feature sources, even though these labels were denied using\nthe deny-label-ns flag.
The same namespace control and this flag applies Extended Resources (created\nwith -resource-labels), too.
Default: empty
\n\nExample:
\n\nnfd-master -extra-label-ns=vendor-1.com,vendor-2.io\nThe -deny-label-ns flag specifies a comma-separated list of excluded\nlabel namespaces. By default, nfd-master allows creating labels in all\nnamespaces, excluding kubernetes.io namespace and its sub-namespaces\n(i.e. *.kubernetes.io). However, you should note that\nkubernetes.io and its sub-namespaces are always denied.\nFor example, nfd-master -deny-label-ns=\"\" would still disallow\nkubernetes.io and *.kubernetes.io.\nThis option can be used to exclude some vendors or application specific\nnamespaces.\nNote that the namespaces feature.node.kubernetes.io and profile.node.kubernetes.io\nand their sub-namespaces are always allowed and cannot be denied.
Default: empty
\n\nExample:
\n\nnfd-master -deny-label-ns=*.vendor.com,vendor-2.io\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.
Default: empty
\n\nExample:
\n\nnfd-master -resource-labels=vendor-1.com/feature-1,vendor-2.io/feature-2\nThe following logging-related flags are inherited from the\nklog package.
\n\nIf true, adds the file directory to the header of the log messages.
\n\nDefault: false
\n\nLog to standard error as well as files.
\n\nDefault: false
\n\nWhen logging hits line file:N, emit a stack trace.
\n\nDefault: empty
\n\nIf non-empty, write log files in this directory.
\n\nDefault: empty
\n\nIf non-empty, use this log file.
\n\nDefault: empty
\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\nLog to standard error instead of files
\n\nDefault: true
\n\nIf true, avoid header prefixes in the log messages.
\n\nDefault: false
\n\nIf true, avoid headers when opening log files.
\n\nDefault: false
\n\nLogs at or above this threshold go to stderr.
\n\nDefault: 2
\n\nNumber for the log level verbosity.
\n\nDefault: 0
\n\nComma-separated list of pattern=N settings for file-filtered logging.
Default: empty
\n","dir":"/reference/","name":"master-commandline-reference.md","path":"reference/master-commandline-reference.md","url":"/reference/master-commandline-reference.html"},{"title":"Using node labels","layout":"default","sort":2,"content":"Nodes with specific features can be targeted using the nodeSelector field. The\nfollowing example shows how to target nodes with Intel TurboBoost enabled.
apiVersion: 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","dir":"/usage/","name":"using-labels.md","path":"usage/using-labels.md","url":"/usage/using-labels.html"},{"title":"Kustomize","layout":"default","sort":2,"content":"Kustomize provides easy\ndeployment of NFD. Customization of the deployment is done by maintaining\ndeclarative overlays on top of the base overlays in NFD.
\n\nTo follow the deployment instructions here,\nkubectl v1.21 or\nlater is required.
\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.
NOTE: nfd-topology-updater is not deployed as part of the default overlay.\nPlease refer to the Master Worker Topologyupdater\nand Topologyupdater below.
Alternatively you can clone the repository and customize the deployment by\ncreating your own overlays. For example, to deploy the\nminimal image. See kustomize for more\ninformation about managing deployment configurations.
\n\nThe NFD repository hosts a set of overlays for different usages and deployment\nscenarios under\ndeployment/overlays
default:\ndefault deployment of nfd-worker as a daemonset, described abovedefault-combined\nsee Master-worker pod belowdefault-job:\nsee Worker one-shot belowmaster-worker-topologyupdater:\nsee Master Worker Topologyupdater belowtopologyupdater:\nsee Topology Updater belowprune:\nclean up the cluster after uninstallation, see\nRemoving feature labelssamples/cert-manager:\nan example for supplementing the default deployment with cert-manager for TLS\nauthentication, see\nAutomated TLS certificate management using cert-manager\nfor detailssamples/custom-rules:\nan example for spicing up the default deployment with a separately managed\nconfigmap of custom labeling rules, see\nCustom feature source for more information about\ncustom node labelsYou 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\nFeature discovery can alternatively be configured as a one-shot job.\nThe default-job overlay may be used to achieve this:
NUM_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\nNFD-Master, nfd-worker and nfd-topology-updater can be configured to be\ndeployed as separate pods. The master-worker-topologyupdater overlay may be\nused to achieve this:
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/master-worker-topologyupdater?ref=master\n\nIn order to deploy just nfd-topology-updater (without nfd-master and nfd-worker)\nuse the topologyupdater overlay:
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref=master\n\nNFD-Topology-Updater 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;
\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\nSimplest way is to invoke kubectl delete on the overlay that was used for\ndeployment. Beware that this will also delete the namespace that NFD is\nrunning in. For example, in case the default overlay from the repo was used:
kubectl 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\nMinimal steps to deploy latest released version of NFD in your cluster.
\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\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 \"kubernetes.io/arch\": \"amd64\",\n \"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...\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: registry.k8s.io/pause\n name: pause\n nodeSelector:\n # Select a valid feature\n feature.node.kubernetes.io/cpu-cpuid.AESNI: 'true'\nEOF\npod/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>\nIn order to deploy nfd-topology-updater use the topologyupdater kustomize\noverlay.
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref=master\nWait until nfd-topology-updater is running.
\n\n$ kubectl -n node-feature-discovery get ds\nNAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE\ndaemonset.apps/nfd-topology-updater 2 2 2 2 2 <none> 5s\n\nCheck that the NodeResourceTopology objects are created
\n\n$ kubectl get noderesourcetopologies.topology.node.k8s.io\nNAME AGE\nkind-control-plane 23s\nkind-worker 23s\nSee Image variants for description of the different NFD\ncontainer images available.
\n\nUsing Kustomize provides straightforward deployment with\nkubectl integration and declarative customization.
Using Helm provides easy management of NFD deployments with nice\nconfiguration management and easy upgrades.
\n\nUsing Operator provides deployment and configuration management via\nCRDs.
\n","dir":"/deployment/","name":"index.md","path":"deployment/index.md","url":"/deployment/"},{"title":"Worker cmdline reference","layout":"default","sort":2,"content":"To quickly view available command line flags execute nfd-worker -help.\nIn a docker container:
docker run gcr.io/k8s-staging-nfd/node-feature-discovery:master nfd-worker -help\nPrint usage and exit.
\n\nPrint version and exit.
\n\nThe -config flag specifies the path of the nfd-worker configuration file to\nuse.
Default: /etc/kubernetes/node-feature-discovery/nfd-worker.conf
\n\nExample:
\n\nnfd-worker -config=/opt/nfd/worker.conf\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:
Default: empty
\n\nExample:
\n\nnfd-worker -options='{\"sources\":{\"cpu\":{\"cpuid\":{\"attributeWhitelist\":[\"AVX\",\"AVX2\"]}}}}'\nThe -server flag specifies the address of the nfd-master endpoint where to\nconnect to.
Default: localhost:8080
\n\nExample:
\n\nnfd-worker -server=nfd-master.nfd.svc.cluster.local:443\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.
Default: empty
\n\nNote: Must be specified together with -cert-file and -key-file
Example:
\n\nnfd-worker -ca-file=/opt/nfd/ca.crt -cert-file=/opt/nfd/worker.crt -key-file=/opt/nfd/worker.key\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.
Default: empty
\n\nNote: Must be specified together with -ca-file and -key-file
Example:
\n\nnfd-workerr -cert-file=/opt/nfd/worker.crt -key-file=/opt/nfd/worker.key -ca-file=/opt/nfd/ca.crt\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.
Default: empty
\n\nNote: Must be specified together with -cert-file and -ca-file
Example:
\n\nnfd-worker -key-file=/opt/nfd/worker.key -cert-file=/opt/nfd/worker.crt -ca-file=/opt/nfd/ca.crt\nThe -kubeconfig flag specifies the kubeconfig to use for connecting to the\nKubernetes API server. It is only needed for manipulating\nNodeFeature objects, and thus the flag\nonly takes effect when\n-enable-nodefeature-api) is specified. An empty\nvalue (which is also the default) implies in-cluster kubeconfig.
Default: empty
\n\nExample:
\n\nnfd-worker -kubeconfig ${HOME}/.kube/config\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.
Default: empty
\n\nExample:
\n\nnfd-worker -server-name-override=localhost\nThe -feature-sources flag specifies a comma-separated list of enabled feature\nsources. A special value all enables all sources. Prefixing a source name\nwith - indicates that the source will be disabled instead - this is only\nmeaningful when used in conjunction with all. This command line flag allows\ncompletely disabling the feature detection so that neither standard feature\nlabels are generated nor the raw feature data is available for custom rule\nprocessing. Consider using the core.featureSources config file option,\ninstead, allowing dynamic configurability.
Note: This flag takes precedence over the core.featureSources configuration\nfile option.
Default: all
\n\nExample:
\n\nnfd-worker -feature-sources=all,-pci\nThe -label-sources flag specifies a comma-separated list of enabled label\nsources. A special value all enables all sources. Prefixing a source name\nwith - indicates that the source will be disabled instead - this is only\nmeaningful when used in conjunction with all. Consider using the\ncore.labelSources config file option, instead, allowing dynamic\nconfigurability.
Note: This flag takes precedence over the core.labelSources configuration\nfile option.
Default: all
\n\nExample:
\n\nnfd-worker -label-sources=kernel,system,local\nThe -enable-nodefeature-api flag enables the experimental\nNodeFeature CRD API\nfor communicating with nfd-master. This will also automatically disable the\ngRPC communication to nfd-master. When enabled, nfd-worker will create per-node\nNodeFeature objects the contain all discovered node features and the set of\nfeature labels to be created.
Default: false
\n\nExample:
\n\nnfd-worker -enable-nodefeature-api\nThe -no-publish flag disables all communication with the nfd-master and the\nKubernetes API server. It is effectively a “dry-run” flag for nfd-worker.\nNFD-Worker runs feature detection normally, but no labeling requests are sent\nto nfd-master and no NodeFeature objects are created or updated in the API\nserver.
Note: This flag takes precedence over the\ncore.noPublish\nconfiguration file option.
Default: false
\n\nExample:
\n\nnfd-worker -no-publish\nThe -oneshot flag causes nfd-worker to exit after one pass of feature\ndetection.
Default: false
\n\nExample:
\n\nnfd-worker -oneshot -no-publish\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.
If true, adds the file directory to the header of the log messages.
\n\nDefault: false
\n\nLog to standard error as well as files.
\n\nDefault: false
\n\nWhen logging hits line file:N, emit a stack trace.
\n\nDefault: empty
\n\nIf non-empty, write log files in this directory.
\n\nDefault: empty
\n\nIf non-empty, use this log file.
\n\nDefault: empty
\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\nLog to standard error instead of files
\n\nDefault: true
\n\nIf true, avoid header prefixes in the log messages.
\n\nDefault: false
\n\nIf true, avoid headers when opening log files.
\n\nDefault: false
\n\nLogs at or above this threshold go to stderr.
\n\nDefault: 2
\n\nNumber for the log level verbosity.
\n\nDefault: 0
\n\nComma-separated list of pattern=N settings for file-filtered logging.
Default: empty
\n","dir":"/reference/","name":"worker-commandline-reference.md","path":"reference/worker-commandline-reference.md","url":"/reference/worker-commandline-reference.html"},{"title":"NFD-Master","layout":"default","sort":3,"content":"NFD-Master is responsible for connecting to the Kubernetes API server and\nupdating node objects. More specifically, it modifies node labels, taints and\nextended resources based on requests from nfd-workers and 3rd party extensions.
\n\nEXPERIMENTAL\nController for NodeFeature\nobjects can be enabled with the\n-enable-nodefeature-api\ncommand line flag. When enabled, features from NodeFeature objects are used as\nthe input for the NodeFeatureRule\nprocessing pipeline. In addition, any labels listed in the NodeFeature object\nare created on the node (note the allowed\nlabel namespaces are controlled).
\n\n\nNOTE: NodeFeature API must also be enabled in nfd-worker with\nits
\n-enable-nodefeature-api\nflag.
NFD-Master acts as the controller for\nNodeFeatureRule objects.\nIt applies the rules specified in NodeFeatureRule objects on raw feature data\nand creates node labels accordingly. The feature data used as the input can be\nreceived from nfd-worker instances through the gRPC interface or from\nNodeFeature objects. The latter\nrequires that the NodeFeaure controller has been\nenabled.
\n\n\n\n\nNOTE: when gRPC is used for communicating the features (the default\nmechanism), (re-)labelling only happens when a request is received from\nnfd-worker. That is, in practice rules are evaluated and labels for each node\nare created on intervals specified by the\n
\ncore.sleepInterval\nconfiguration option of nfd-worker instances. This means that modification or\ncreation of NodeFeatureRule objects does not instantly cause the node\nlabels to be updated. Instead, the changes only come visible in node labels\nas nfd-worker instances send their labelling requests. This limitation is not\npresent when gRPC interface is disabled\nand NodeFeature API is used.
NFD-Master runs as a deployment, 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\n\n\n\nNOTE: If the NodeFeature controller is enabled the\nreplica count should be 1.
\n
If 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","dir":"/usage/","name":"nfd-master.md","path":"usage/nfd-master.md","url":"/usage/nfd-master.html"},{"title":"Usage","layout":"default","sort":3,"content":"Usage instructions.
\n","dir":"/usage/","name":"index.md","path":"usage/index.md","url":"/usage/"},{"title":"Worker config reference","layout":"default","sort":3,"content":"See the\nsample configuration file\nfor a full example configuration.
\n\nThe core section contains common configuration settings that are not specific\nto any particular feature source.
core.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.
Default: 60s
Example:
\n\ncore:\n sleepInterval: 60s\ncore.featureSources specifies the list of enabled feature sources. A special\nvalue all enables all sources. Prefixing a source name with - indicates\nthat the source will be disabled instead - this is only meaningful when used in\nconjunction with all. This option allows completely disabling the feature\ndetection so that neither standard feature labels are generated nor the raw\nfeature data is available for custom rule processing.
Default: [all]
Example:
\n\ncore:\n # Enable all but cpu and local sources\n featureSources:\n - \"all\"\n - \"-cpu\"\n - \"-local\"\ncore:\n # Enable only cpu and local sources\n featureSources:\n - \"cpu\"\n - \"local\"\ncore.labelSources specifies the list of enabled label sources. A special\nvalue all enables all sources. Prefixing a source name with - indicates\nthat the source will be disabled instead - this is only meaningful when used in\nconjunction with all. This configuration option affects the generation of\nnode labels but not the actual discovery of the underlying feature data that is\nused e.g. in custom/NodeFeatureRule rules.
Note: Overridden by the -label-sources command line flag and\nthe core.sources configurations option (if either of them is specified).
Default: [all]
Example:
\n\ncore:\n # Enable all but cpu and system sources\n labelSources:\n - \"all\"\n - \"-cpu\"\n - \"-system\"\ncore:\n # Enable only cpu and system sources\n labelSources:\n - \"cpu\"\n - \"system\"\nDEPRECATED: use core.labelSources instead.
Note: core.sources takes precedence over the core.labelSources\nconfiguration file option.
core.labelWhiteList specifies a regular expression for filtering feature\nlabels based on the label name. Non-matching labels are not published.
Note: 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\nDefault: null
Example:
\n\ncore:\n labelWhiteList: '^cpu-cpuid'\nSetting core.noPublish to true disables all communication with the\nnfd-master and the Kubernetes API server. It is effectively a “dry-run” option.\nNFD-Worker runs feature detection normally, but no labeling requests are sent\nto nfd-master and no NodeFeature\nobjects are created or updated in the API server.
Note: Overridden by the\n-no-publish command line flag (if\nspecified).
Default: false
Example:
\n\ncore:\n noPublish: true\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\nIf true, adds the file directory to the header of the log messages.
\n\nDefault: false
Run-time configurable: yes
\n\nLog to standard error as well as files.
\n\nDefault: false
Run-time configurable: yes
\n\nWhen logging hits line file:N, emit a stack trace.
\n\nDefault: empty
\n\nRun-time configurable: yes
\n\nIf non-empty, write log files in this directory.
\n\nDefault: empty
\n\nRun-time configurable: no
\n\nIf non-empty, use this log file.
\n\nDefault: empty
\n\nRun-time configurable: no
\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
Run-time configurable: no
\n\nLog to standard error instead of files
\n\nDefault: true
Run-time configurable: yes
\n\nIf true, avoid header prefixes in the log messages.
\n\nDefault: false
Run-time configurable: yes
\n\nIf true, avoid headers when opening log files.
\n\nDefault: false
Run-time configurable: no
\n\nLogs at or above this threshold go to stderr (default 2)
\n\nRun-time configurable: yes
\n\nNumber for the log level verbosity.
\n\nDefault: 0
Run-time configurable: yes
\n\nComma-separated list of pattern=N settings for file-filtered logging.
Default: empty
\n\nRun-time configurable: yes
\n\nThe sources section contains feature source specific configuration parameters.
Prevent publishing cpuid features listed in this option.
\n\nNote: overridden by sources.cpu.cpuid.attributeWhitelist (if specified)
Default: [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]
Example:
\n\nsources:\n cpu:\n cpuid:\n attributeBlacklist: [MMX, MMXEXT]\nOnly publish the cpuid features listed in this option.
\n\nNote: takes precedence over sources.cpu.cpuid.attributeBlacklist
Default: empty
\n\nExample:
\n\nsources:\n cpu:\n cpuid:\n attributeWhitelist: [AVX512BW, AVX512CD, AVX512DQ, AVX512F, AVX512VL]\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\"\nKernel configuration options to publish as feature labels.
\n\nDefault: [NO_HZ, NO_HZ_IDLE, NO_HZ_FULL, PREEMPT]
Example:
\n\nsources:\n kernel:\n configOpts: [NO_HZ, X86, DMI]\nConfiguration option to disable/enable hooks execution. Enabled by default.\nHooks are DEPRECATED since v0.12.0 release and support will be removed in a\nfuture release. Use\nfeature files instead.
\n\nNote: The default NFD container image only supports statically linked binaries.\nUse the full image variant for a\nslightly more extensive environment that additionally supports bash and perl\nruntimes.
\n\nRelated tracking issues:
\n\nExample:
\n\nsources:\n local:\n hooksEnabled: true # true by default\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.
Default: [\"03\", \"0b40\", \"12\"]
Example:
\n\nsources:\n pci:\n deviceClassWhitelist: [\"0200\", \"03\"]\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.
Default: [class, vendor]
Example:
\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
List 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\"]
Example:
\n\nsources:\n usb:\n deviceClassWhitelist: [\"ef\", \"ff\"]\nThe set of USB ID fields from which to compose the name of the feature label.\nValid fields are class, vendor, device and serial.
Default: [class, vendor, device]
Example:
\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
List of rules to process in the custom feature source to create user-specific\nlabels. Refer to the documentation of the\ncustom feature source for\ndetails of the available rules and their configuration.
\n\nDefault: empty
\n\nExample:
\n\nsources:\n custom:\n - name: \"my custom rule\"\n labels:\n my-custom-feature: \"true\"\n matchFeatures:\n - feature: kernel.loadedmodule\n matchExpressions:\n e1000e: {op: Exists}\n - feature: pci.device\n matchExpressions:\n class: {op: In, value: [\"0200\"]}\n vendor: {op: In, value: [\"8086\"]}\nNode Feature Discovery Helm chart allow to easily deploy and manage NFD.
\n\n\n\n\nNOTE: NFD is not ideal for other Helm charts to depend on as that may result\nin multiple parallel NFD deployments in the same cluster which is not fully\nsupported by the NFD Helm chart.
\n
Helm package manager should be installed.
\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\noverride the image tag:
\n\nhelm install node-feature-discovery ./node-feature-discovery/ --set image.tag=master-minimal --namespace $NFD_NS --create-namespace\nYou can override values from values.yaml and provide a file with custom values:
export 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\nTo uninstall the node-feature-discovery deployment:
export 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\nIn order to tailor the deployment of the Node Feature Discovery to your cluster needs\nWe have introduced the following Chart parameters.
\n\n| Name | \nType | \nDefault | \ndescription | \n
|---|---|---|---|
image.repository | \n string | \ngcr.io/k8s-staging-nfd/node-feature-discovery | \n NFD image repository | \n
image.tag | \n string | \nmaster | \n NFD image tag | \n
image.pullPolicy | \n string | \nAlways | \n Image pull policy | \n
imagePullSecrets | \n list | \n[] | \nImagePullSecrets 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
nameOverride | \n string | \n\n | Override the name of the chart | \n
fullnameOverride | \n string | \n\n | Override a default fully qualified app name | \n
tls.enable | \n bool | \nfalse | \nSpecifies whether to use TLS for communications between components | \n
tls.certManager | \n bool | \nfalse | \nIf enabled, requires cert-manager to be installed and will automatically create the required TLS certificates | \n
enableNodeFeatureApi | \n bool | \nfalse | \nEnable the NodeFeature CRD API for communicating node features. This will automatically disable the gRPC communication. | \n
| Name | \nType | \nDefault | \ndescription | \n
|---|---|---|---|
master.* | \n dict | \n\n | NFD master deployment configuration | \n
master.port | \n integer | \n\n | Specifies the TCP port that nfd-master listens for incoming requests. | \n
master.instance | \n string | \n\n | Instance name. Used to separate annotation namespaces for multiple parallel deployments | \n
master.extraLabelNs | \n array | \n[] | \nList of allowed extra label namespaces | \n
master.resourceLabels | \n array | \n[] | \nList of labels to be registered as extended resources | \n
master.crdController | \n bool | \nnull | \nSpecifies whether the NFD CRD API controller is enabled. If not set, controller will be enabled if master.instance is empty. | \n
master.featureRulesController | \n bool | \nnull | \nDEPRECATED: use master.crdController instead | \n
master.replicaCount | \n integer | \n1 | \nNumber of desired pods. This is a pointer to distinguish between explicit zero and not specified | \n
master.podSecurityContext | \n dict | \n{} | \nPodSecurityContext holds pod-level security attributes and common container settings | \n
master.securityContext | \n dict | \n{} | \nContainer security settings | \n
master.serviceAccount.create | \n bool | \ntrue | \nSpecifies whether a service account should be created | \n
master.serviceAccount.annotations | \n dict | \n{} | \nAnnotations to add to the service account | \n
master.serviceAccount.name | \n string | \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
master.rbac.create | \n bool | \ntrue | \nSpecifies whether to create RBAC configuration for nfd-master | \n
master.service.type | \n string | \nClusterIP | \nNFD master service type | \n
master.service.port | \n integer | \n8080 | \nNFD master service port | \n
master.resources | \n dict | \n{} | \nNFD master pod resources management | \n
master.nodeSelector | \n dict | \n{} | \nNFD master pod node selector | \n
master.tolerations | \n dict | \nScheduling to master node is disabled | \nNFD master pod tolerations | \n
master.annotations | \n dict | \n{} | \nNFD master pod annotations | \n
master.affinity | \n dict | \n\n | NFD master pod required node affinity | \n
master.deploymentAnnotations | \n dict | \n{} | \nNFD master deployment annotations | \n
| Name | \nType | \nDefault | \ndescription | \n
|---|---|---|---|
worker.* | \n dict | \n\n | NFD worker daemonset configuration | \n
worker.config | \n dict | \n\n | NFD worker configuration | \n
worker.podSecurityContext | \n dict | \n{} | \nPodSecurityContext holds pod-level security attributes and common container settings | \n
worker.securityContext | \n dict | \n{} | \nContainer security settings | \n
worker.serviceAccount.create | \n bool | \ntrue | \nSpecifies whether a service account for nfd-worker should be created | \n
worker.serviceAccount.annotations | \n dict | \n{} | \nAnnotations to add to the service account for nfd-worker | \n
worker.serviceAccount.name | \n string | \n\n | The name of the service account to use for nfd-worker. If not set and create is true, a name is generated using the fullname template (suffixed with -worker) | \n
worker.rbac.create | \n bool | \ntrue | \nSpecifies whether to create RBAC configuration for nfd-worker | \n
worker.mountUsrSrc | \n bool | \nfalse | \nSpecifies whether to allow users to mount the hostpath /user/src. Does not work on systems without /usr/src AND a read-only /usr | \n
worker.resources | \n dict | \n{} | \nNFD worker pod resources management | \n
worker.nodeSelector | \n dict | \n{} | \nNFD worker pod node selector | \n
worker.tolerations | \n dict | \n{} | \nNFD worker pod node tolerations | \n
worker.priorityClassName | \n string | \n\n | NFD worker pod priority class | \n
worker.annotations | \n dict | \n{} | \nNFD worker pod annotations | \n
worker.daemonsetAnnotations | \n dict | \n{} | \nNFD worker daemonset annotations | \n
| Name | \nType | \nDefault | \ndescription | \n
|---|---|---|---|
topologyUpdater.* | \n dict | \n\n | NFD Topology Updater configuration | \n
topologyUpdater.enable | \n bool | \nfalse | \nSpecifies whether the NFD Topology Updater should be created | \n
topologyUpdater.createCRDs | \n bool | \nfalse | \nSpecifies whether the NFD Topology Updater CRDs should be created | \n
topologyUpdater.serviceAccount.create | \n bool | \ntrue | \nSpecifies whether the service account for topology updater should be created | \n
topologyUpdater.serviceAccount.annotations | \n dict | \n{} | \nAnnotations to add to the service account for topology updater | \n
topologyUpdater.serviceAccount.name | \n string | \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
topologyUpdater.rbac.create | \n bool | \nfalse | \nSpecifies whether to create RBAC configuration for topology updater | \n
topologyUpdater.kubeletConfigPath | \n string | \n”” | \nSpecifies the kubelet config host path | \n
topologyUpdater.kubeletPodResourcesSockPath | \n string | \n”” | \nSpecifies the kubelet sock path to read pod resources | \n
topologyUpdater.updateInterval | \n string | \n60s | \nTime to sleep between CR updates. Non-positive value implies no CR update. | \n
topologyUpdater.watchNamespace | \n string | \n* | \n Namespace to watch pods, * for all namespaces | \n
topologyUpdater.podSecurityContext | \n dict | \n{} | \nPodSecurityContext holds pod-level security attributes and common container settings | \n
topologyUpdater.securityContext | \n dict | \n{} | \nContainer security settings | \n
topologyUpdater.resources | \n dict | \n{} | \nTopology updater pod resources management | \n
topologyUpdater.nodeSelector | \n dict | \n{} | \nTopology updater pod node selector | \n
topologyUpdater.tolerations | \n dict | \n{} | \nTopology updater pod node tolerations | \n
topologyUpdater.annotations | \n dict | \n{} | \nTopology updater pod annotations | \n
topologyUpdater.affinity | \n dict | \n{} | \nTopology updater pod affinity | \n
topologyUpdater.config | \n dict | \n\n | configuration | \n
topologyUpdater.podSetFingerprint | \n bool | \nfalse | \nEnables compute and report of pod fingerprint in NRT objects. | \n
| Name | \nType | \nDefault | \ndescription | \n
|---|---|---|---|
topologyGC.* | \n dict | \n\n | NFD Topology Garbage Collector configuration | \n
topologyGC.enable | \n bool | \ntrue | \nSpecifies whether the NFD Topology Garbage Collector should be created | \n
topologyGC.serviceAccount.create | \n bool | \ntrue | \nSpecifies whether the service account for topology garbage collector should be created | \n
topologyGC.serviceAccount.annotations | \n dict | \n{} | \nAnnotations to add to the service account for topology garbage collector | \n
topologyGC.serviceAccount.name | \n string | \n\n | The name of the service account for topology garbage collector to use. If not set and create is true, a name is generated using the fullname template and -topology-gc suffix | \n
topologyGC.rbac.create | \n bool | \nfalse | \nSpecifies whether to create RBAC configuration for topology garbage collector | \n
topologyGC.interval | \n string | \n1h | \nTime between periodic garbage collector runs | \n
topologyGC.podSecurityContext | \n dict | \n{} | \nPodSecurityContext holds pod-level security attributes and common container settings | \n
topologyGC.securityContext | \n dict | \n{} | \nContainer security settings | \n
topologyGC.resources | \n dict | \n{} | \nTopology garbage collector pod resources management | \n
topologyGC.nodeSelector | \n dict | \n{} | \nTopology garbage collector pod node selector | \n
topologyGC.tolerations | \n dict | \n{} | \nTopology garbage collector pod node tolerations | \n
topologyGC.annotations | \n dict | \n{} | \nTopology garbage collector pod annotations | \n
topologyGC.affinity | \n dict | \n{} | \nTopology garbage collector pod affinity | \n
To quickly view available command line flags execute nfd-topology-updater -help.\nIn a docker container:
docker run gcr.io/k8s-staging-nfd/node-feature-discovery:master \\\nnfd-topology-updater -help\nPrint usage and exit.
\n\nPrint version and exit.
\n\nThe -config flag specifies the path of the nfd-topology-updater\nconfiguration file to use.
Default: /etc/kubernetes/node-feature-discovery/nfd-topology-updater.conf
\n\nExample:
\n\nnfd-topology-updater -config=/opt/nfd/nfd-topology-updater.conf\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.
Default: false
\n\nExample:
\n\nnfd-topology-updater -no-publish\nThe -oneshot flag causes nfd-topology-updater to exit after one pass of\nresource hardware topology detection.
Default: false
\n\nExample:
\n\nnfd-topology-updater -oneshot -no-publish\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.
Default: 60s
\n\nExample:
\n\nnfd-topology-updater -sleep-interval=1h\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.
Default: “*”
\n\nExample:
\n\nnfd-topology-updater -watch-namespace=rte\nThe -kubelet-config-uri specifies the path to the Kubelet’s configuration.\nNote that the URi could either be a local host file or an HTTP endpoint.
Default: https://${NODE_NAME}:10250/configz
Example:
\n\nnfd-topology-updater -kubelet-config-uri=file:///var/lib/kubelet/config.yaml\nThe -api-auth-token-file specifies the path to the api auth token file\nwhich is used to retrieve Kubelet’s configuration from Kubelet secure port,\nonly taking effect when -kubelet-config-uri is https.\nNote that this token file must bind to a role that has the get capability to\nnodes/proxy resources.
Default: /var/run/secrets/kubernetes.io/serviceaccount/token
Example:
\n\nnfd-topology-updater -token-file=/var/run/secrets/kubernetes.io/serviceaccount/token\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.
Default: /host-var/lib/kubelet/pod-resources/kubelet.sock
\n\nExample:
\n\nnfd-topology-updater -podresources-socket=/var/lib/kubelet/pod-resources/kubelet.sock\nEnbles the compute and report the pod set fingerprint in the NRT.\nA pod fingerprint is a compact representation of the “node state” regarding resources.
\n\nDefault: false
Example:
\n\nnfd-topology-updater -pods-fingerprint\nThe Node Feature Discovery Operator automates installation,\nconfiguration and updates of NFD using a specific NodeFeatureDiscovery custom\nresource. This also provides good support for managing NFD as a dependency of\nother operators.
\n\nDeployment using the\nNode Feature Discovery Operator\nis recommended to be done via\noperatorhub.io.
\n\nInstall the operator:
\n\nkubectl create -f https://operatorhub.io/install/nfd-operator.yaml\nCreate NodeFeatureDiscovery object (in nfd namespace here):
cat << EOF | kubectl apply -f -\napiVersion: v1\nkind: Namespace\nmetadata:\n name: nfd\n---\napiVersion: nfd.kubernetes.io/v1\nkind: NodeFeatureDiscovery\nmetadata:\n name: my-nfd-deployment\n namespace: nfd\nspec:\n operand:\n image: gcr.io/k8s-staging-nfd/node-feature-discovery:master\n imagePullPolicy: IfNotPresent\nEOF\nIn order to deploy the minimal image you need to use
\n\n image: gcr.io/k8s-staging-nfd/node-feature-discovery:master-minimal\nin the NodeFeatureDiscovery object above.
If 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\nkubectl delete ns nfd\nSee the node-feature-discovery-operator and OLM project\ndocumentation for instructions for uninstalling the operator and operator\nlifecycle manager, respectively.
\n\n\n","dir":"/deployment/","name":"operator.md","path":"deployment/operator.md","url":"/deployment/operator.html"},{"title":"NFD-Worker","layout":"default","sort":4,"content":"NFD-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\nconfig option.
The 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-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.
Worker 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,\nWorker pod parameter\nworker.config can be used to edit the respective configuration.
See\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 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:
-options='{\"sources\": { \"pci\": { \"deviceClassWhitelist\": [\"12\"] } } }'\nConfiguration options specified from the command line will override those read\nfrom the config file.
\n","dir":"/usage/","name":"nfd-worker.md","path":"usage/nfd-worker.md","url":"/usage/nfd-worker.html"},{"title":"Reference","layout":"default","sort":4,"content":"Command line and configuration reference.
\n","dir":"/reference/","name":"index.md","path":"reference/index.md","url":"/reference/"},{"title":"TLS authentication","layout":"default","sort":5,"content":"NFD 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. The\ntemplate specs provided with NFD contain (commented out) example configuration\nfor enabling TLS authentication.
The 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).
\n\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. Note that -verify-node-name complicates certificate\nmanagement and is not yet supported in the helm or kustomize deployment\nmethods.
cert-manager can be used to automate certificate\nmanagement between nfd-master and the nfd-worker pods.
\n\nThe NFD source code repository contains an example kustomize overlay and helm\nchart that can be used to deploy NFD with cert-manager supplied certificates\nenabled.
\n\nTo install cert-manager itself can be done as easily as this, below, or you\ncan refer to their documentation for other installation methods such as the\nhelm chart they provide.
kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.6.1/cert-manager.yaml\nTo use the kustomize overlay to install node-feature-discovery with TLS enabled,\nyou may use the following:
\n\nkubectl apply -k deployment/overlays/samples/cert-manager\nTo make use of the helm chart, override values.yaml to enable both the\ntls.enabled and tls.certManager options. Note that if you do not enable\ntls.certManager, helm will successfully install the application, but\ndeployment will wait until certificates are manually created, as demonstrated\nbelow.
See the sample installation commands in the Helm Deployment\nand Configuration sections above for how to either override\nindividual values, or provide a yaml file with which to override default\nvalues.
\n\nIf you do not with to make use of cert-manager, the certificates can be\nmanually created and stored as secrets within the NFD namespace.
\n\nCreate a CA certificate
\n\nopenssl req -x509 -newkey rsa:4096 -keyout ca.key -nodes \\\n -subj \"/CN=nfd-ca\" -days 10000 -out ca.crt\nCreate a common openssl config file.
\n\ncat <<EOF > nfd-common.conf\n[ req ]\ndefault_bits = 4096\nprompt = no\ndefault_md = sha256\nreq_extensions = req_ext\ndistinguished_name = dn\n\n[ dn ]\nC = XX\nST = some-state\nL = some-city\nO = some-company\nOU = node-feature-discovery\n\n[ req_ext ]\nsubjectAltName = @alt_names\n\n[ v3_ext ]\nauthorityKeyIdentifier=keyid,issuer:always\nbasicConstraints=CA:FALSE\nkeyUsage=keyEncipherment,dataEncipherment\nextendedKeyUsage=serverAuth,clientAuth\nsubjectAltName=@alt_names\nEOF\nNow, create the nfd-master certificate.
\n\ncat <<EOF > nfd-master.conf\n.include nfd-common.conf\n\n[ dn ]\nCN = nfd-master\n\n[ alt_names ]\nDNS.1 = nfd-master\nDNS.2 = nfd-master.node-feature-discovery.svc.cluster.local\nDNS.3 = localhost\nEOF\n\nopenssl req -new -newkey rsa:4096 -keyout nfd-master.key -nodes -out nfd-master.csr -config nfd-master.conf\nCreate certificates for nfd-worker and nfd-topology-updater
\n\ncat <<EOF > nfd-worker.conf\n.include nfd-common.conf\n\n[ dn ]\nCN = nfd-worker\n\n[ alt_names ]\nDNS.1 = nfd-worker\nDNS.2 = nfd-worker.node-feature-discovery.svc.cluster.local\nEOF\n\n# Config for topology updater is identical except for the DN and alt_names\nsed -e 's/worker/topology-updater/g' < nfd-worker.conf > nfd-topology-updater.conf\n\nopenssl req -new -newkey rsa:4096 -keyout nfd-worker.key -nodes -out nfd-worker.csr -config nfd-worker.conf\nopenssl req -new -newkey rsa:4096 -keyout nfd-topology-updater.key -nodes -out nfd-topology-updater.csr -config nfd-topology-updater.conf\nNow, sign the certificates with the CA created earlier.
\n\nfor cert in nfd-master nfd-worker nfd-topology-updater; do\n echo signing $cert\n openssl x509 -req -in $cert.csr -CA ca.crt -CAkey ca.key \\\n -CAcreateserial -out $cert.crt -days 10000 \\\n -extensions v3_ext -extfile $cert.conf\ndone\nFinally, turn these certificates into secrets.
\n\nfor cert in nfd-master nfd-worker nfd-topology-updater; do\n echo creating secret for $cert in node-feature-discovery namespace\n cat <<EOF | kubectl create -n node-feature-discovery -f -\n---\napiVersion: v1\nkind: Secret\ntype: kubernetes.io/tls\nmetadata:\n name: ${cert}-cert\ndata:\n ca.crt: $( cat ca.crt | base64 -w 0 )\n tls.crt: $( cat $cert.crt | base64 -w 0 )\n tls.key: $( cat $cert.key | base64 -w 0 )\nEOF\n\ndone\nSee the\nsample configuration file\nfor a full example configuration.
\n\nThe excludeList specifies a key-value map of allocated resources\nthat should not be examined by the topology-updater\nagent per node.\nEach key is a node name with a value as a list of resources\nthat should not be examined by the agent for that specific node.
Default: empty
\n\nExample:
\n\nexcludeList:\n nodeA: [hugepages-2Mi]\n nodeB: [memory]\n nodeC: [cpu, hugepages-2Mi]\nexcludeList.* is a special value that use to specify all nodes.\nA resource that would be listed under this key, would be excluded from all nodes.
Default: empty
\n\nExample:
\n\nexcludeList:\n '*': [hugepages-2Mi]\nNFD-Topology-Updater is preferably run as a Kubernetes DaemonSet. This assures\nre-examination on regular intervals, capturing changes in the allocated\nresources and hence the allocatable resources on a per zone basis by updating\nNodeResourceTopology custom resources.\nIt makes sure that new NodeResourceTopology instances are created for each new\nnodes that get added to the cluster.
\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\noption. The default sleep interval is set to 60s which is the value when no\n-sleep-interval is specified.\nIn addition, it can avoid examining specific allocated resources\ngiven a configuration of resources to exclude via -excludeList
Kubelet PodResource API is a prerequisite for\nnfd-topology-updater to be able to run.
\n\nPreceding Kubernetes v1.23, the kubelet must be started with\n--feature-gates=KubeletPodResourcesGetAllocatable=true.
Starting from Kubernetes v1.23, the KubeletPodResourcesGetAllocatable\nfeature gate. is enabled by default
NFD-Topology-Updater supports configuration through a configuration file. The\ndefault location is /etc/kubernetes/node-feature-discovery/topology-updater.conf,\nbut, this can be changed by specifying the-config command line flag.
\n\n\nNOTE: unlike nfd-worker,\ndynamic configuration updates are not currently supported.
\n
Topology-Updater configuration file is read inside the container,\nand thus, Volumes and VolumeMounts are needed\nto make your configuration available for NFD.\nThe preferred method is to use a ConfigMap\nwhich provides easy deployment and re-configurability.
\n\nThe provided nfd-topology-updater deployment templates\ncreate an empty configmap\nand mount it inside the nfd-topology-updater containers.\nIn kustomize deployments, configuration can be edited with:
\n\nkubectl -n ${NFD_NS} edit configmap nfd-topology-updater-conf\nIn Helm deployments,\nTopology Updater parameters\ntoplogyUpdater.config can be used to edit the respective configuration.
See\nnfd-topology-updater 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 a configuration.
\n\n\n","dir":"/usage/","name":"nfd-topology-updater.md","path":"usage/nfd-topology-updater.md","url":"/usage/nfd-topology-updater.html"},{"title":"Developer guide","layout":"default","sort":5,"content":"git clone https://github.com/kubernetes-sigs/node-feature-discovery\ncd node-feature-discovery\nSee customizing the build below for altering the\ncontainer image registry, for example.
\n\nmake\nOptional, this example with Docker.
\n\ndocker push <IMAGE_TAG>\nThe default set of architectures enabled for mulit-arch builds are linux/amd64\nand linux/arm64. If more architectures are needed one can override the\nIMAGE_ALL_PLATFORMS variable with a comma separated list of OS/ARCH tuples.
make image-all\nCurrently docker does not support loading of manifest-lists meaning the images\nare not shown when executing docker images, see:\nbuildx issue #59.
make push-all\nThe resulting container image can be used in the same way on each arch by pulling\ne.g. node-feature-discovery:master without specifying the\narchitecture. The manifest-list will take care of providing the right\narchitecture image.
To use your published image from the step above instead of the\nregistry.k8s.io/nfd/node-feature-discovery image, edit image\nattribute in the spec template(s) to the new location\n(<registry-name>/<image-name>[:<version>]).
The 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.
K8S_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.
You can also build the binaries locally
\n\nmake build\nThis will compile binaries under bin/
There 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| Variable | \nDescription | \nDefault value | \n
|---|---|---|
| HOSTMOUNT_PREFIX | \nPrefix of system directories for feature discovery (local builds) | \n/ (local builds) /host- (container builds) | \n
| IMAGE_BUILD_CMD | \nCommand to build the image | \ndocker build | \n
| IMAGE_BUILD_EXTRA_OPTS | \nExtra options to pass to build command | \nempty | \n
| IMAGE_BUILDX_CMD | \nCommand to build and push multi-arch images with buildx | \nDOCKER_CLI_EXPERIMENTAL=enabled docker buildx build –platform=${IMAGE_ALL_PLATFORMS} –progress=auto –pull | \n
| IMAGE_ALL_PLATFORMS | \nComma separated list of OS/ARCH tuples for mulit-arch builds | \nlinux/amd64,linux/arm64 | \n
| IMAGE_PUSH_CMD | \nCommand to push the image to remote registry | \ndocker push | \n
| IMAGE_REGISTRY | \nContainer image registry to use | \nregistry.k8s.io/nfd | \n
| IMAGE_TAG_NAME | \nContainer image tag name | \n<nfd version> | \n
| IMAGE_EXTRA_TAG_NAMES | \nAdditional container image tag(s) to create when building image | \nempty | \n
| K8S_NAMESPACE | \nnfd-master and nfd-worker namespace | \nnode-feature-discovery | \n
| KUBECONFIG | \nKubeconfig for running e2e-tests | \nempty | \n
| E2E_TEST_CONFIG | \nParameterization file of e2e-tests (see example) | \nempty | \n
| E2E_PULL_IF_NOT_PRESENT | \nTrue-ish value makes the image pull policy IfNotPresent (to be used only in e2e tests) | \nfalse | \n
| OPENSHIFT | \nNon-empty value enables OpenShift specific support (currently only effective in e2e tests) | \nempty | \n
For 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\nvia environment
\n\n IMAGE_BUILD_CMD=\"buildah bud\" make\nby overriding the variable value
\n\n make IMAGE_BUILD_CMD=\"buildah bud\"\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\nmake test\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\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\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.
$ 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\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.
NOTE 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.
In 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.
NOTE:
\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.
PodResource 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.
Another option for building NFD locally is via Tilt tool, which can build container\nimages, push them to a local registry and reload your Kubernetes pods automatically.\nWhen using Tilt, you don’t have to build container images and re-deploy your pods\nmanually but instead let the Tilt take care of it. Tiltfile is a configuration file\nfor the Tilt and is located at the root directory. To develop NFD with Tilt, follow\nthe steps below.
\n\nTo start up your Tilt development environment, just run
\n\ntilt up\nat the root of your local NFD codebase. Tilt will start a web interface in the\nlocalhost and port 10350. From the web interface, you are able to see how NFD worker\nand master are progressing, watch their build and runtime logs. Once your code changes\nare saved locally, Tilt will notice it and re-build the container image from the\ncurrent code, push the image to the registry and re-deploy NFD pods with the latest\ncontainer image.
\n\nTo override environment variables used in the Tiltfile during image build,\nexport them in your current terminal before starting Tilt.
\n\nexport IMAGE_TAG_NAME=\"v1\"\ntilt up\nThis will override the default value(master) of IMAGE_TAG_NAME variable defined\nin the Tiltfile.
All 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\nmake site-serve\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.
In order to just build the html documentation run:
\n\nmake site-build\nThis will generate html documentation under docs/_site/.
You can reach us via the following channels:
\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\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":"Uninstallation","layout":"default","sort":6,"content":"Follow the uninstallation instructions of the deployment method used\n(kustomize,\nhelm or\noperator).
\n\nNFD-Master has a special -prune command line flag for removing all\nnfd-related node labels, annotations and extended resources from the cluster.
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prune?ref=master\nkubectl -n node-feature-discovery wait job.batch/nfd-master --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","dir":"/deployment/","name":"uninstallation.md","path":"deployment/uninstallation.md","url":"/deployment/uninstallation.html"},{"title":"Topology Garbage Collector Cmdline Reference","layout":"default","sort":6,"content":"To quickly view available command line flags execute nfd-topology-gc -help.\nIn a docker container:
docker run gcr.io/k8s-staging-nfd/node-feature-discovery:master \\\nnfd-topology-gc -help\nPrint usage and exit.
\n\nPrint version and exit.
\n\nThe -gc-interval specifies the interval between periodic garbage collector runs.
Default: 1h
\n\nExample:
\n\nnfd-topology-gc -gc-interval=1h\nNFD-Topology-Garbage-Collector is preferably run as a Kubernetes deployment\nwith one replica. It makes sure that all\nNodeResourceTopology\nhave corresponding worker nodes and removes stale objects for worker nodes\nwhich are no longer part of Kubernetes cluster.
\n\nThis service watches for Node deletion events and removes NodeResourceTopology\nobjects upon them. It is also running periodically to make sure no event was\nmissed or NodeResourceTopology object was created without corresponding worker\nnode. The default garbage collector interval is set to 1h which is the value\nwhen no -gc-interval is specified.
\n\nIn Helm deployments,\n(see Topology Garbage Collector\nfor parameters). NFD-Topology-Garbage-Collector will only be deployed when\ntopologyUpdater.enable is set to true.
\n","dir":"/usage/","name":"nfd-topology-gc.md","path":"usage/nfd-topology-gc.md","url":"/usage/nfd-topology-gc.html"},{"title":"CRDs","layout":"default","sort":7,"content":"NFD uses some Kubernetes custom resources.
\n\nEXPERIMENTAL\nNodeFeature is an NFD-specific custom resource for communicating node\nfeatures and node labeling requests. Support for NodeFeature objects is\ndisabled by default. If enabled, nfd-master watches for NodeFeature objects,\nlabels nodes as specified and uses the listed features as input when evaluating\nNodeFeatureRules. NodeFeature objects can be used for\nimplementing 3rd party extensions (see\ncustomization guide for more\ndetails).
\n\napiVersion: nfd.k8s-sigs.io/v1alpha1\nkind: NodeFeature\nmetadata:\n labels:\n nfd.node.kubernetes.io/node-name: node-1\n name: node-1-vendor-features\nspec:\n features:\n instances:\n vendor.device:\n elements:\n - attributes:\n model: \"xpu-1\"\n memory: \"4000\"\n type: \"fast\"\n - attributes:\n model: \"xpu-2\"\n memory: \"16000\"\n type: \"slow\"\n labels:\n vendor-xpu-present: \"true\"\nNodeFeatureRule is an NFD-specific custom resource that is designed for\nrule-based custom labeling of nodes. NFD-Master watches for NodeFeatureRule\nobjects in the cluster and labels nodes according to the rules within. Some use\ncases are e.g. application specific labeling in a specific environments or\nbeing distributed by hardware vendors to create specific labels for their\ndevices.
\n\napiVersion: nfd.k8s-sigs.io/v1alpha1\nkind: NodeFeatureRule\nmetadata:\n name: example-rule\nspec:\n rules:\n - name: \"example rule\"\n labels:\n \"example-custom-feature\": \"true\"\n # Label is created if all of the rules below match\n matchFeatures:\n # Match if \"veth\" kernel module is loaded\n - feature: kernel.loadedmodule\n matchExpressions:\n veth: {op: Exists}\n # Match if any PCI device with vendor 8086 exists in the system\n - feature: pci.device\n matchExpressions:\n vendor: {op: In, value: [\"8086\"]}\nSee the\nCustomization guide\nfor full documentation of the NodeFeatureRule resource and its usage.
\n\nWhen run with NFD-Topology-Updater, NFD creates NodeResourceTopology objects\ncorresponding to node 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\nThe NodeResourceTopology objects created by NFD can be used to gain insight\ninto the allocatable resources along with the granularity of those resources at\na per-zone level (represented by node-0 and node-1 in the above example) or can\nbe used by an external entity (e.g. topology-aware scheduler plugin) to take an\naction based on the gathered information.
\n\n\n","dir":"/usage/","name":"custom-resources.md","path":"usage/custom-resources.md","url":"/usage/custom-resources.html"},{"title":"Customization guide","layout":"default","sort":8,"content":"NFD provides multiple extension points for vendor and application specific\nlabeling:
\n\nNodeFeature (EXPERIMENTAL) objects can be\nused to communicate “raw” node features and node labeling requests to\nnfd-master.NodeFeatureRule objects provide a way to\ndeploy custom labeling rules via the Kubernetes API.local feature source of nfd-worker creates\nlabels by executing hooks and reading files.custom feature source of nfd-worker creates\nlabels based on user-specified rules.EXPERIMENTAL\nNodeFeature objects provide a way for 3rd party extensions to advertise custom\nfeatures, both as “raw” features that serve as input to\nNodeFeatureRule objects and as feature\nlabels directly.
\n\nNote that RBAC rules must be created for each extension for them to be able to\ncreate and manipulate NodeFeature objects in their namespace.
\n\nSupport for NodeFeature CRD API is enabled with the -enable-nodefeature-api\ncommand line flag. This flag must be specified for both nfd-master and\nnfd-worker as it will disable the gRPC communication between them.
Consider the following referential example:
\n\napiVersion: nfd.k8s-sigs.io/v1alpha1\nkind: NodeFeature\nmetadata:\n labels:\n nfd.node.kubernetes.io/node-name: node-1\n name: vendor-features-for-node-1\nspec:\n # Features for NodeFeatureRule matching\n features:\n flags:\n vendor.flags:\n elements:\n feature-x: {}\n feature-y: {}\n attributes:\n vendor.config:\n elements:\n setting-a: \"auto\"\n knob-b: \"123\"\n instances:\n vendor.devices:\n elements:\n - attributes:\n model: \"dev-1000\"\n vendor: \"acme\"\n - attributes:\n model: \"dev-2000\"\n vendor: \"acme\"\n # Labels to be created\n labels:\n vendor-feature.enabled: \"true\"\nThe object targets node named node-1. It lists two “flag type” features under\nthe vendor.flags domain, two “attribute type” features and under the\nvendor.config domain and two “instance type” features under the\nvendor.devices domain. These features will not be directly affecting the node\nlabels but they will be used as input when the\nNodeFeatureRule objects are evaluated.
In addition, the example requests directly the\nfeature.node.kubenernetes.io/vendor-feature.enabled=true node label to be\ncreated.
The nfd.node.kubernetes.io/node-name=<node-name> must be in place for each\nNodeFeature object as NFD uses it to determine the node which it is targeting.
Features are divided into three different types:
\n\nNodeFeatureRule objects provide an easy way to create vendor or application\nspecific labels and taints. It uses a flexible rule-based mechanism for creating\nlabels and optionally taints based on node features.
Consider the following referential example:
\n\napiVersion: nfd.k8s-sigs.io/v1alpha1\nkind: NodeFeatureRule\nmetadata:\n name: my-sample-rule-object\nspec:\n rules:\n - name: \"my sample rule\"\n labels:\n \"my-sample-feature\": \"true\"\n matchFeatures:\n - feature: kernel.loadedmodule\n matchExpressions:\n dummy: {op: Exists}\n - feature: kernel.config\n matchExpressions:\n X86: {op: In, value: [\"y\"]}\nIt specifies one rule which creates node label\nfeature.node.kubenernetes.io/my-sample-feature=true if both of the following\nconditions are true (matchFeatures implements a logical AND over the\nmatchers):
dummy network driver module has been loaded=yCreate a NodeFeatureRule with a yaml file:
kubectl apply -f https://raw.githubusercontent.com/kubernetes-sigs/node-feature-discovery/master/examples/nodefeaturerule.yaml\nNow, on X86 platforms the feature label appears after doing modprobe dummy on\na system and correspondingly the label is removed after rmmod dummy. Note a\nre-labeling delay up to the sleep-interval of nfd-worker (1 minute by default).
See Label rule format for detailed description of\navailable fields and how to write labeling rules.
\nThis feature is experimental.
\n\nIn some circumstances, it is desirable to keep nodes with specialized hardware\naway from running general workload and instead leave them for workloads that\nneed the specialized hardware. One way to achieve it is to taint the nodes with\nthe specialized hardware and add corresponding toleration to pods that require\nthe special hardware. NFD offers node tainting functionality which is disabled\nby default. User can define one or more custom taints via the taints field of\nthe NodeFeatureRule CR. The same rule-based mechanism is applied here and the\nNFD taints only rule matching nodes.
To enable the tainting feature, --enable-taints flag needs to be set to true.\nIf the flag --enable-taints is set to false (i.e. disabled), taints defined in\nthe NodeFeatureRule CR have no effect and will be ignored by the NFD master.
NOTE: Before enabling any taints, make sure to edit nfd-worker daemonset to\ntolerate the taints to be created. Otherwise, already running pods that do not\ntolerate the taint are evicted immediately from the node including the nfd-worker\npod.
\n\nExample NodeFeatureRule with custom taints:
\n\napiVersion: nfd.k8s-sigs.io/v1alpha1\nkind: NodeFeatureRule\nmetadata:\n name: my-sample-rule-object\nspec:\n rules:\n - name: \"my sample taint rule\"\n taints:\n - effect: PreferNoSchedule\n key: \"feature.node.kubernetes.io/special-node\"\n value: \"true\"\n - effect: NoExecute\n key: \"feature.node.kubernetes.io/dedicated-node\"\n matchFeatures:\n - feature: kernel.loadedmodule\n matchExpressions:\n dummy: {op: Exists}\n - feature: kernel.config\n matchExpressions:\n X86: {op: In, value: [\"y\"]}\nIn this example, if the my sample taint rule rule is matched, feature.node.kubernetes.io/pci-0300_1d0f.present=true:NoExecute\nand feature.node.kubernetes.io/cpu-cpuid.ADX:NoExecute taints are set on the node.
NFD-Worker has a special feature source named local which is an integration\npoint for external feature detectors. It provides a mechanism for pluggable\nextensions, allowing the creation of new user-specific features and even\noverriding built-in labels.
The local feature source has two methods for detecting features, hooks and\nfeature files. The features discovered by the local source can further be\nused in label rules specified in\nNodeFeatureRule objects and the\ncustom feature source.
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.
Consider a shell script\n/etc/kubernetes/node-feature-discovery/source.d/my-hook.sh having the\nfollowing stdout output, or alternatively, a plaintext file\n/etc/kubernetes/node-feature-discovery/features.d/my-features having the\nfollowing contents:
my-feature.1\nmy-feature.2=myvalue\nmy.namespace/my-feature.3=456\nThis will translate into the following node labels:
\n\nfeature.node.kubernetes.io/my-feature.1: \"true\"\nfeature.node.kubernetes.io/my-feature.2: \"myvalue\"\nmy.namespace/my-feature.3: \"456\"\nDEPRECATED The local source executes hooks found in\n/etc/kubernetes/node-feature-discovery/source.d/. The hook files must be\nexecutable and they are supposed to print all discovered features in stdout.\nSince NFD v0.13 the default container image only supports statically linked ELF\nbinaries.
stderr output of hooks is propagated to NFD log so it can be used for\ndebugging and logging.
NFD tries to execute any regular files found from the hooks directory.\nAny additional data files the hook might need (e.g. a configuration file)\nshould be placed in a separate directory in order to avoid NFD unnecessarily\ntrying to execute them. A subdirectory under the hooks directory can be used,\nfor example /etc/kubernetes/node-feature-discovery/source.d/conf/.
NOTE: Hooks are being DEPRECATED and will be removed in a future release.\nFor backward compatibility, currently hooks are enabled by default and can be\ndisabled via sources.local.hooksEnabled field in the worker configuration.
sources:\n local:\n hooksEnabled: true # true by default at this point\nNOTE: 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\nNOTE: The full image variant\nprovides backwards-compatibility with older NFD versions by including a more\nexpanded environment, supporting bash and perl runtimes.
\n\nThe local source reads files found in\n/etc/kubernetes/node-feature-discovery/features.d/.
The hook stdout and feature files are expected to contain features in simple\nkey-value pairs, separated by newlines:
\n\n<name>[=<value>]\nThe label value defaults to true, if not specified.
Label namespace may be specified with <namespace>/<name>[=<value>].
The standard NFD deployments contain hostPath mounts for\n/etc/kubernetes/node-feature-discovery/source.d/ and\n/etc/kubernetes/node-feature-discovery/features.d/, making these directories\nfrom the host available inside the nfd-worker container.
One use case for the hooks and/or feature files is detecting features in other\nPods outside NFD, e.g. in Kubernetes device plugins. By using the same\nhostPath mounts for /etc/kubernetes/node-feature-discovery/source.d/ and\n/etc/kubernetes/node-feature-discovery/features.d/ in the side-car (e.g.\ndevice plugin) creates a shared area for deploying hooks and feature files to\nNFD. NFD will periodically scan the directories and run any hooks and read any\nfeature files it finds.
The custom feature source in nfd-worker provides a rule-based mechanism for\nlabel creation, similar to the\nNodeFeatureRule objects. The difference is\nthat the rules are specified in the worker configuration instead of a\nKubernetes API object.
See worker configuration\nfor instructions how to set-up and manage the worker configuration.
\n\nConsider the following referential configuration for nfd-worker:
\n\ncore:\n labelSources: [\"custom\"]\nsources:\n custom:\n - name: \"my sample rule\"\n labels:\n \"my-sample-feature\": \"true\"\n matchFeatures:\n - feature: kernel.loadedmodule\n matchExpressions:\n dummy: {op: Exists}\n - feature: kernel.config\n matchExpressions:\n X86: {op: In, value: [\"y\"]}\nIt specifies one rule which creates node label\nfeature.node.kubenernetes.io/my-sample-feature=true if both of the following\nconditions are true (matchFeatures implements a logical AND over the\nmatchers):
dummy network driver module has been loaded=yIn addition, the configuration only enables the custom source, disabling all\nbuilt-in labels.
Now, on X86 platforms the feature label appears after doing modprobe dummy on\na system and correspondingly the label is removed after rmmod dummy. Note a\nre-labeling delay up to the sleep-interval of nfd-worker (1 minute by default).
In addition to the rules defined in the nfd-worker configuration file, the\ncustom feature source 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.
As an example, consider having file\n/etc/kubernetes/node-feature-discovery/custom.d/my-rule.yaml with the\nfollowing content:
- name: \"my e1000 rule\"\n labels:\n \"e1000.present\": \"true\"\n matchFeatures:\n - feature: kernel.loadedmodule\n matchExpressions:\n e1000: {op: Exists}\nThis simple rule will create feature.node.kubenernetes.io/e1000.present=true\nlabel if the e1000 kernel module has been loaded.
The\nsamples/custom-rules\nkustomize overlay sample contains an example for deploying a custom rule from a\nConfigMap.
Feature labels have the following format:
\n\n<namespace>/<name> = <value>\nThe namespace part (i.e. prefix) of the labels is controlled by nfd:
\n\nfeature.node.kubernetes.io. This is also\nthe default for user defined features that don’t specify any namespace.-deny-label-ns\ncommand line flag of nfd-master\n -extra-label-ns\ncommand line flag of nfd-master.\ne.g: nfd-master -deny-label-ns=\"*\" -extra-label-ns=example.comThis section describes the rule format used in\nNodeFeatureRule objects and in the\nconfiguration of the custom feature source.
It is based on a generic feature matcher that covers all features discovered by\nnfd-worker. The rules rely on a unified data model of the available features\nand a generic expression-based format. Features that can be used in the rules\nare described in detail in available features below.
\n\nTake this rule as a referential example:
\n\n - name: \"my feature rule\"\n labels:\n \"my-special-feature\": \"my-value\"\n matchFeatures:\n - feature: cpu.cpuid\n matchExpressions:\n AVX512F: {op: Exists}\n - feature: kernel.version\n matchExpressions:\n major: {op: In, value: [\"5\"]}\n minor: {op: Gt, value: [\"1\"]}\n - feature: pci.device\n matchExpressions:\n vendor: {op: In, value: [\"8086\"]}\n class: {op: In, value: [\"0200\"]}\nThis will yield feature.node.kubenernetes.io/my-special-feature=my-value node\nlabel if all of these are true (matchFeatures implements a logical AND over\nthe matchers):
The .name field is required and used as an identifier of the rule.
The .labels is a map of the node labels to create if the rule matches.
The .labelsTemplate field specifies a text template for dynamically creating\nlabels based on the matched features. See templating for\ndetails.
NOTE The labels field has priority over labelsTemplate, i.e.\nlabels specified in the labels field will override anything\noriginating from labelsTemplate.
taints is a list of taint entries and each entry can have key, value and effect,\nwhere the value is optional. Effect could be NoSchedule, PreferNoSchedule\nor NoExecute. To learn more about the meaning of these effects, check out k8s documentation.
NOTE taints field is not available for the custom rules of nfd-worker and only\nfor NodeFeatureRule objects.
\n\nThe .vars field is a map of values (key-value pairs) to store for subsequent\nrules to use. In other words, these are variables that are not advertised as\nnode labels. See backreferences for more details on the\nusage of vars.
The .varsTemplate field specifies a text template for dynamically creating\nvars based on the matched features. See templating for details\non using templates and backreferences for more details on\nthe usage of vars.
NOTE The vars field has priority over varsTemplate, i.e.\nvars specified in the vars field will override anything originating from\nvarsTemplate.
The .matchFeatures field specifies a feature matcher, consisting of a list of\nfeature matcher terms. It implements a logical AND over the terms i.e. all\nof them must match in order for the rule to trigger.
matchFeatures:\n - feature: <feature-name>\n matchExpressions:\n <key>:\n op: <op>\n value:\n - <value-1>\n - ...\nThe .matchFeatures[].feature field specifies the feature against which to\nmatch.
The .matchFeatures[].matchExpressions field specifies a map of expressions\nwhich to evaluate against the elements of the feature.
In each MatchExpression op specifies the operator to apply. Valid values are\ndescribed below.
| Operator | \nNumber of values | \nMatches when | \n
|---|---|---|
In | \n 1 or greater | \nInput is equal to one of the values | \n
NotIn | \n 1 or greater | \nInput is not equal to any of the values | \n
InRegexp | \n 1 or greater | \nValues of the MatchExpression are treated as regexps and input matches one or more of them | \n
Exists | \n 0 | \nThe key exists | \n
DoesNotExist | \n 0 | \nThe key does not exists | \n
Gt | \n 1 | \nInput is greater than the value. Both the input and value must be integer numbers. | \n
Lt | \n 1 | \nInput is less than the value. Both the input and value must be integer numbers. | \n
GtLt | \n 2 | \nInput is between two values. Both the input and value must be integer numbers. | \n
IsTrue | \n 0 | \nInput is equal to “true” | \n
IsFalse | \n 0 | \nInput is equal “false” | \n
The value field of MatchExpression is a list of string arguments to the\noperator.
The behavior of MatchExpression depends on the feature type:\nfor flag and attribute features the MatchExpression operates on the feature\nelement whose name matches the <key>. However, for instance features all\nMatchExpressions are evaluated against the attributes of each instance\nseparately.
The .matchAny field is a list of of matchFeatures\nmatchers. A logical OR is applied over the matchers, i.e. at least one of them\nmust match in order for the rule to trigger.
Consider the following example:
\n\n matchAny:\n - matchFeatures:\n - feature: kernel.loadedmodule\n matchExpressions:\n kmod-1: {op: Exists}\n - feature: pci.device\n matchExpressions:\n vendor: {op: In, value: [\"0eee\"]}\n class: {op: In, value: [\"0200\"]}\n - matchFeatures:\n - feature: kernel.loadedmodule\n matchExpressions:\n kmod-2: {op: Exists}\n - feature: pci.device\n matchExpressions:\n vendor: {op: In, value: [\"0fff\"]}\n class: {op: In, value: [\"0200\"]}\nThis matches if kernel module kmod-1 is loaded and a network controller from\nvendor 0eee is present, OR, if kernel module kmod-2 has been loaded and a\nnetwork controller from vendor 0fff is present (OR both of these conditions are\ntrue).
\n\nThe following features are available for matching:
\n\n| Feature | \nFeature type | \nElements | \nValue type | \nDescription | \n
|---|---|---|---|---|
cpu.cpuid | \n flag | \n\n | \n | Supported CPU capabilities | \n
| \n | \n | <cpuid-flag> | \n \n | CPUID flag is present | \n
cpu.cstate | \n attribute | \n\n | \n | Status of cstates in the intel_idle cpuidle driver | \n
| \n | \n | enabled | \n bool | \n‘true’ if cstates are set, otherwise ‘false’. Does not exist of intel_idle driver is not active. | \n
cpu.model | \n attribute | \n\n | \n | CPU model related attributes | \n
| \n | \n | family | \n int | \nCPU family | \n
| \n | \n | vendor_id | \n string | \nCPU vendor ID | \n
| \n | \n | id | \n int | \nCPU model ID | \n
cpu.pstate | \n attribute | \n\n | \n | State of the Intel pstate driver. Does not exist if the driver is not enabled. | \n
| \n | \n | status | \n string | \nStatus of the driver, possible values are ‘active’ and ‘passive’ | \n
| \n | \n | turbo | \n bool | \n‘true’ if turbo frequencies are enabled, otherwise ‘false’ | \n
| \n | \n | scaling | \n string | \nActive scaling_governor, possible values are ‘powersave’ or ‘performance’. | \n
cpu.rdt | \n flag | \n\n | \n | Intel RDT capabilities supported by the system | \n
| \n | \n | <rdt-flag> | \n \n | RDT capability is supported, see RDT flags for details | \n
cpu.security | \n attribute | \n\n | \n | Features related to security and trusted execution environments | \n
| \n | \n | sgx.enabled | \n bool | \ntrue if Intel SGX (Software Guard Extensions) has been enabled, otherwise does not exist | \n
| \n | \n | se.enabled | \n bool | \ntrue if IBM Secure Execution for Linux is available and has been enabled, otherwise does not exist | \n
| \n | \n | tdx.enabled | \n bool | \ntrue if Intel TDX (Trusted Domain Extensions) is available on the host and has been enabled, otherwise does not exist | \n
cpu.sgx | \n attribute | \n\n | \n | DEPRECATED: replaced by cpu.security feature | \n
| \n | \n | enabled | \n bool | \nDEPRECATED: use sgx.enabled from cpu.security instead | \n
cpu.sst | \n attribute | \n\n | \n | Intel SST (Speed Select Technology) capabilities | \n
| \n | \n | bf.enabled | \n bool | \ntrue if Intel SST-BF (Intel Speed Select Technology - Base frequency) has been enabled, otherwise does not exist | \n
cpu.se | \n attribute | \n\n | \n | DEPRECATED: replaced by cpu.security feature | \n
| \n | \n | enabled | \n bool | \nDEPRECATED: use se.enabled from cpu.security instead | \n
cpu.topology | \n attribute | \n\n | \n | CPU topology related features | \n
| \n | \n | hardware_multithreading | \n bool | \nHardware multithreading, such as Intel HTT, is enabled | \n
cpu.coprocessor | \n attribute | \n\n | \n | CPU Coprocessor related features | \n
| \n | \n | nx_gzip | \n bool | \nNest Accelerator GZIP support is enabled | \n
kernel.config | \n attribute | \n\n | \n | Kernel configuration options | \n
| \n | \n | <config-flag> | \n string | \nValue of the kconfig option | \n
kernel.loadedmodule | \n flag | \n\n | \n | Loaded kernel modules | \n
| \n | \n | mod-name | \n \n | Kernel module <mod-name> is loaded | \n
kernel.selinux | \n attribute | \n\n | \n | Kernel SELinux related features | \n
| \n | \n | enabled | \n bool | \ntrue if SELinux has been enabled and is in enforcing mode, otherwise false | \n
kernel.version | \n attribute | \n\n | \n | Kernel version information | \n
| \n | \n | full | \n string | \nFull kernel version (e.g. ‘4.5.6-7-g123abcde’) | \n
| \n | \n | major | \n int | \nFirst component of the kernel version (e.g. ‘4’) | \n
| \n | \n | minor | \n int | \nSecond component of the kernel version (e.g. ‘5’) | \n
| \n | \n | revision | \n int | \nThird component of the kernel version (e.g. ‘6’) | \n
local.label | \n attribute | \n\n | \n | Features from hooks and feature files, i.e. labels from the local feature source | \n
| \n | \n | <label-name> | \n string | \nLabel <label-name> created by the local feature source, value equals the value of the label | \n
memory.nv | \n instance | \n\n | \n | NVDIMM devices present in the system | \n
| \n | \n | <sysfs-attribute> | \n string | \nValue of the sysfs device attribute, available attributes: devtype, mode | \n
memory.numa | \n attribute | \n\n | \n | NUMA nodes | \n
| \n | \n | is_numa | \n bool | \ntrue if NUMA architecture, false otherwise | \n
| \n | \n | node_count | \n int | \nNumber of NUMA nodes | \n
network.device | \n instance | \n\n | \n | Physical (non-virtual) network interfaces present in the system | \n
| \n | \n | name | \n string | \nName of the network interface | \n
| \n | \n | <sysfs-attribute> | \n string | \nSysfs network interface attribute, available attributes: operstate, speed, sriov_numvfs, sriov_totalvfs | \n
pci.device | \n instance | \n\n | \n | PCI devices present in the system | \n
| \n | \n | <sysfs-attribute> | \n string | \nValue of the sysfs device attribute, available attributes: class, vendor, device, subsystem_vendor, subsystem_device, sriov_totalvfs, iommu_group/type, iommu/intel-iommu/version | \n
storage.device | \n instance | \n\n | \n | Block storage devices present in the system | \n
| \n | \n | name | \n string | \nName of the block device | \n
| \n | \n | <sysfs-attribute> | \n string | \nSysfs network interface attribute, available attributes: dax, rotational, nr_zones, zoned | \n
system.osrelease | \n attribute | \n\n | \n | System identification data from /etc/os-release | \n
| \n | \n | <parameter> | \n string | \nOne parameter from /etc/os-release | \n
system.name | \n attribute | \n\n | \n | System name information | \n
| \n | \n | nodename | \n string | \nName of the kubernetes node object | \n
usb.device | \n instance | \n\n | \n | USB devices present in the system | \n
| \n | \n | <sysfs-attribute> | \n string | \nValue of the sysfs device attribute, available attributes: class, vendor, device, serial | \n
rule.matched | \n attribute | \n\n | \n | Previously matched rules | \n
| \n | \n | <label-or-var> | \n string | \nLabel or var from a preceding rule that matched | \n
Rules support template-based creation of labels and vars with the\n.labelsTemplate and .varsTemplate fields. These makes it possible to\ndynamically generate labels and vars based on the features that matched.
The template must expand into a simple format with <key>=<value> pairs\nseparated by newline.
Consider the following example:\n
\n\n labelsTemplate: |\n {{ range .pci.device }}vendor-{{ .class }}-{{ .device }}.present=true\n {{ end }}\n matchFeatures:\n - feature: pci.device\n matchExpressions:\n class: {op: InRegexp, value: [\"^02\"]}\n vendor: [\"0fff\"]\nThe rule above will create individual labels\nfeature.node.kubernetes.io/vendor-<class-id>-<device-id>.present=true for\neach network controller device (device class starting with 02) from vendor\n0ffff.
All the matched features of each feature matcher term under matchFeatures\nfields are available for the template engine. Matched features can be\nreferenced with {{ .<feature-name> }} in the template, and\nthe available data could be described in yaml as follows:
.\n <key-feature>:\n - Name: <matched-key>\n - ...\n\n <value-feature>:\n - Name: <matched-key>\n Value: <matched-value>\n - ...\n\n <instance-feature>:\n - <attribute-1-name>: <attribute-1-value>\n <attribute-2-name>: <attribute-2-value>\n ...\n - ...\nThat is, the per-feature data is a list of objects whose data fields depend on\nthe type of the feature:
\n\nA simple example of a template utilizing name and value from an attribute\nfeature:\n
\n\n labelsTemplate: |\n {{ range .system.osrelease }}system-{{ .Name }}={{ .Value }}\n {{ end }}\n matchFeatures:\n - feature: system.osRelease\n matchExpressions:\n ID: {op: Exists}\n VERSION_ID.major: {op: Exists}\nNOTE In case of matchAny is specified, the template is executed separately\nagainst each individual matchFeatures field and the final set of labels will\nbe superset of all these separate template expansions. E.g. consider the\nfollowing:
- name: <name>\n labelsTemplate: <template>\n matchFeatures: <matcher#1>\n matchAny:\n - matchFeatures: <matcher#2>\n - matchFeatures: <matcher#3>\nIn the example above (assuming the overall result is a match) the template\nwould be executed on matcher#1 as well as on matcher#2 and/or matcher#3\n(depending on whether both or only one of them match). All the labels from\nthese separate expansions would be created, i.e. the end result would be a\nunion of all the individual expansions.
\n\nRule templates use the Golang text/template\npackage and all its built-in functionality (e.g. pipelines and functions) can\nbe used. An example template taking use of the built-in len function,\nadvertising the number of PCI network controllers from a specific vendor:\n
labelsTemplate: |\n num-intel-network-controllers={{ .pci.device | len }}\n matchFeatures:\n - feature: pci.device\n matchExpressions:\n vendor: {op: In, value: [\"8086\"]}\n class: {op: In, value: [\"0200\"]}\n\nImaginative template pipelines are possible, but care must be taken in order to\nproduce understandable and maintainable rule sets.
\n\nRules support referencing the output of preceding rules. This enables\nsophisticated scenarios where multiple rules are combined together\nto for more complex heuristics than a single rule can provide. The labels and\nvars created by the execution of preceding rules are available as a special\nrule.matched feature.
Consider the following configuration:
\n\n - name: \"my kernel label rule\"\n labels:\n kernel-feature: \"true\"\n matchFeatures:\n - feature: kernel.version\n matchExpressions:\n major: {op: Gt, value: [\"4\"]}\n\n - name: \"my var rule\"\n vars:\n nolabel-feature: \"true\"\n matchFeatures:\n - feature: cpu.cpuid\n matchExpressions:\n AVX512F: {op: Exists}\n - feature: pci.device\n matchExpressions:\n vendor: {op: In, value: [\"0fff\"]}\n device: {op: In, value: [\"1234\", \"1235\"]}\n\n - name: \"my high level feature rule\"\n labels:\n high-level-feature: \"true\"\n matchFeatures:\n - feature: rule.matched\n matchExpressions:\n kernel-feature: {op: IsTrue}\n nolabel-feature: {op: IsTrue}\nThe feature.node.kubernetes.io/high-level-feature = true label depends on thw\ntwo previous rules.
Note that when referencing rules across multiple\nNodeFeatureRule objects attention must be\npaid to the ordering. NodeFeatureRule objects are processed in alphabetical\norder (based on their .metadata.name).
Some more configuration examples below.
\n\nMatch certain CPUID features:
\n\n - name: \"example cpuid rule\"\n labels:\n my-special-cpu-feature: \"true\"\n matchFeatures:\n - feature: cpu.cpuid\n matchExpressions:\n AESNI: {op: Exists}\n AVX: {op: Exists}\nRequire a certain loaded kernel module and OS version:
\n\n - name: \"my multi-feature rule\"\n labels:\n my-special-multi-feature: \"true\"\n matchFeatures:\n - feature: kernel.loadedmodule\n matchExpressions:\n e1000: {op: Exists}\n - feature: system.osrelease\n matchExpressions:\n NAME: {op: InRegexp, values: [\"^openSUSE\"]}\n VERSION_ID.major: {op: Gt, values: [\"14\"]}\nRequire a loaded kernel module and two specific PCI devices (both of which\nmust be present):
\n\n - name: \"my multi-device rule\"\n labels:\n my-multi-device-feature: \"true\"\n matchFeatures:\n - feature: kernel.loadedmodule\n matchExpressions:\n my-driver-module: {op: Exists}\n - pci.device:\n vendor: \"0fff\"\n device: \"1234\"\n - pci.device:\n vendor: \"0fff\"\n device: \"abcd\"\nDEPRECATED: use the new rule syntax instead.
\n\nThe custom source supports the legacy matchOn rule syntax for\nbackwards-compatibility.
To aid in making the legacy rule syntax clearer, we define a general and a per\nrule nomenclature, keeping things as consistent as possible.
\n\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.\nRules are specified under sources.custom in the nfd-worker configuration\nfile.
sources:\n custom:\n - name: <feature name>\n value: <optional feature value, defaults to \"true\">\n matchOn:\n - <Rule-1>: <Rule-1 Input>\n [<Rule-2>: <Rule-2 Input>]\n - <Matcher-2>\n - ...\n - ...\n - <Matcher-N>\n - <custom feature 2>\n - ...\n - ...\n - <custom feature M>\nThe label is constructed by adding custom- prefix to the name field, label\nvalue defaults to true if not specified in the rule spec:
feature.node.kubernetes.io/custom-<name> = <value>\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\nAttribute :A PCI attribute.\nElement :An identifier of the PCI attribute.\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.
pciId :\n class: [<class id>, ...]\n vendor: [<vendor id>, ...]\n device: [<device id>, ...]\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\nAttribute :A USB attribute.\nElement :An identifier of the USB attribute.\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.
usbId :\n class: [<class id>, ...]\n vendor: [<vendor id>, ...]\n device: [<device id>, ...]\n serial: [<serial>, ...]\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\nElement :A kernel module\nThe LoadedKMod Rule allows matching the loaded kernel modules in the system\nagainst a provided list of Elements.
\n\nloadedKMod : [<kernel module>, ...]\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\nElement :A CPUID flag\nThe Rule allows matching the available CPUID flags in the system against a\nprovided list of Elements.
\n\ncpuId : [<CPUID flag string>, ...]\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\nElement :A Kconfig option\nThe Rule allows matching the kconfig options in the system against a provided\nlist of Elements.
\n\nkConfig: [<kernel config option ('y' or 'm') or '=<value>'>, ...]\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 =<value> in the kernel.
Element :A nodename regexp pattern\nThe Rule allows matching the node’s name against a provided list of Elements.
\n\nnodename: [ <nodename regexp pattern>, ... ]\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\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.*\" ]\nIn the example above:
\n\nfeature.node.kubernetes.io/custom-my.kernel.feature=true if the node has\nkmod1 AND kmod2 kernel modules loaded.feature.node.kubernetes.io/custom-my.pci.feature=true if the node contains\na PCI device with a PCI vendor ID of 15b3 AND PCI device ID of 1014 OR\n1017.feature.node.kubernetes.io/custom-my.usb.feature=true if the node contains\na USB device with a USB vendor ID of 1d6b AND USB device ID of 0003.feature.node.kubernetes.io/custom-my.combined.feature=true if\nvendor_kmod1 AND vendor_kmod2 kernel modules are loaded AND the node\ncontains a PCI device\nwith a PCI vendor ID of 15b3 AND PCI device ID of 1014 or 1017.vendor.feature.node.kubernetes.io/accumulated.feature=true if\nsome_kmod1 AND some_kmod2 kernel modules are loaded OR the node\ncontains a PCI device\nwith a PCI vendor ID of 15b3 AND PCI device ID of 1014 OR 1017.feature.node.kubernetes.io/custom-my.kernel.featureneedscpu=true if\nKVM_INTEL kernel config is enabled AND the node CPU supports VMX\nvirtual machine extensionsfeature.node.kubernetes.io/custom-my.kernel.modulecompiler=true if the\nin-tree kmod1 kernel module is loaded AND it’s built with\nGCC_VERSION=100101.profile.node.kubernetes.io/my-datacenter=datacenter-1 if the node’s name\nmatches the node-datacenter1-rack.*-server.* pattern, e.g.\nnode-datacenter1-rack2-server42This page contains usage examples and demos.
\n\n
A demo on the benefits of using node feature discovery can be found in the\nsource code repository under\ndemo/.
\n","dir":"/usage/","name":"examples-and-demos.md","path":"usage/examples-and-demos.md","url":"/usage/examples-and-demos.html"}] \ No newline at end of file diff --git a/master/deployment/helm.html b/master/deployment/helm.html index 0ce7a8344..53b4cbad7 100644 --- a/master/deployment/helm.html +++ b/master/deployment/helm.html @@ -1,4 +1,4 @@ -Node Feature Discovery Helm chart allow to easily deploy and manage NFD.
NOTE: NFD is not ideal for other Helm charts to depend on as that may result in multiple parallel NFD deployments in the same cluster which is not fully supported by the NFD Helm chart.
Helm package manager should be installed.
To install the latest stable version:
export NFD_NS=node-feature-discovery
+ Helm · Node Feature Discovery
Deployment with Helm
Table of contents
Node Feature Discovery Helm chart allow to easily deploy and manage NFD.
NOTE: NFD is not ideal for other Helm charts to depend on as that may result in multiple parallel NFD deployments in the same cluster which is not fully supported by the NFD Helm chart.
Prerequisites
Helm package manager should be installed.
Deployment
To install the latest stable version:
export NFD_NS=node-feature-discovery
helm repo add nfd https://kubernetes-sigs.github.io/node-feature-discovery/charts
helm repo update
helm install nfd/node-feature-discovery --namespace $NFD_NS --create-namespace --generate-name
@@ -13,4 +13,4 @@ helm install nfd/node-feature-discovery install nfd/node-feature-discovery --set nameOverride=NFDinstance --set master.replicaCount=2 --namespace $NFD_NS --create-namespace
Uninstalling the chart
To uninstall the node-feature-discovery deployment:
export NFD_NS=node-feature-discovery
helm uninstall node-feature-discovery --namespace $NFD_NS
-
The command removes all the Kubernetes components associated with the chart and deletes the release.
Chart parameters
In order to tailor the deployment of the Node Feature Discovery to your cluster needs We have introduced the following Chart parameters.
General parameters
Name Type Default description image.repositorystring gcr.io/k8s-staging-nfd/node-feature-discoveryNFD image repository image.tagstring masterNFD image tag image.pullPolicystring AlwaysImage pull policy imagePullSecretslist [] 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 nameOverridestring Override the name of the chart fullnameOverridestring Override a default fully qualified app name tls.enablebool false Specifies whether to use TLS for communications between components tls.certManagerbool false If enabled, requires cert-manager to be installed and will automatically create the required TLS certificates enableNodeFeatureApibool false Enable the NodeFeature CRD API for communicating node features. This will automatically disable the gRPC communication.
Master pod parameters
Name Type Default description master.*dict NFD master deployment configuration master.portinteger Specifies the TCP port that nfd-master listens for incoming requests. master.instancestring Instance name. Used to separate annotation namespaces for multiple parallel deployments master.extraLabelNsarray [] List of allowed extra label namespaces master.resourceLabelsarray [] List of labels to be registered as extended resources master.crdControllerbool null Specifies whether the NFD CRD API controller is enabled. If not set, controller will be enabled if master.instance is empty. master.featureRulesControllerbool null DEPRECATED: use master.crdController instead master.replicaCountinteger 1 Number of desired pods. This is a pointer to distinguish between explicit zero and not specified master.podSecurityContextdict {} PodSecurityContext holds pod-level security attributes and common container settings master.securityContextdict {} Container security settings master.serviceAccount.createbool true Specifies whether a service account should be created master.serviceAccount.annotationsdict {} Annotations to add to the service account master.serviceAccount.namestring The name of the service account to use. If not set and create is true, a name is generated using the fullname template master.rbac.createbool true Specifies whether to create RBAC configuration for nfd-master master.service.typestring ClusterIP NFD master service type master.service.portinteger 8080 NFD master service port master.resourcesdict {} NFD master pod resources management master.nodeSelectordict {} NFD master pod node selector master.tolerationsdict Scheduling to master node is disabled NFD master pod tolerations master.annotationsdict {} NFD master pod annotations master.affinitydict NFD master pod required node affinity master.deploymentAnnotationsdict {} NFD master deployment annotations
Worker pod parameters
Name Type Default description worker.*dict NFD worker daemonset configuration worker.configdict NFD worker configuration worker.podSecurityContextdict {} PodSecurityContext holds pod-level security attributes and common container settings worker.securityContextdict {} Container security settings worker.serviceAccount.createbool true Specifies whether a service account for nfd-worker should be created worker.serviceAccount.annotationsdict {} Annotations to add to the service account for nfd-worker worker.serviceAccount.namestring The name of the service account to use for nfd-worker. If not set and create is true, a name is generated using the fullname template (suffixed with -worker) worker.rbac.createbool true Specifies whether to create RBAC configuration for nfd-worker worker.mountUsrSrcbool false Specifies whether to allow users to mount the hostpath /user/src. Does not work on systems without /usr/src AND a read-only /usr worker.resourcesdict {} NFD worker pod resources management worker.nodeSelectordict {} NFD worker pod node selector worker.tolerationsdict {} NFD worker pod node tolerations worker.priorityClassNamestring NFD worker pod priority class worker.annotationsdict {} NFD worker pod annotations worker.daemonsetAnnotationsdict {} NFD worker daemonset annotations
Topology updater parameters
Name Type Default description topologyUpdater.*dict NFD Topology Updater configuration topologyUpdater.enablebool false Specifies whether the NFD Topology Updater should be created topologyUpdater.createCRDsbool false Specifies whether the NFD Topology Updater CRDs should be created topologyUpdater.serviceAccount.createbool true Specifies whether the service account for topology updater should be created topologyUpdater.serviceAccount.annotationsdict {} Annotations to add to the service account for topology updater topologyUpdater.serviceAccount.namestring 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 topologyUpdater.rbac.createbool false Specifies whether to create RBAC configuration for topology updater topologyUpdater.kubeletConfigPathstring "" Specifies the kubelet config host path topologyUpdater.kubeletPodResourcesSockPathstring "" Specifies the kubelet sock path to read pod resources topologyUpdater.updateIntervalstring 60s Time to sleep between CR updates. Non-positive value implies no CR update. topologyUpdater.watchNamespacestring *Namespace to watch pods, * for all namespaces topologyUpdater.podSecurityContextdict {} PodSecurityContext holds pod-level security attributes and common container settings topologyUpdater.securityContextdict {} Container security settings topologyUpdater.resourcesdict {} Topology updater pod resources management topologyUpdater.nodeSelectordict {} Topology updater pod node selector topologyUpdater.tolerationsdict {} Topology updater pod node tolerations topologyUpdater.annotationsdict {} Topology updater pod annotations topologyUpdater.affinitydict {} Topology updater pod affinity topologyUpdater.configdict configuration topologyUpdater.podSetFingerprintbool false Enables compute and report of pod fingerprint in NRT objects.
Topology garbage collector parameters
Name Type Default description topologyGC.*dict NFD Topology Garbage Collector configuration topologyGC.enablebool true Specifies whether the NFD Topology Garbage Collector should be created topologyGC.serviceAccount.createbool true Specifies whether the service account for topology garbage collector should be created topologyGC.serviceAccount.annotationsdict {} Annotations to add to the service account for topology garbage collector topologyGC.serviceAccount.namestring The name of the service account for topology garbage collector to use. If not set and create is true, a name is generated using the fullname template and -topology-gc suffix topologyGC.rbac.createbool false Specifies whether to create RBAC configuration for topology garbage collector topologyGC.intervalstring 1h Time between periodic garbage collector runs topologyGC.podSecurityContextdict {} PodSecurityContext holds pod-level security attributes and common container settings topologyGC.securityContextdict {} Container security settings topologyGC.resourcesdict {} Topology garbage collector pod resources management topologyGC.nodeSelectordict {} Topology garbage collector pod node selector topologyGC.tolerationsdict {} Topology garbage collector pod node tolerations topologyGC.annotationsdict {} Topology garbage collector pod annotations topologyGC.affinitydict {} Topology garbage collector pod affinity
Node Feature Discovery master
\ No newline at end of file
+The command removes all the Kubernetes components associated with the chart and deletes the release.
In order to tailor the deployment of the Node Feature Discovery to your cluster needs We have introduced the following Chart parameters.
| Name | Type | Default | description |
|---|---|---|---|
image.repository | string | gcr.io/k8s-staging-nfd/node-feature-discovery | NFD image repository |
image.tag | string | master | NFD image tag |
image.pullPolicy | string | Always | Image pull policy |
imagePullSecrets | list | [] | ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info |
nameOverride | string | Override the name of the chart | |
fullnameOverride | string | Override a default fully qualified app name | |
tls.enable | bool | false | Specifies whether to use TLS for communications between components |
tls.certManager | bool | false | If enabled, requires cert-manager to be installed and will automatically create the required TLS certificates |
enableNodeFeatureApi | bool | false | Enable the NodeFeature CRD API for communicating node features. This will automatically disable the gRPC communication. |
| Name | Type | Default | description |
|---|---|---|---|
master.* | dict | NFD master deployment configuration | |
master.port | integer | Specifies the TCP port that nfd-master listens for incoming requests. | |
master.instance | string | Instance name. Used to separate annotation namespaces for multiple parallel deployments | |
master.extraLabelNs | array | [] | List of allowed extra label namespaces |
master.resourceLabels | array | [] | List of labels to be registered as extended resources |
master.crdController | bool | null | Specifies whether the NFD CRD API controller is enabled. If not set, controller will be enabled if master.instance is empty. |
master.featureRulesController | bool | null | DEPRECATED: use master.crdController instead |
master.replicaCount | integer | 1 | Number of desired pods. This is a pointer to distinguish between explicit zero and not specified |
master.podSecurityContext | dict | {} | PodSecurityContext holds pod-level security attributes and common container settings |
master.securityContext | dict | {} | Container security settings |
master.serviceAccount.create | bool | true | Specifies whether a service account should be created |
master.serviceAccount.annotations | dict | {} | Annotations to add to the service account |
master.serviceAccount.name | string | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | |
master.rbac.create | bool | true | Specifies whether to create RBAC configuration for nfd-master |
master.service.type | string | ClusterIP | NFD master service type |
master.service.port | integer | 8080 | NFD master service port |
master.resources | dict | {} | NFD master pod resources management |
master.nodeSelector | dict | {} | NFD master pod node selector |
master.tolerations | dict | Scheduling to master node is disabled | NFD master pod tolerations |
master.annotations | dict | {} | NFD master pod annotations |
master.affinity | dict | NFD master pod required node affinity | |
master.deploymentAnnotations | dict | {} | NFD master deployment annotations |
| Name | Type | Default | description |
|---|---|---|---|
worker.* | dict | NFD worker daemonset configuration | |
worker.config | dict | NFD worker configuration | |
worker.podSecurityContext | dict | {} | PodSecurityContext holds pod-level security attributes and common container settings |
worker.securityContext | dict | {} | Container security settings |
worker.serviceAccount.create | bool | true | Specifies whether a service account for nfd-worker should be created |
worker.serviceAccount.annotations | dict | {} | Annotations to add to the service account for nfd-worker |
worker.serviceAccount.name | string | The name of the service account to use for nfd-worker. If not set and create is true, a name is generated using the fullname template (suffixed with -worker) | |
worker.rbac.create | bool | true | Specifies whether to create RBAC configuration for nfd-worker |
worker.mountUsrSrc | bool | false | Specifies whether to allow users to mount the hostpath /user/src. Does not work on systems without /usr/src AND a read-only /usr |
worker.resources | dict | {} | NFD worker pod resources management |
worker.nodeSelector | dict | {} | NFD worker pod node selector |
worker.tolerations | dict | {} | NFD worker pod node tolerations |
worker.priorityClassName | string | NFD worker pod priority class | |
worker.annotations | dict | {} | NFD worker pod annotations |
worker.daemonsetAnnotations | dict | {} | NFD worker daemonset annotations |
| Name | Type | Default | description |
|---|---|---|---|
topologyUpdater.* | dict | NFD Topology Updater configuration | |
topologyUpdater.enable | bool | false | Specifies whether the NFD Topology Updater should be created |
topologyUpdater.createCRDs | bool | false | Specifies whether the NFD Topology Updater CRDs should be created |
topologyUpdater.serviceAccount.create | bool | true | Specifies whether the service account for topology updater should be created |
topologyUpdater.serviceAccount.annotations | dict | {} | Annotations to add to the service account for topology updater |
topologyUpdater.serviceAccount.name | string | 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 | |
topologyUpdater.rbac.create | bool | false | Specifies whether to create RBAC configuration for topology updater |
topologyUpdater.kubeletConfigPath | string | "" | Specifies the kubelet config host path |
topologyUpdater.kubeletPodResourcesSockPath | string | "" | Specifies the kubelet sock path to read pod resources |
topologyUpdater.updateInterval | string | 60s | Time to sleep between CR updates. Non-positive value implies no CR update. |
topologyUpdater.watchNamespace | string | * | Namespace to watch pods, * for all namespaces |
topologyUpdater.podSecurityContext | dict | {} | PodSecurityContext holds pod-level security attributes and common container settings |
topologyUpdater.securityContext | dict | {} | Container security settings |
topologyUpdater.resources | dict | {} | Topology updater pod resources management |
topologyUpdater.nodeSelector | dict | {} | Topology updater pod node selector |
topologyUpdater.tolerations | dict | {} | Topology updater pod node tolerations |
topologyUpdater.annotations | dict | {} | Topology updater pod annotations |
topologyUpdater.affinity | dict | {} | Topology updater pod affinity |
topologyUpdater.config | dict | configuration | |
topologyUpdater.podSetFingerprint | bool | false | Enables compute and report of pod fingerprint in NRT objects. |
| Name | Type | Default | description |
|---|---|---|---|
topologyGC.* | dict | NFD Topology Garbage Collector configuration | |
topologyGC.enable | bool | true | Specifies whether the NFD Topology Garbage Collector should be created |
topologyGC.serviceAccount.create | bool | true | Specifies whether the service account for topology garbage collector should be created |
topologyGC.serviceAccount.annotations | dict | {} | Annotations to add to the service account for topology garbage collector |
topologyGC.serviceAccount.name | string | The name of the service account for topology garbage collector to use. If not set and create is true, a name is generated using the fullname template and -topology-gc suffix | |
topologyGC.rbac.create | bool | false | Specifies whether to create RBAC configuration for topology garbage collector |
topologyGC.interval | string | 1h | Time between periodic garbage collector runs |
topologyGC.podSecurityContext | dict | {} | PodSecurityContext holds pod-level security attributes and common container settings |
topologyGC.securityContext | dict | {} | Container security settings |
topologyGC.resources | dict | {} | Topology garbage collector pod resources management |
topologyGC.nodeSelector | dict | {} | Topology garbage collector pod node selector |
topologyGC.tolerations | dict | {} | Topology garbage collector pod node tolerations |
topologyGC.annotations | dict | {} | Topology garbage collector pod annotations |
topologyGC.affinity | dict | {} | Topology garbage collector pod affinity |
NFD currently offers two variants of the container image. The "minimal" variant is currently deployed by default. Released container images are available for x86_64 and Arm64 architectures.
This is a minimal image based on gcr.io/distroless/base and only supports running statically linked binaries.
For backwards compatibility a container image tag with suffix -minimal (e.g. gcr.io/k8s-staging-nfd/node-feature-discovery:master-minimal) is provided.
This image is based on debian:bullseye-slim and contains a full Linux system for running shell-based nfd-worker hooks and doing live debugging and diagnosis of the NFD images.
The container image tag has suffix -full (e.g. gcr.io/k8s-staging-nfd/node-feature-discovery:master-full).
NFD currently offers two variants of the container image. The "minimal" variant is currently deployed by default. Released container images are available for x86_64 and Arm64 architectures.
This is a minimal image based on gcr.io/distroless/base and only supports running statically linked binaries.
For backwards compatibility a container image tag with suffix -minimal (e.g. gcr.io/k8s-staging-nfd/node-feature-discovery:master-minimal) is provided.
This image is based on debian:bullseye-slim and contains a full Linux system for running shell-based nfd-worker hooks and doing live debugging and diagnosis of the NFD images.
The container image tag has suffix -full (e.g. gcr.io/k8s-staging-nfd/node-feature-discovery:master-full).
See Image variants for description of the different NFD container images available.
Using Kustomize provides straightforward deployment with kubectl integration and declarative customization.
Using Helm provides easy management of NFD deployments with nice configuration management and easy upgrades.
Using Operator provides deployment and configuration management via CRDs.
See Image variants for description of the different NFD container images available.
Using Kustomize provides straightforward deployment with kubectl integration and declarative customization.
Using Helm provides easy management of NFD deployments with nice configuration management and easy upgrades.
Using Operator provides deployment and configuration management via CRDs.
Kustomize provides easy deployment of NFD. Customization of the deployment is done by maintaining declarative overlays on top of the base overlays in NFD.
To follow the deployment instructions here, kubectl v1.21 or later is required.
The kustomize overlays provided in the repo can be used directly:
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref=master
+ Kustomize · Node Feature Discovery
Deploymenet with Kustomize
Table of contents
Kustomize provides easy deployment of NFD. Customization of the deployment is done by maintaining declarative overlays on top of the base overlays in NFD.
To follow the deployment instructions here, kubectl v1.21 or later is required.
The kustomize overlays provided in the repo can be used directly:
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref=master
This will required RBAC rules and deploy nfd-master (as a deployment) and nfd-worker (as daemonset) in the node-feature-discovery namespace.
NOTE: nfd-topology-updater is not deployed as part of the default overlay. Please refer to the Master Worker Topologyupdater and Topologyupdater below.
Alternatively you can clone the repository and customize the deployment by creating your own overlays. For example, to deploy the minimal image. See kustomize for more information about managing deployment configurations.
Overlays
The NFD repository hosts a set of overlays for different usages and deployment scenarios under deployment/overlays
default: default deployment of nfd-worker as a daemonset, described abovedefault-combined see Master-worker pod belowdefault-job: see Worker one-shot belowmaster-worker-topologyupdater: see Master Worker Topologyupdater belowtopologyupdater: see Topology Updater belowprune: clean up the cluster after uninstallation, see Removing feature labelssamples/cert-manager: an example for supplementing the default deployment with cert-manager for TLS authentication, see Automated TLS certificate management using cert-manager for detailssamples/custom-rules: an example for spicing up the default deployment with a separately managed configmap of custom labeling rules, see Custom feature source for more information about custom node labels
Master-worker pod
You can also run nfd-master and nfd-worker inside the same pod
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default-combined?ref=master
This creates a DaemonSet that runs nfd-worker and nfd-master in the same Pod. In this case no nfd-master is run on the master node(s), but, the worker nodes are able to label themselves which may be desirable e.g. in single-node setups.
NOTE: nfd-topology-updater is not deployed by the default-combined overlay. To enable nfd-topology-updater in this scenario,the users must customize the deployment themselves.
Worker one-shot
Feature discovery can alternatively be configured as a one-shot job. The default-job overlay may be used to achieve this:
NUM_NODES=$(kubectl get no -o jsonpath='{.items[*].metadata.name}' | wc -w)
@@ -21,4 +21,4 @@ kubectl -n $NFD_NS delete svc nf
kubectl -n $NFD_NS delete sa nfd-master
kubectl delete clusterrole nfd-master
kubectl delete clusterrolebinding nfd-master
-
Node Feature Discovery master
\ No newline at end of file
+The Node Feature Discovery Operator automates installation, configuration and updates of NFD using a specific NodeFeatureDiscovery custom resource. This also provides good support for managing NFD as a dependency of other operators.
Deployment using the Node Feature Discovery Operator is recommended to be done via operatorhub.io.
Install the operator:
kubectl create -f https://operatorhub.io/install/nfd-operator.yaml
+ NFD Operator · Node Feature Discovery
Deployment with NFD Operator
Table of contents
The Node Feature Discovery Operator automates installation, configuration and updates of NFD using a specific NodeFeatureDiscovery custom resource. This also provides good support for managing NFD as a dependency of other operators.
Deployment
Deployment using the Node Feature Discovery Operator is recommended to be done via operatorhub.io.
- You need to have OLM installed. If you don't, take a look at the latest release for detailed instructions.
-
Install the operator:
kubectl create -f https://operatorhub.io/install/nfd-operator.yaml
-
Create NodeFeatureDiscovery object (in nfd namespace here):
cat << EOF | kubectl apply -f -
apiVersion: v1
kind: Namespace
@@ -18,4 +18,4 @@ spec:
In order to deploy the minimal image you need to use
image: gcr.io/k8s-staging-nfd/node-feature-discovery:master-minimal
in the NodeFeatureDiscovery object above.
Uninstallation
If you followed the deployment instructions above you can simply do:
kubectl -n nfd delete NodeFeatureDiscovery my-nfd-deployment
Optionally, you can also remove the namespace:
kubectl delete ns nfd
-
See the node-feature-discovery-operator and OLM project documentation for instructions for uninstalling the operator and operator lifecycle manager, respectively.
Node Feature Discovery master
\ No newline at end of file
+See the node-feature-discovery-operator and OLM project documentation for instructions for uninstalling the operator and operator lifecycle manager, respectively.
NFD supports mutual TLS authentication between the nfd-master and nfd-worker instances. That is, nfd-worker and nfd-master both verify that the other end presents a valid certificate.
TLS authentication is enabled by specifying -ca-file, -key-file and -cert-file args, on both the nfd-master and nfd-worker instances. The template specs provided with NFD contain (commented out) example configuration for enabling TLS authentication.
The Common Name (CN) of the nfd-master certificate must match the DNS name of the nfd-master Service of the cluster. By default, nfd-master only check that the nfd-worker has been signed by the specified root certificate (-ca-file).
Additional hardening can be enabled by specifying -verify-node-name in nfd-master args, in which case nfd-master verifies that the NodeName presented by nfd-worker matches the Common Name (CN) or a Subject Alternative Name (SAN) of its certificate. Note that -verify-node-name complicates certificate management and is not yet supported in the helm or kustomize deployment methods.
cert-manager can be used to automate certificate management between nfd-master and the nfd-worker pods.
The NFD source code repository contains an example kustomize overlay and helm chart that can be used to deploy NFD with cert-manager supplied certificates enabled.
To install cert-manager itself can be done as easily as this, below, or you can refer to their documentation for other installation methods such as the helm chart they provide.
kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.6.1/cert-manager.yaml
+ TLS authentication · Node Feature Discovery
Communication security with TLS
Table of contents
NFD supports mutual TLS authentication between the nfd-master and nfd-worker instances. That is, nfd-worker and nfd-master both verify that the other end presents a valid certificate.
TLS authentication is enabled by specifying -ca-file, -key-file and -cert-file args, on both the nfd-master and nfd-worker instances. The template specs provided with NFD contain (commented out) example configuration for enabling TLS authentication.
The Common Name (CN) of the nfd-master certificate must match the DNS name of the nfd-master Service of the cluster. By default, nfd-master only check that the nfd-worker has been signed by the specified root certificate (-ca-file).
Additional hardening can be enabled by specifying -verify-node-name in nfd-master args, in which case nfd-master verifies that the NodeName presented by nfd-worker matches the Common Name (CN) or a Subject Alternative Name (SAN) of its certificate. Note that -verify-node-name complicates certificate management and is not yet supported in the helm or kustomize deployment methods.
Automated TLS certificate management using cert-manager
cert-manager can be used to automate certificate management between nfd-master and the nfd-worker pods.
The NFD source code repository contains an example kustomize overlay and helm chart that can be used to deploy NFD with cert-manager supplied certificates enabled.
To install cert-manager itself can be done as easily as this, below, or you can refer to their documentation for other installation methods such as the helm chart they provide.
kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.6.1/cert-manager.yaml
To use the kustomize overlay to install node-feature-discovery with TLS enabled, you may use the following:
kubectl apply -k deployment/overlays/samples/cert-manager
To make use of the helm chart, override values.yaml to enable both the tls.enabled and tls.certManager options. Note that if you do not enable tls.certManager, helm will successfully install the application, but deployment will wait until certificates are manually created, as demonstrated below.
See the sample installation commands in the Helm Deployment and Configuration sections above for how to either override individual values, or provide a yaml file with which to override default values.
Manual TLS certificate management
If you do not with to make use of cert-manager, the certificates can be manually created and stored as secrets within the NFD namespace.
Create a CA certificate
openssl req -x509 -newkey rsa:4096 -keyout ca.key -nodes \
-subj "/CN=nfd-ca" -days 10000 -out ca.crt
@@ -78,4 +78,4 @@ data:
EOF
done
-
Node Feature Discovery master
\ No newline at end of file
+Follow the uninstallation instructions of the deployment method used (kustomize, helm or operator).
NFD-Master has a special -prune command line flag for removing all nfd-related node labels, annotations and extended resources from the cluster.
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prune?ref=master
+ Uninstallation · Node Feature Discovery
Uninstallation
Table of contents
Follow the uninstallation instructions of the deployment method used (kustomize, helm or operator).
Removing feature labels
NFD-Master has a special -prune command line flag for removing all nfd-related node labels, annotations and extended resources from the cluster.
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prune?ref=master
kubectl -n node-feature-discovery wait job.batch/nfd-master --for=condition=complete && \
kubectl delete -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prune?ref=master
-
NOTE: You must run prune before removing the RBAC rules (serviceaccount, clusterrole and clusterrolebinding).
Node Feature Discovery master
\ No newline at end of file
+NOTE: You must run prune before removing the RBAC rules (serviceaccount, clusterrole and clusterrolebinding).
git clone https://github.com/kubernetes-sigs/node-feature-discovery
+ Developer guide · Node Feature Discovery
Developer guide
Table of contents
Building from source
Download the source code
git clone https://github.com/kubernetes-sigs/node-feature-discovery
cd node-feature-discovery
Docker build
Build the container image
See customizing the build below for altering the container image registry, for example.
make
Push the container image
Optional, this example with Docker.
docker push <IMAGE_TAG>
@@ -27,4 +27,4 @@ kubectl apply -k .
tilt up
This will override the default value(master) of IMAGE_TAG_NAME variable defined in the Tiltfile.
Documentation
All documentation resides under the docs directory in the source tree. It is designed to be served as a html site by GitHub Pages.
Building the documentation is containerized in order to fix the build environment. The recommended way for developing documentation is to run:
make site-serve
This will build the documentation in a container and serve it under localhost:4000/ making it easy to verify the results. Any changes made to the docs/ will automatically re-trigger a rebuild and are reflected in the served content and can be inspected with a simple browser refresh.
In order to just build the html documentation run:
make site-build
-
This will generate html documentation under docs/_site/.
Node Feature Discovery master
\ No newline at end of file
+This will generate html documentation under docs/_site/.
Welcome to Node Feature Discovery – a Kubernetes add-on for detecting hardware features and system configuration!
Continue to:
Introduction for more details on the project.
Quick start for quick step-by-step instructions on how to get NFD running on your cluster.
$ 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:
-
Introduction for more details on the project.
-
Quick start for quick step-by-step instructions on how to get NFD running on your cluster.
Quick-start – the short-short version
$ kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref=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",
...
-
Node Feature Discovery master
\ No newline at end of file
+This software enables node feature discovery for Kubernetes. It detects hardware features available on each node in a Kubernetes cluster, and advertises those features using node labels and optionally node taints.
NFD consists of four software components:
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 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 is a daemon responsible for examining allocated resources on a worker node to account for resources available to be allocated to new pod on a per-zone basis (where a zone can be a NUMA node). It then creates or updates a NodeResourceTopology custom resource object specific to this node. One instance of nfd-topology-updater is supposed to be running on each node of the cluster.
NFD-Topology-GC is a daemon responsible for cleaning obsolete NodeResourceTopology objects, obsolete means that there is no corresponding worker node.
One instance of nfd-topology-gc is supposed to be running in the cluster.
Feature discovery is divided into domain-specific feature sources:
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
- NFD-Topology-GC
- Feature Discovery
- Node annotations
- Custom resources
This software enables node feature discovery for Kubernetes. It detects hardware features available on each node in a Kubernetes cluster, and advertises those features using node labels and optionally node taints.
NFD consists of four software components:
- nfd-master
- nfd-worker
- nfd-topology-updater
- nfd-topology-gc
NFD-Master
NFD-Master is the daemon responsible for communication towards the Kubernetes API. That is, it receives labeling requests from the worker and modifies node objects accordingly.
NFD-Worker
NFD-Worker is a daemon responsible for feature detection. It then communicates the information to nfd-master which does the actual node labeling. One instance of nfd-worker is supposed to be running on each node of the cluster,
NFD-Topology-Updater
NFD-Topology-Updater is a daemon responsible for examining allocated resources on a worker node to account for resources available to be allocated to new pod on a per-zone basis (where a zone can be a NUMA node). It then creates or updates a NodeResourceTopology custom resource object specific to this node. One instance of nfd-topology-updater is supposed to be running on each node of the cluster.
NFD-Topology-GC
NFD-Topology-GC is a daemon responsible for cleaning obsolete NodeResourceTopology objects, obsolete means that there is no corresponding worker node.
One instance of nfd-topology-gc is supposed to be running in the cluster.
Feature Discovery
Feature discovery is divided into domain-specific feature sources:
- CPU
- Kernel
- Memory
- Network
- PCI
- Storage
- System
- USB
- Custom (rule-based custom features)
- Local (hooks for user-specific features)
Each feature source is responsible for detecting a set of features which. in turn, are turned into node feature labels. Feature labels are prefixed with feature.node.kubernetes.io/ and also contain the name of the feature source. Non-standard user-specific feature labels can be created with the local and custom feature sources.
An overview of the default feature labels:
{
"feature.node.kubernetes.io/cpu-<feature-name>": "true",
"feature.node.kubernetes.io/custom-<feature-name>": "true",
"feature.node.kubernetes.io/kernel-<feature name>": "<feature value>",
@@ -10,4 +10,4 @@
"feature.node.kubernetes.io/usb-<device label>.present": "<feature value>",
"feature.node.kubernetes.io/<file name>-<feature name>": "<feature value>"
}
-
Node annotations
NFD also annotates nodes it is running on:
Annotation Description [<instance>.]nfd.node.kubernetes.io/master.version Version of the nfd-master instance running on the node. Informative use only. [<instance>.]nfd.node.kubernetes.io/worker.version Version of the nfd-worker instance running on the node. Informative use only. [<instance>.]nfd.node.kubernetes.io/feature-labels Comma-separated list of node labels managed by NFD. NFD uses this internally so must not be edited by users. [<instance>.]nfd.node.kubernetes.io/extended-resources Comma-separated list of node extended resources managed by NFD. NFD uses this internally so must not be edited by users.
NOTE: the -instance command line flag affects the annotation names
Unapplicable annotations are not created, i.e. for example master.version is only created on nodes running nfd-master.
Custom resources
NFD takes use of some Kubernetes Custom Resources.
NodeFeatures (EXPERIMENTAL) can be used for representing node features and requesting node labels to be generated.
NFD-Master uses NodeFeatureRules for custom labeling of nodes.
NFD-Topology-Updater creates NodeResourceTopology objects that describe the hardware topology of node resources.
Node Feature Discovery master
\ No newline at end of file
+NFD also annotates nodes it is running on:
| Annotation | Description |
|---|---|
| [<instance>.]nfd.node.kubernetes.io/master.version | Version of the nfd-master instance running on the node. Informative use only. |
| [<instance>.]nfd.node.kubernetes.io/worker.version | Version of the nfd-worker instance running on the node. Informative use only. |
| [<instance>.]nfd.node.kubernetes.io/feature-labels | Comma-separated list of node labels managed by NFD. NFD uses this internally so must not be edited by users. |
| [<instance>.]nfd.node.kubernetes.io/extended-resources | Comma-separated list of node extended resources managed by NFD. NFD uses this internally so must not be edited by users. |
NOTE: the -instance command line flag affects the annotation names
Unapplicable annotations are not created, i.e. for example master.version is only created on nodes running nfd-master.
NFD takes use of some Kubernetes Custom Resources.
NodeFeatures (EXPERIMENTAL) can be used for representing node features and requesting node labels to be generated.
NFD-Master uses NodeFeatureRules for custom labeling of nodes.
NFD-Topology-Updater creates NodeResourceTopology objects that describe the hardware topology of node resources.
Minimal steps to deploy latest released version of NFD in your cluster.
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
@@ -40,4 +40,4 @@ daemonset.apps/nfd-topology-updater 2 2 2 2 2
NAME AGE
kind-control-plane 23s
kind-worker 23s
-
Node Feature Discovery master
\ No newline at end of file
+Command line and configuration reference.
Command line and configuration reference.
To quickly view available command line flags execute nfd-master -help. In a docker container:
docker run gcr.io/k8s-staging-nfd/node-feature-discovery:master nfd-master -help
+ Master cmdline reference · Node Feature Discovery
Commandline flags of nfd-master
Table of contents
- -h, -help
- -version
- -prune
- -port
- -instance
- -ca-file
- -cert-file
- -key-file
- -verify-node-name
- -enable-nodefeature-api
- -enable-taints
- -no-publish
- -crd-controller
- -featurerules-controller
- -label-whitelist
- -extra-label-ns
- -deny-label-ns
- -resource-labels
- Logging
To quickly view available command line flags execute nfd-master -help. In a docker container:
docker run gcr.io/k8s-staging-nfd/node-feature-discovery:master nfd-master -help
-h, -help
Print usage and exit.
-version
Print version and exit.
-prune
The -prune flag is a sub-command like option for cleaning up the cluster. It causes nfd-master to remove all NFD related labels, annotations and extended resources from all Node objects of the cluster and exit.
-port
The -port flag specifies the TCP port that nfd-master listens for incoming requests.
Default: 8080
Example:
nfd-master -port=443
-instance
The -instance flag makes it possible to run multiple NFD deployments in parallel. In practice, it separates the node annotations between deployments so that each of them can store metadata independently. The instance name must start and end with an alphanumeric character and may only contain alphanumeric characters, -, _ or ..
Default: empty
Example:
nfd-master -instance=network
-ca-file
The -ca-file is one of the three flags (together with -cert-file and -key-file) controlling master-worker mutual TLS authentication on the nfd-master side. This flag specifies the TLS root certificate that is used for authenticating incoming connections. NFD-Worker side needs to have matching key and cert files configured in order for the incoming requests to be accepted.
Default: empty
Note: Must be specified together with -cert-file and -key-file
Example:
nfd-master -ca-file=/opt/nfd/ca.crt -cert-file=/opt/nfd/master.crt -key-file=/opt/nfd/master.key
@@ -14,4 +14,4 @@
-extra-label-ns
The -extra-label-ns flag specifies a comma-separated list of allowed feature label namespaces. This option can be used to allow other vendor or application specific namespaces for custom labels from the local and custom feature sources, even though these labels were denied using the deny-label-ns flag.
The same namespace control and this flag applies Extended Resources (created with -resource-labels), too.
Default: empty
Example:
nfd-master -extra-label-ns=vendor-1.com,vendor-2.io
-deny-label-ns
The -deny-label-ns flag specifies a comma-separated list of excluded label namespaces. By default, nfd-master allows creating labels in all namespaces, excluding kubernetes.io namespace and its sub-namespaces (i.e. *.kubernetes.io). However, you should note that kubernetes.io and its sub-namespaces are always denied. For example, nfd-master -deny-label-ns="" would still disallow kubernetes.io and *.kubernetes.io. This option can be used to exclude some vendors or application specific namespaces. Note that the namespaces feature.node.kubernetes.io and profile.node.kubernetes.io and their sub-namespaces are always allowed and cannot be denied.
Default: empty
Example:
nfd-master -deny-label-ns=*.vendor.com,vendor-2.io
-resource-labels
The -resource-labels flag specifies a comma-separated list of features to be advertised as extended resources instead of labels. Features that have integer values can be published as Extended Resources by listing them in this flag.
Default: empty
Example:
nfd-master -resource-labels=vendor-1.com/feature-1,vendor-2.io/feature-2
-
Logging
The following logging-related flags are inherited from the klog package.
-add_dir_header
If true, adds the file directory to the header of the log messages.
Default: false
-alsologtostderr
Log to standard error as well as files.
Default: false
-log_backtrace_at
When logging hits line file:N, emit a stack trace.
Default: empty
-log_dir
If non-empty, write log files in this directory.
Default: empty
-log_file
If non-empty, use this log file.
Default: empty
-log_file_max_size
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
-logtostderr
Log to standard error instead of files
Default: true
-skip_headers
If true, avoid header prefixes in the log messages.
Default: false
-skip_log_headers
If true, avoid headers when opening log files.
Default: false
-stderrthreshold
Logs at or above this threshold go to stderr.
Default: 2
-v
Number for the log level verbosity.
Default: 0
-vmodule
Comma-separated list of pattern=N settings for file-filtered logging.
Default: empty
Node Feature Discovery master
\ No newline at end of file
+The following logging-related flags are inherited from the klog package.
If true, adds the file directory to the header of the log messages.
Default: false
Log to standard error as well as files.
Default: false
When logging hits line file:N, emit a stack trace.
Default: empty
If non-empty, write log files in this directory.
Default: empty
If non-empty, use this log file.
Default: empty
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
Log to standard error instead of files
Default: true
If true, avoid header prefixes in the log messages.
Default: false
If true, avoid headers when opening log files.
Default: false
Logs at or above this threshold go to stderr.
Default: 2
Number for the log level verbosity.
Default: 0
Comma-separated list of pattern=N settings for file-filtered logging.
Default: empty
To quickly view available command line flags execute nfd-topology-gc -help. In a docker container:
docker run gcr.io/k8s-staging-nfd/node-feature-discovery:master \
+ Topology Garbage Collector Cmdline Reference · Node Feature Discovery
NFD-Topology-Garbage-Collector Commandline Flags
Table of Contents
To quickly view available command line flags execute nfd-topology-gc -help. In a docker container:
docker run gcr.io/k8s-staging-nfd/node-feature-discovery:master \
nfd-topology-gc -help
-h, -help
Print usage and exit.
-version
Print version and exit.
-gc-interval
The -gc-interval specifies the interval between periodic garbage collector runs.
Default: 1h
Example:
nfd-topology-gc -gc-interval=1h
-
Node Feature Discovery master
\ No newline at end of file
+To quickly view available command line flags execute nfd-topology-updater -help. In a docker container:
docker run gcr.io/k8s-staging-nfd/node-feature-discovery:master \
+ Topology Updater Cmdline Reference · Node Feature Discovery
NFD-Topology-Updater Commandline Flags
Table of Contents
To quickly view available command line flags execute nfd-topology-updater -help. In a docker container:
docker run gcr.io/k8s-staging-nfd/node-feature-discovery:master \
nfd-topology-updater -help
-h, -help
Print usage and exit.
-version
Print version and exit.
-config
The -config flag specifies the path of the nfd-topology-updater configuration file to use.
Default: /etc/kubernetes/node-feature-discovery/nfd-topology-updater.conf
Example:
nfd-topology-updater -config=/opt/nfd/nfd-topology-updater.conf
-no-publish
The -no-publish flag disables all communication with the nfd-master, making it a "dry-run" flag for nfd-topology-updater. NFD-Topology-Updater runs resource hardware topology detection normally, but no CR requests are sent to nfd-master.
Default: false
Example:
nfd-topology-updater -no-publish
@@ -9,4 +9,4 @@ nfd-topology-updater -help
-api-auth-token-file
The -api-auth-token-file specifies the path to the api auth token file which is used to retrieve Kubelet's configuration from Kubelet secure port, only taking effect when -kubelet-config-uri is https. Note that this token file must bind to a role that has the get capability to nodes/proxy resources.
Default: /var/run/secrets/kubernetes.io/serviceaccount/token
Example:
nfd-topology-updater -token-file=/var/run/secrets/kubernetes.io/serviceaccount/token
-podresources-socket
The -podresources-socket specifies the path to the Unix socket where kubelet exports a gRPC service to enable discovery of in-use CPUs and devices, and to provide metadata for them.
Default: /host-var/lib/kubelet/pod-resources/kubelet.sock
Example:
nfd-topology-updater -podresources-socket=/var/lib/kubelet/pod-resources/kubelet.sock
-pods-fingerprint
Enbles the compute and report the pod set fingerprint in the NRT. A pod fingerprint is a compact representation of the "node state" regarding resources.
Default: false
Example:
nfd-topology-updater -pods-fingerprint
-
Node Feature Discovery master
\ No newline at end of file
+See the sample configuration file for a full example configuration.
The excludeList specifies a key-value map of allocated resources that should not be examined by the topology-updater agent per node. Each key is a node name with a value as a list of resources that should not be examined by the agent for that specific node.
Default: empty
Example:
excludeList:
+ Topology-Updater config reference · Node Feature Discovery
Configuration file reference of nfd-topology-updater
Table of contents
See the sample configuration file for a full example configuration.
excludeList
The excludeList specifies a key-value map of allocated resources that should not be examined by the topology-updater agent per node. Each key is a node name with a value as a list of resources that should not be examined by the agent for that specific node.
Default: empty
Example:
excludeList:
nodeA: [hugepages-2Mi]
nodeB: [memory]
nodeC: [cpu, hugepages-2Mi]
excludeList.*
excludeList.* is a special value that use to specify all nodes. A resource that would be listed under this key, would be excluded from all nodes.
Default: empty
Example:
excludeList:
'*': [hugepages-2Mi]
-
Node Feature Discovery master
\ No newline at end of file
+To quickly view available command line flags execute nfd-worker -help. In a docker container:
docker run gcr.io/k8s-staging-nfd/node-feature-discovery:master nfd-worker -help
+ Worker cmdline reference · Node Feature Discovery
Commandline flags of nfd-worker
Table of contents
- -h, -help
- -version
- -config
- -options
- -server
- -ca-file
- -cert-file
- -key-file
- -kubeconfig
- -server-name-override
- -feature-sources
- -label-sources
- -enable-nodefeature-api
- -no-publish
- -oneshot
- Logging
To quickly view available command line flags execute nfd-worker -help. In a docker container:
docker run gcr.io/k8s-staging-nfd/node-feature-discovery:master nfd-worker -help
-h, -help
Print usage and exit.
-version
Print version and exit.
-config
The -config flag specifies the path of the nfd-worker configuration file to use.
Default: /etc/kubernetes/node-feature-discovery/nfd-worker.conf
Example:
nfd-worker -config=/opt/nfd/worker.conf
-options
The -options flag may be used to specify and override configuration file options directly from the command line. The required format is the same as in the config file i.e. JSON or YAML. Configuration options specified via this flag will override those from the configuration file:
Default: empty
Example:
nfd-worker -options='{"sources":{"cpu":{"cpuid":{"attributeWhitelist":["AVX","AVX2"]}}}}'
-server
The -server flag specifies the address of the nfd-master endpoint where to connect to.
Default: localhost:8080
Example:
nfd-worker -server=nfd-master.nfd.svc.cluster.local:443
@@ -12,4 +12,4 @@
-enable-nodefeature-api
The -enable-nodefeature-api flag enables the experimental NodeFeature CRD API for communicating with nfd-master. This will also automatically disable the gRPC communication to nfd-master. When enabled, nfd-worker will create per-node NodeFeature objects the contain all discovered node features and the set of feature labels to be created.
Default: false
Example:
nfd-worker -enable-nodefeature-api
-no-publish
The -no-publish flag disables all communication with the nfd-master and the Kubernetes API server. It is effectively a "dry-run" flag for nfd-worker. NFD-Worker runs feature detection normally, but no labeling requests are sent to nfd-master and no NodeFeature objects are created or updated in the API server.
Note: This flag takes precedence over the core.noPublish configuration file option.
Default: false
Example:
nfd-worker -no-publish
-oneshot
The -oneshot flag causes nfd-worker to exit after one pass of feature detection.
Default: false
Example:
nfd-worker -oneshot -no-publish
-
Logging
The following logging-related flags are inherited from the klog package.
Note: The logger setup can also be specified via the core.klog configuration file options. However, the command line flags take precedence over any corresponding config file options specified.
-add_dir_header
If true, adds the file directory to the header of the log messages.
Default: false
-alsologtostderr
Log to standard error as well as files.
Default: false
-log_backtrace_at
When logging hits line file:N, emit a stack trace.
Default: empty
-log_dir
If non-empty, write log files in this directory.
Default: empty
-log_file
If non-empty, use this log file.
Default: empty
-log_file_max_size
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
-logtostderr
Log to standard error instead of files
Default: true
-skip_headers
If true, avoid header prefixes in the log messages.
Default: false
-skip_log_headers
If true, avoid headers when opening log files.
Default: false
-stderrthreshold
Logs at or above this threshold go to stderr.
Default: 2
-v
Number for the log level verbosity.
Default: 0
-vmodule
Comma-separated list of pattern=N settings for file-filtered logging.
Default: empty
Node Feature Discovery master
\ No newline at end of file
+The following logging-related flags are inherited from the klog package.
Note: The logger setup can also be specified via the core.klog configuration file options. However, the command line flags take precedence over any corresponding config file options specified.
If true, adds the file directory to the header of the log messages.
Default: false
Log to standard error as well as files.
Default: false
When logging hits line file:N, emit a stack trace.
Default: empty
If non-empty, write log files in this directory.
Default: empty
If non-empty, use this log file.
Default: empty
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
Log to standard error instead of files
Default: true
If true, avoid header prefixes in the log messages.
Default: false
If true, avoid headers when opening log files.
Default: false
Logs at or above this threshold go to stderr.
Default: 2
Number for the log level verbosity.
Default: 0
Comma-separated list of pattern=N settings for file-filtered logging.
Default: empty
See the sample configuration file for a full example configuration.
The core section contains common configuration settings that are not specific to any particular feature source.
core.sleepInterval specifies the interval between consecutive passes of feature (re-)detection, and thus also the interval between node re-labeling. A non-positive value implies infinite sleep interval, i.e. no re-detection or re-labeling is done.
Default: 60s
Example:
core:
+ Worker config reference · Node Feature Discovery
Configuration file reference of nfd-worker
Table of contents
See the sample configuration file for a full example configuration.
core
The core section contains common configuration settings that are not specific to any particular feature source.
core.sleepInterval
core.sleepInterval specifies the interval between consecutive passes of feature (re-)detection, and thus also the interval between node re-labeling. A non-positive value implies infinite sleep interval, i.e. no re-detection or re-labeling is done.
Default: 60s
Example:
core:
sleepInterval: 60s
core.featureSources
core.featureSources specifies the list of enabled feature sources. A special value all enables all sources. Prefixing a source name with - indicates that the source will be disabled instead - this is only meaningful when used in conjunction with all. This option allows completely disabling the feature detection so that neither standard feature labels are generated nor the raw feature data is available for custom rule processing.
Default: [all]
Example:
core:
# Enable all but cpu and local sources
@@ -68,4 +68,4 @@
matchExpressions:
class: {op: In, value: ["0200"]}
vendor: {op: In, value: ["8086"]}
-
Node Feature Discovery master
\ No newline at end of file
+NFD uses some Kubernetes custom resources.
EXPERIMENTAL NodeFeature is an NFD-specific custom resource for communicating node features and node labeling requests. Support for NodeFeature objects is disabled by default. If enabled, nfd-master watches for NodeFeature objects, labels nodes as specified and uses the listed features as input when evaluating NodeFeatureRules. NodeFeature objects can be used for implementing 3rd party extensions (see customization guide for more details).
apiVersion: nfd.k8s-sigs.io/v1alpha1
+ CRDs · Node Feature Discovery
Custom Resources
Table of contents
NFD uses some Kubernetes custom resources.
NodeFeature
EXPERIMENTAL NodeFeature is an NFD-specific custom resource for communicating node features and node labeling requests. Support for NodeFeature objects is disabled by default. If enabled, nfd-master watches for NodeFeature objects, labels nodes as specified and uses the listed features as input when evaluating NodeFeatureRules. NodeFeature objects can be used for implementing 3rd party extensions (see customization guide for more details).
apiVersion: nfd.k8s-sigs.io/v1alpha1
kind: NodeFeature
metadata:
labels:
@@ -77,4 +77,4 @@
capacity: 3
allocatable: 3
available: 3
-
The NodeResourceTopology objects created by NFD 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.
Node Feature Discovery master
\ No newline at end of file
+The NodeResourceTopology objects created by NFD 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.
NFD provides multiple extension points for vendor and application specific labeling:
NodeFeature (EXPERIMENTAL) objects can be used to communicate "raw" node features and node labeling requests to nfd-master.NodeFeatureRule objects provide a way to deploy custom labeling rules via the Kubernetes APIlocal feature source of nfd-worker creates labels by executing hooks and reading filescustom feature source of nfd-worker creates labels based on user-specified rulesEXPERIMENTAL NodeFeature objects provide a way for 3rd party extensions to advertise custom features, both as "raw" features that serve as input to NodeFeatureRule objects and as feature labels directly.
Note that RBAC rules must be created for each extension for them to be able to create and manipulate NodeFeature objects in their namespace.
Support for NodeFeature CRD API is enabled with the -enable-nodefeature-api command line flag. This flag must be specified for both nfd-master and nfd-worker as it will disable the gRPC communication between them.
Consider the following referential example:
apiVersion: nfd.k8s-sigs.io/v1alpha1
+ Customization guide · Node Feature Discovery
Customization guide
Table of contents
- Overview
- NodeFeature custom resource
- NodeFeatureRule custom resource
- Local feature source
- Custom feature source
- Node labels
- Label rule format
- Legacy custom rule syntax
Overview
NFD provides multiple extension points for vendor and application specific labeling:
NodeFeature (EXPERIMENTAL) objects can be used to communicate "raw" node features and node labeling requests to nfd-master.NodeFeatureRule objects provide a way to deploy custom labeling rules via the Kubernetes API.local feature source of nfd-worker creates labels by executing hooks and reading files.custom feature source of nfd-worker creates labels based on user-specified rules.
NodeFeature custom resource
EXPERIMENTAL NodeFeature objects provide a way for 3rd party extensions to advertise custom features, both as "raw" features that serve as input to NodeFeatureRule objects and as feature labels directly.
Note that RBAC rules must be created for each extension for them to be able to create and manipulate NodeFeature objects in their namespace.
Support for NodeFeature CRD API is enabled with the -enable-nodefeature-api command line flag. This flag must be specified for both nfd-master and nfd-worker as it will disable the gRPC communication between them.
A NodeFeature example
Consider the following referential example:
apiVersion: nfd.k8s-sigs.io/v1alpha1
kind: NodeFeature
metadata:
labels:
@@ -29,7 +29,7 @@
# Labels to be created
labels:
vendor-feature.enabled: "true"
-
The object targets node named node-1. It lists two "flag type" features under the vendor.flags domain, two "attribute type" features and uder the vendor.config domain and two "instance type" features under the vendor.devices domain. This features will not be directly affecting the node labels but they will be used as input when be NodeFeatureRule object are evaluated.
In addition the example requests directly the feature.node.kubenernetes.io/vendor-feature.enabled=true node label to be created.
The nfd.node.kubernetes.io/node-name=<node-name> must be in place for each NodeFeature objectt as NFD uses it to determine the node which it is targeting.
Feature types
Features are divided into three different types:
- flag features: a set of names without any associated values, e.g. CPUID flags or loaded kernel modules
- attribute features: a set of names each of which has a single value associated with it (essentially a map of key-value pairs), e.g. kernel config flags or os release information
- instance features: a list of instances, each of which has multiple attributes (key-value pairs of their own) associated with it, e.g. PCI or USB devices
NodeFeatureRule custom resource
NodeFeatureRule objects provide an easy way to create vendor or application specific labels and taints. It uses a flexible rule-based mechanism for creating labels and optionally taints based on node features.
A NodeFeatureRule example
Consider the following referential example:
apiVersion: nfd.k8s-sigs.io/v1alpha1
+
The object targets node named node-1. It lists two "flag type" features under the vendor.flags domain, two "attribute type" features and under the vendor.config domain and two "instance type" features under the vendor.devices domain. These features will not be directly affecting the node labels but they will be used as input when the NodeFeatureRule objects are evaluated.
In addition, the example requests directly the feature.node.kubenernetes.io/vendor-feature.enabled=true node label to be created.
The nfd.node.kubernetes.io/node-name=<node-name> must be in place for each NodeFeature object as NFD uses it to determine the node which it is targeting.
Feature types
Features are divided into three different types:
- flag features: a set of names without any associated values, e.g. CPUID flags or loaded kernel modules
- attribute features: a set of names each of which has a single value associated with it (essentially a map of key-value pairs), e.g. kernel config flags or os release information
- instance features: a list of instances, each of which has multiple attributes (key-value pairs of their own) associated with it, e.g. PCI or USB devices
NodeFeatureRule custom resource
NodeFeatureRule objects provide an easy way to create vendor or application specific labels and taints. It uses a flexible rule-based mechanism for creating labels and optionally taints based on node features.
A NodeFeatureRule example
Consider the following referential example:
apiVersion: nfd.k8s-sigs.io/v1alpha1
kind: NodeFeatureRule
metadata:
name: my-sample-rule-object
@@ -46,7 +46,7 @@
matchExpressions:
X86: {op: In, value: ["y"]}
It specifies one rule which creates node label feature.node.kubenernetes.io/my-sample-feature=true if both of the following conditions are true (matchFeatures implements a logical AND over the matchers):
- The
dummy network driver module has been loaded - X86 option in kernel config is set to
=y
Create a NodeFeatureRule with a yaml file:
kubectl apply -f https://raw.githubusercontent.com/kubernetes-sigs/node-feature-discovery/master/examples/nodefeaturerule.yaml
-
Now, on X86 platforms the feature label appears after doing modprobe dummy on a system and correspondingly the label is removed after rmmod dummy. Note a re-labeling delay up to the sleep-interval of nfd-worker (1 minute by default).
See Label rule format for detailed description of available fields and how to write labeling rules.
NodeFeatureRule tainting feature
This feature is experimental.
In some circumstances it is desirable keep nodes with specialized hardware away from running general workload and instead leave them for workloads that need the specialized hardware. One way to achieve it is to taint the nodes with the specialized hardware and add corresponding toleration to pods that require the special hardware. NFD offers node tainting functionality which is disabled by default. User can define one or more custom taints via the taints field of the NodeFeatureRule CR. The same rule-based mechanism is applied here and the NFD taints only rule matching nodes.
To enable the tainting feature, --enable-taints flag needs to be set to true. If the flag --enable-taints is set to false (i.e. disabled), taints defined in the NodeFeatureRule CR have no effect and will be ignored by the NFD master.
NOTE: Before enabling any taints, make sure to edit nfd-worker daemonset to tolerate the taints to be created. Otherwise, already running pods that do not tolerate the taint are evicted immediately from the node including the nfd-worker pod.
Example NodeFeatureRule with custom taints:
apiVersion: nfd.k8s-sigs.io/v1alpha1
+
Now, on X86 platforms the feature label appears after doing modprobe dummy on a system and correspondingly the label is removed after rmmod dummy. Note a re-labeling delay up to the sleep-interval of nfd-worker (1 minute by default).
See Label rule format for detailed description of available fields and how to write labeling rules.
NodeFeatureRule tainting feature
This feature is experimental.
In some circumstances, it is desirable to keep nodes with specialized hardware away from running general workload and instead leave them for workloads that need the specialized hardware. One way to achieve it is to taint the nodes with the specialized hardware and add corresponding toleration to pods that require the special hardware. NFD offers node tainting functionality which is disabled by default. User can define one or more custom taints via the taints field of the NodeFeatureRule CR. The same rule-based mechanism is applied here and the NFD taints only rule matching nodes.
To enable the tainting feature, --enable-taints flag needs to be set to true. If the flag --enable-taints is set to false (i.e. disabled), taints defined in the NodeFeatureRule CR have no effect and will be ignored by the NFD master.
NOTE: Before enabling any taints, make sure to edit nfd-worker daemonset to tolerate the taints to be created. Otherwise, already running pods that do not tolerate the taint are evicted immediately from the node including the nfd-worker pod.
Example NodeFeatureRule with custom taints:
apiVersion: nfd.k8s-sigs.io/v1alpha1
kind: NodeFeatureRule
metadata:
name: my-sample-rule-object
@@ -322,4 +322,4 @@ Element :An identifier of the USB attribute.
value: "datacenter-1"
matchOn:
- nodename: [ "node-datacenter1-rack.*-server.*" ]
-
In the example above:
- A node would contain the label:
feature.node.kubernetes.io/custom-my.kernel.feature=true if the node has kmod1 AND kmod2 kernel modules loaded. - A node would contain the label:
feature.node.kubernetes.io/custom-my.pci.feature=true if the node contains a PCI device with a PCI vendor ID of 15b3 AND PCI device ID of 1014 OR 1017. - A node would contain the label:
feature.node.kubernetes.io/custom-my.usb.feature=true if the node contains a USB device with a USB vendor ID of 1d6b AND USB device ID of 0003. - A node would contain the label:
feature.node.kubernetes.io/custom-my.combined.feature=true if vendor_kmod1 AND vendor_kmod2 kernel modules are loaded AND the node contains a PCI device with a PCI vendor ID of 15b3 AND PCI device ID of 1014 or 1017. - A node would contain the label:
vendor.feature.node.kubernetes.io/accumulated.feature=true if some_kmod1 AND some_kmod2 kernel modules are loaded OR the node contains a PCI device with a PCI vendor ID of 15b3 AND PCI device ID of 1014 OR 1017. - A node would contain the label:
feature.node.kubernetes.io/custom-my.kernel.featureneedscpu=true if KVM_INTEL kernel config is enabled AND the node CPU supports VMX virtual machine extensions - A node would contain the label:
feature.node.kubernetes.io/custom-my.kernel.modulecompiler=true if the in-tree kmod1 kernel module is loaded AND it's built with GCC_VERSION=100101. - A node would contain the label:
profile.node.kubernetes.io/my-datacenter=datacenter-1 if the node's name matches the node-datacenter1-rack.*-server.* pattern, e.g. node-datacenter1-rack2-server42
Node Feature Discovery master
\ No newline at end of file
+In the example above:
feature.node.kubernetes.io/custom-my.kernel.feature=true if the node has kmod1 AND kmod2 kernel modules loaded.feature.node.kubernetes.io/custom-my.pci.feature=true if the node contains a PCI device with a PCI vendor ID of 15b3 AND PCI device ID of 1014 OR 1017.feature.node.kubernetes.io/custom-my.usb.feature=true if the node contains a USB device with a USB vendor ID of 1d6b AND USB device ID of 0003.feature.node.kubernetes.io/custom-my.combined.feature=true if vendor_kmod1 AND vendor_kmod2 kernel modules are loaded AND the node contains a PCI device with a PCI vendor ID of 15b3 AND PCI device ID of 1014 or 1017.vendor.feature.node.kubernetes.io/accumulated.feature=true if some_kmod1 AND some_kmod2 kernel modules are loaded OR the node contains a PCI device with a PCI vendor ID of 15b3 AND PCI device ID of 1014 OR 1017.feature.node.kubernetes.io/custom-my.kernel.featureneedscpu=true if KVM_INTEL kernel config is enabled AND the node CPU supports VMX virtual machine extensionsfeature.node.kubernetes.io/custom-my.kernel.modulecompiler=true if the in-tree kmod1 kernel module is loaded AND it's built with GCC_VERSION=100101.profile.node.kubernetes.io/my-datacenter=datacenter-1 if the node's name matches the node-datacenter1-rack.*-server.* pattern, e.g. node-datacenter1-rack2-server42This page contains usage examples and demos.
A demo on the benefits of using node feature discovery can be found in the source code repository under demo/.
This page contains usage examples and demos.
A demo on the benefits of using node feature discovery can be found in the source code repository under demo/.
Features are advertised as labels in the Kubernetes Node object.
Label creation in nfd-worker is performed by a set of separate modules called label sources. The core.labelSources configuration option (or -label-sources flag) of nfd-worker controls which sources to enable for label generation.
All built-in labels use the feature.node.kubernetes.io label namespace and have the following format.
feature.node.kubernetes.io/<feature> = <value>
+ Feature labels · Node Feature Discovery
Feature labels
Table of contents
Features are advertised as labels in the Kubernetes Node object.
Built-in labels
Label creation in nfd-worker is performed by a set of separate modules called label sources. The core.labelSources configuration option (or -label-sources flag) of nfd-worker controls which sources to enable for label generation.
All built-in labels use the feature.node.kubernetes.io label namespace and have the following format.
feature.node.kubernetes.io/<feature> = <value>
NOTE: Consecutive runs of nfd-worker will update the labels on a given node. If features are not discovered on a consecutive run, the corresponding label will be removed. This includes any restrictions placed on the consecutive run, such as restricting discovered features with the -label-whitelist flag of nfd-master or core.labelWhiteList option of nfd-worker.
CPU
Feature name Value Description cpu-cpuid.<cpuid-flag>true CPU capability is supported. NOTE: the capability might be supported but not enabled. cpu-hardware_multithreadingtrue Hardware multithreading, such as Intel HTT, enabled (number of logical CPUs is greater than physical CPUs) cpu-coprocessor.nx_gziptrue Nest Accelerator for GZIP is supported(Power). cpu-power.sst_bf.enabledtrue Intel SST-BF (Intel Speed Select Technology - Base frequency) enabled cpu-pstate.statusstring The status of the Intel pstate driver when in use and enabled, either ‘active' or ‘passive'. cpu-pstate.turbobool Set to ‘true' if turbo frequencies are enabled in Intel pstate driver, set to ‘false' if they have been disabled. cpu-pstate.scaling_governorstring The value of the Intel pstate scaling_governor when in use, either ‘powersave' or ‘performance'. cpu-cstate.enabledbool Set to ‘true' if cstates are set in the intel_idle driver, otherwise set to ‘false'. Unset if intel_idle cpuidle driver is not active. cpu-rdt.<rdt-flag>true Intel RDT capability is supported. See RDT flags for details. cpu-security.sgx.enabledtrue Set to ‘true' if Intel SGX is enabled in BIOS (based a non-zero sum value of SGX EPC section sizes). cpu-security.se.enabledtrue Set to ‘true' if IBM Secure Execution for Linux (IBM Z & LinuxONE) is available and enabled (requires /sys/firmware/uv/prot_virt_host facility) cpu-security.tdx.enabledtrue Set to ‘true' if Intel TDX is available on the host and has been enabled (requires /sys/module/kvm_intel/parameters/tdx). cpu-sgx.enabledtrue DEPRECATED: use cpu-security.sgx.enabled instead. cpu-se.enabledtrue DEPRECATED: use cpu-security.se.enabled instead. cpu-model.vendor_idstring Comparable CPU vendor ID. cpu-model.familyint CPU family. cpu-model.idint CPU model number.
The CPU label source is configurable, see worker configuration and sources.cpu configuration options for details.
X86 CPUID flags (partial list)
Flag Description ADX Multi-Precision Add-Carry Instruction Extensions (ADX) AESNI Advanced Encryption Standard (AES) New Instructions (AES-NI) AVX Advanced Vector Extensions (AVX) AVX2 Advanced Vector Extensions 2 (AVX2) AVXVNNI AVX (VEX encoded) VNNI neural network instructions AMXBF16 Advanced Matrix Extension, tile multiplication operations on BFLOAT16 numbers AMXINT8 Advanced Matrix Extension, tile multiplication operations on 8-bit integers AMXFP16 Advanced Matrix Extension, tile multiplication operations on FP16 numbers AMXTILE Advanced Matrix Extension, base tile architecture support AVX512BF16 AVX-512 BFLOAT16 instructions AVX512BITALG AVX-512 bit Algorithms AVX512BW AVX-512 byte and word Instructions AVX512CD AVX-512 conflict detection instructions AVX512DQ AVX-512 doubleword and quadword instructions AVX512ER AVX-512 exponential and reciprocal instructions AVX512F AVX-512 foundation AVX512FP16 AVX-512 FP16 instructions AVX512IFMA AVX-512 integer fused multiply-add instructions AVX512PF AVX-512 prefetch instructions AVX512VBMI AVX-512 vector bit manipulation instructions AVX512VBMI2 AVX-512 vector bit manipulation instructions, version 2 AVX512VL AVX-512 vector length extensions AVX512VNNI AVX-512 vector neural network instructions AVX512VP2INTERSECT AVX-512 intersect for D/Q AVX512VPOPCNTDQ AVX-512 vector population count doubleword and quadword AVXIFMA AVX-IFMA instructions AVXNECONVERT AVX-NE-CONVERT instructions AVXVNNIINT8 AVX-VNNI-INT8 instructions CMPCCXADD CMPCCXADD instructions ENQCMD Enqueue Command GFNI Galois Field New Instructions HYPERVISOR Running under hypervisor MSRLIST Read/Write List of Model Specific Registers PREFETCHI PREFETCHIT0/1 instructions VAES AVX-512 vector AES instructions VPCLMULQDQ Carry-less multiplication quadword WRMSRNS Non-Serializing Write to Model Specific Register
By default, the following CPUID flags have been blacklisted: BMI1, BMI2, CLMUL, CMOV, CX16, ERMS, F16C, HTT, LZCNT, MMX, MMXEXT, NX, POPCNT, RDRAND, RDSEED, RDTSCP, SGX, SSE, SSE2, SSE3, SSE4, SSE42 and SSSE3. See sources.cpu configuration options to change the behavior.
See the full list in github.com/klauspost/cpuid.
Arm CPUID flags (partial list)
Flag Description IDIVA Integer divide instructions available in ARM mode IDIVT Integer divide instructions available in Thumb mode THUMB Thumb instructions FASTMUL Fast multiplication VFP Vector floating point instruction extension (VFP) VFPv3 Vector floating point extension v3 VFPv4 Vector floating point extension v4 VFPD32 VFP with 32 D-registers HALF Half-word loads and stores EDSP DSP extensions NEON NEON SIMD instructions LPAE Large Physical Address Extensions
Arm64 CPUID flags (partial list)
Flag Description AES Announcing the Advanced Encryption Standard EVSTRM Event Stream Frequency Features FPHP Half Precision(16bit) Floating Point Data Processing Instructions ASIMDHP Half Precision(16bit) Asimd Data Processing Instructions ATOMICS Atomic Instructions to the A64 ASIMRDM Support for Rounding Double Multiply Add/Subtract PMULL Optional Cryptographic and CRC32 Instructions JSCVT Perform Conversion to Match Javascript DCPOP Persistent Memory Support
Intel RDT flags
Flag Description 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
Kernel
Feature Value Description kernel-config.<option>true Kernel config option is enabled (set ‘y' or ‘m'). Default options are NO_HZ, NO_HZ_IDLE, NO_HZ_FULL and PREEMPT kernel-selinux.enabledtrue Selinux is enabled on the node kernel-version.fullstring Full kernel version as reported by /proc/sys/kernel/osrelease (e.g. ‘4.5.6-7-g123abcde') kernel-version.majorstring First component of the kernel version (e.g. ‘4') kernel-version.minorstring Second component of the kernel version (e.g. ‘5') kernel-version.revisionstring Third component of the kernel version (e.g. ‘6')
The kernel label source is configurable, see worker configuration and sources.kernel configuration options for details.
Memory
Feature Value Description memory-numatrue Multiple memory nodes i.e. NUMA architecture detected memory-nv.presenttrue NVDIMM device(s) are present memory-nv.daxtrue NVDIMM region(s) configured in DAX mode are present
Network
Feature Value Description network-sriov.capabletrue Single Root Input/Output Virtualization (SR-IOV) enabled Network Interface Card(s) present network-sriov.configuredtrue SR-IOV virtual functions have been configured
PCI
Feature Value Description pci-<device label>.presenttrue PCI device is detected pci-<device label>.sriov.capabletrue Single Root Input/Output Virtualization (SR-IOV) enabled PCI device present
<device label> is format is configurable and set to <class>_<vendor> by default. For more more details about configuration of the pci labels, see sources.pci options and worker configuration instructions.
USB
Feature Value Description usb-<device label>.presenttrue USB device is detected
<device label> is format is configurable and set to <class>_<vendor>_<device> by default. For more more details about configuration of the usb labels, see sources.usb options and worker configuration instructions.
Storage
Feature Value Description storage-nonrotationaldisktrue Non-rotational disk, like SSD, is present in the node
System
Feature Value Description system-os_release.IDstring Operating system identifier system-os_release.VERSION_IDstring Operating system version identifier (e.g. ‘6.7') system-os_release.VERSION_ID.majorstring First component of the OS version id (e.g. ‘6') system-os_release.VERSION_ID.minorstring Second component of the OS version id (e.g. ‘7')
Custom
The custom label source is designed for creating user defined labels. However, it has a few statically defined built-in labels:
Feature Value Description custom-rdma.capabletrue The node has an RDMA capable Network adapter custom-rdma.enabledtrue The node has the needed RDMA modules loaded to run RDMA traffic
User defined labels
NFD has many extension points for creating vendor and application specific labels. See the customization guide for detailed documentation.
Extended resources
This feature is experimental and by no means a replacement for the usage of device plugins.
Labels which have integer values, can be promoted to Kubernetes extended resources by listing them to the master -resource-labels command line flag. These labels won't then show in the node label section, they will appear only as extended resources.
An example use-case for the extended resources could be based on a hook which creates a label for the node SGX EPC memory section size. By giving the name of that label in the -resource-labels flag, that value will then turn into an extended resource of the node, allowing PODs to request that resource and the Kubernetes scheduler to schedule such PODs to only those nodes which have a sufficient capacity of said resource left.
Similar to labels, the default namespace feature.node.kubernetes.io is automatically prefixed to the extended resource, if the promoted label doesn't have a namespace.
Example usage of the command line arguments, using a new namespace: nfd-master -resource-labels=my_source-my.feature,sgx.some.ns/epc -extra-label-ns=sgx.some.ns
The above would result in following extended resources provided that related labels exist:
sgx.some.ns/epc: <label value>
feature.node.kubernetes.io/my_source-my.feature: <label value>
-
Node Feature Discovery master
\ No newline at end of file
+Usage instructions.
Usage instructions.
NFD-Master is responsible for connecting to the Kubernetes API server and updating node objects. More specifically, it modifies node labels, taints and extended resources based on requests from nfd-workers and 3rd party extensions.
EXPERIMENTAL Controller for NodeFeature objects can be enabled with the -enable-nodefeature-api command line flag. When enabled, features from NodeFeature objects are used as the input for the NodeFeatureRule processing pipeline. In addition, any labels listed in the NodeFeature object are created on the node (note the allowed label namespaces are controlled).
NOTE: NodeFeature API must also be enabled in nfd-worker with its
-enable-nodefeature-apiflag.
NFD-Master acts as the controller for NodeFeatureRule objects. It applies the rules specified in NodeFeatureRule objects on raw feature data and creates node labels accordingly. The feature data used as the input can be received from nfd-worker instances through the gRPC interface or from NodeFeature objects. The latter requires that the NodeFeaure controller has been enabled.
NOTE: when gRPC is used for communicating the features (the default mechanism), (re-)labelling only happens when a request is received from nfd-worker. That is, in practice rules are evaluated and labels for each node are created on intervals specified by the
core.sleepIntervalconfiguration option of nfd-worker instances. This means that modification or creation of NodeFeatureRule objects does not instantly cause the node labels to be updated. Instead, the changes only come visible in node labels as nfd-worker instances send their labelling requests. This limitation is not present when gRPC interface is disabled and NodeFeature API is used.
NFD-Master runs as a deployment, by default it prefers running on the cluster's master nodes but will run on worker nodes if no master nodes are found.
For High Availability, you should simply increase the replica count of the deployment object. You should also look into adding inter-pod affinity to prevent masters from running on the same node. However note that inter-pod affinity is costly and is not recommended in bigger clusters.
NOTE: If the NodeFeature controller is enabled the replica count should be 1.
If you have RBAC authorization enabled (as is the default e.g. with clusters initialized with kubeadm) you need to configure the appropriate ClusterRoles, ClusterRoleBindings and a ServiceAccount in order for NFD to create node labels. The provided template will configure these for you.
NFD-Master is responsible for connecting to the Kubernetes API server and updating node objects. More specifically, it modifies node labels, taints and extended resources based on requests from nfd-workers and 3rd party extensions.
EXPERIMENTAL Controller for NodeFeature objects can be enabled with the -enable-nodefeature-api command line flag. When enabled, features from NodeFeature objects are used as the input for the NodeFeatureRule processing pipeline. In addition, any labels listed in the NodeFeature object are created on the node (note the allowed label namespaces are controlled).
NOTE: NodeFeature API must also be enabled in nfd-worker with its
-enable-nodefeature-apiflag.
NFD-Master acts as the controller for NodeFeatureRule objects. It applies the rules specified in NodeFeatureRule objects on raw feature data and creates node labels accordingly. The feature data used as the input can be received from nfd-worker instances through the gRPC interface or from NodeFeature objects. The latter requires that the NodeFeaure controller has been enabled.
NOTE: when gRPC is used for communicating the features (the default mechanism), (re-)labelling only happens when a request is received from nfd-worker. That is, in practice rules are evaluated and labels for each node are created on intervals specified by the
core.sleepIntervalconfiguration option of nfd-worker instances. This means that modification or creation of NodeFeatureRule objects does not instantly cause the node labels to be updated. Instead, the changes only come visible in node labels as nfd-worker instances send their labelling requests. This limitation is not present when gRPC interface is disabled and NodeFeature API is used.
NFD-Master runs as a deployment, by default it prefers running on the cluster's master nodes but will run on worker nodes if no master nodes are found.
For High Availability, you should simply increase the replica count of the deployment object. You should also look into adding inter-pod affinity to prevent masters from running on the same node. However note that inter-pod affinity is costly and is not recommended in bigger clusters.
NOTE: If the NodeFeature controller is enabled the replica count should be 1.
If you have RBAC authorization enabled (as is the default e.g. with clusters initialized with kubeadm) you need to configure the appropriate ClusterRoles, ClusterRoleBindings and a ServiceAccount in order for NFD to create node labels. The provided template will configure these for you.
NFD-Topology-Garbage-Collector is preferably run as a Kubernetes deployment with one replica. It makes sure that all NodeResourceTopology have corresponding worker nodes and removes stale objects for worker nodes which are no longer part of Kubernetes cluster.
This service watches for Node deletion events and removes NodeResourceTopology objects upon them. It is also running periodically to make sure no event was missed or NodeResourceTopology object was created without corresponding worker node. The default garbage collector interval is set to 1h which is the value when no -gc-interval is specified.
In Helm deployments, (see Topology Garbage Collector for parameters). NFD-Topology-Garbage-Collector will only be deployed when topologyUpdater.enable is set to true.
NFD-Topology-Garbage-Collector is preferably run as a Kubernetes deployment with one replica. It makes sure that all NodeResourceTopology have corresponding worker nodes and removes stale objects for worker nodes which are no longer part of Kubernetes cluster.
This service watches for Node deletion events and removes NodeResourceTopology objects upon them. It is also running periodically to make sure no event was missed or NodeResourceTopology object was created without corresponding worker node. The default garbage collector interval is set to 1h which is the value when no -gc-interval is specified.
In Helm deployments, (see Topology Garbage Collector for parameters). NFD-Topology-Garbage-Collector will only be deployed when topologyUpdater.enable is set to true.
NFD-Topology-Updater is preferably run as a Kubernetes DaemonSet. This assures re-examination on regular intervals, capturing changes in the allocated resources and hence the allocatable resources on a per zone basis by updating NodeResourceTopology custom resources. It makes sure that new NodeResourceTopology instances are created for each new nodes that get added to the cluster.
When run as a daemonset, nodes are re-examined for the allocated resources (to determine the information of the allocatable resources on a per zone basis where a zone can be a NUMA node) at an interval specified using the -sleep-interval option. The default sleep interval is set to 60s which is the value when no -sleep-interval is specified. In addition, it can avoid examining specific allocated resources given a configuration of resources to exclude via -excludeList
Kubelet PodResource API is a prerequisite for nfd-topology-updater to be able to run.
Preceding Kubernetes v1.23, the kubelet must be started with --feature-gates=KubeletPodResourcesGetAllocatable=true.
Starting from Kubernetes v1.23, the KubeletPodResourcesGetAllocatable feature gate. is enabled by default
NFD-Topology-Updater supports configuration through a configuration file. The default location is /etc/kubernetes/node-feature-discovery/topology-updater.conf, but, this can be changed by specifying the-config command line flag.
NOTE: unlike nfd-worker, dynamic configuration updates are not currently supported.
Topology-Updater configuration file is read inside the container, and thus, Volumes and VolumeMounts are needed to make your configuration available for NFD. The preferred method is to use a ConfigMap which provides easy deployment and re-configurability.
The provided nfd-topology-updater deployment templates create an empty configmap and mount it inside the nfd-topology-updater containers. In kustomize deployments, configuration can be edited with:
kubectl -n ${NFD_NS} edit configmap nfd-topology-updater-conf
-In Helm deployments, Topology Updater parameters toplogyUpdater.config can be used to edit the respective configuration.
See nfd-topology-updater configuration file reference for more details. The (empty-by-default) example config contains all available configuration options and can be used as a reference for creating a configuration.
NFD-Topology-Updater is preferably run as a Kubernetes DaemonSet. This assures re-examination on regular intervals, capturing changes in the allocated resources and hence the allocatable resources on a per zone basis by updating NodeResourceTopology custom resources. It makes sure that new NodeResourceTopology instances are created for each new nodes that get added to the cluster.
When run as a daemonset, nodes are re-examined for the allocated resources (to determine the information of the allocatable resources on a per zone basis where a zone can be a NUMA node) at an interval specified using the -sleep-interval option. The default sleep interval is set to 60s which is the value when no -sleep-interval is specified. In addition, it can avoid examining specific allocated resources given a configuration of resources to exclude via -excludeList
Kubelet PodResource API is a prerequisite for nfd-topology-updater to be able to run.
Preceding Kubernetes v1.23, the kubelet must be started with --feature-gates=KubeletPodResourcesGetAllocatable=true.
Starting from Kubernetes v1.23, the KubeletPodResourcesGetAllocatable feature gate. is enabled by default
NFD-Topology-Updater supports configuration through a configuration file. The default location is /etc/kubernetes/node-feature-discovery/topology-updater.conf, but, this can be changed by specifying the-config command line flag.
NOTE: unlike nfd-worker, dynamic configuration updates are not currently supported.
Topology-Updater configuration file is read inside the container, and thus, Volumes and VolumeMounts are needed to make your configuration available for NFD. The preferred method is to use a ConfigMap which provides easy deployment and re-configurability.
The provided nfd-topology-updater deployment templates create an empty configmap and mount it inside the nfd-topology-updater containers. In kustomize deployments, configuration can be edited with:
kubectl -n ${NFD_NS} edit configmap nfd-topology-updater-conf
+In Helm deployments, Topology Updater parameters toplogyUpdater.config can be used to edit the respective configuration.
See nfd-topology-updater configuration file reference for more details. The (empty-by-default) example config contains all available configuration options and can be used as a reference for creating a configuration.
NFD-Worker is preferably run as a Kubernetes DaemonSet. This assures re-labeling on regular intervals capturing changes in the system configuration and makes sure that new nodes are labeled as they are added to the cluster. Worker connects to the nfd-master service to advertise hardware features.
When run as a daemonset, nodes are re-labeled at an default interval of 60s. This can be changed by using the core.sleepInterval config option.
The worker configuration file is watched and re-read on every change which provides a simple mechanism of dynamic run-time reconfiguration. See worker configuration for more details.
NFD-Worker supports dynamic configuration through a configuration file. The default location is /etc/kubernetes/node-feature-discovery/nfd-worker.conf, but, this can be changed by specifying the-config command line flag. Configuration file is re-read whenever it is modified which makes run-time re-configuration of nfd-worker straightforward.
Worker configuration file is read inside the container, and thus, Volumes and VolumeMounts are needed to make your configuration available for NFD. The preferred method is to use a ConfigMap which provides easy deployment and re-configurability.
The provided nfd-worker deployment templates create an empty configmap and mount it inside the nfd-worker containers. In kustomize deployments, configuration can be edited with:
kubectl -n ${NFD_NS} edit configmap nfd-worker-conf
+ NFD-Worker · Node Feature Discovery
NFD-Worker
Table of contents
NFD-Worker is preferably run as a Kubernetes DaemonSet. This assures re-labeling on regular intervals capturing changes in the system configuration and makes sure that new nodes are labeled as they are added to the cluster. Worker connects to the nfd-master service to advertise hardware features.
When run as a daemonset, nodes are re-labeled at an default interval of 60s. This can be changed by using the core.sleepInterval config option.
The worker configuration file is watched and re-read on every change which provides a simple mechanism of dynamic run-time reconfiguration. See worker configuration for more details.
Worker configuration
NFD-Worker supports dynamic configuration through a configuration file. The default location is /etc/kubernetes/node-feature-discovery/nfd-worker.conf, but, this can be changed by specifying the-config command line flag. Configuration file is re-read whenever it is modified which makes run-time re-configuration of nfd-worker straightforward.
Worker configuration file is read inside the container, and thus, Volumes and VolumeMounts are needed to make your configuration available for NFD. The preferred method is to use a ConfigMap which provides easy deployment and re-configurability.
The provided nfd-worker deployment templates create an empty configmap and mount it inside the nfd-worker containers. In kustomize deployments, configuration can be edited with:
kubectl -n ${NFD_NS} edit configmap nfd-worker-conf
In Helm deployments, Worker pod parameter worker.config can be used to edit the respective configuration.
See nfd-worker configuration file reference for more details. The (empty-by-default) example config contains all available configuration options and can be used as a reference for creating a configuration.
Configuration options can also be specified via the -options command line flag, in which case no mounts need to be used. The same format as in the config file must be used, i.e. JSON (or YAML). For example:
-options='{"sources": { "pci": { "deviceClassWhitelist": ["12"] } } }'
-
Configuration options specified from the command line will override those read from the config file.
Node Feature Discovery master
\ No newline at end of file
+Configuration options specified from the command line will override those read from the config file.
Nodes with specific features can be targeted using the nodeSelector field. The following example shows how to target nodes with Intel TurboBoost enabled.
apiVersion: v1
+ Using node labels · Node Feature Discovery
Using node labels
Nodes with specific features can be targeted using the nodeSelector field. The following example shows how to target nodes with Intel TurboBoost enabled.
apiVersion: v1
kind: Pod
metadata:
labels:
@@ -10,4 +10,4 @@
name: go1
nodeSelector:
feature.node.kubernetes.io/cpu-pstate.turbo: 'true'
-
For more details on targeting nodes, see node selection.
Node Feature Discovery master
\ No newline at end of file
+For more details on targeting nodes, see node selection.