Skip to content

Commit ab289ff

Browse files
authored
Merge pull request #40462 from Ritikaa96/annotation-nfd
Document node discovery annotations
2 parents d703ea5 + 9458ee7 commit ab289ff

File tree

1 file changed

+58
-0
lines changed
  • content/en/docs/reference/labels-annotations-taints

1 file changed

+58
-0
lines changed

content/en/docs/reference/labels-annotations-taints/_index.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -942,6 +942,64 @@ Example: `node.cloudprovider.kubernetes.io/shutdown: "NoSchedule"`
942942

943943
If a Node is in a cloud provider specified shutdown state, the Node gets tainted accordingly with `node.cloudprovider.kubernetes.io/shutdown` and the taint effect of `NoSchedule`.
944944

945+
### feature.node.kubernetes.io/*
946+
Used on: Nodes
947+
Example: `feature.node.kubernetes.io/network-sriov.capable: "true"`
948+
949+
These features are advertised as labels in the Kubernetes Node object on nodes running NFD.
950+
All built-in labels use the feature.node.kubernetes.io label namespace and have the format
951+
`feature.node.kubernetes.io/<feature-name>: <true>`.
952+
NFD has many extension points for creating vendor and application-specific labels.
953+
For details, see the [customization guide](https://kubernetes-sigs.github.io/node-feature-discovery/v0.12/usage/customization-guide).
954+
955+
### nfd.node.kubernetes.io/master.version
956+
957+
Example: `nfd.node.kubernetes.io/master.version: "v0.6.0"`
958+
959+
Used on: Nodes
960+
961+
For node(s) where the Node Feature Discovery (NFD)
962+
[master](https://kubernetes-sigs.github.io/node-feature-discovery/stable/usage/nfd-master.html)
963+
is scheduled, this annotation records the version of the NFD master.
964+
It is used for informative use only.
965+
966+
### nfd.node.kubernetes.io/worker.version
967+
968+
Example: `nfd.node.kubernetes.io/worker.version: "v0.4.0"`
969+
970+
Used on: Nodes
971+
972+
This annotation records the version for a Node Feature Discovery's
973+
[worker](https://kubernetes-sigs.github.io/node-feature-discovery/stable/usage/nfd-worker.html)
974+
if there is one running on a node.
975+
It's used for informative use only.
976+
977+
### nfd.node.kubernetes.io/feature-labels
978+
979+
Example: `nfd.node.kubernetes.io/feature-labels: "cpu-cpuid.ADX,cpu-cpuid.AESNI,cpu-hardware_multithreading,kernel-version.full"`
980+
981+
Used on: Nodes
982+
983+
This annotation records a comma-separated list of node feature labels managed by
984+
[Node Feature Discovery](https://kubernetes-sigs.github.io/node-feature-discovery/) (NFD).
985+
NFD uses this for an internal mechanism. You should not edit this annotation yourself.
986+
987+
### nfd.node.kubernetes.io/extended-resources
988+
989+
Example: `nfd.node.kubernetes.io/extended-resources: "accelerator.acme.example/q500,example.com/coprocessor-fx5"`
990+
991+
Used on: Nodes
992+
993+
This annotation records a comma-separated list of [extended resources](/docs/concepts/configuration/manage-resources-containers/#extended-resources)
994+
managed by [Node Feature Discovery](https://kubernetes-sigs.github.io/node-feature-discovery/) (NFD).
995+
NFD uses this for an internal mechanism. You should not edit this annotation yourself.
996+
997+
{{< note >}}
998+
These annotations only applies to nodes where NFD is running.
999+
To learn more about NFD and its components go to its official
1000+
[documentation](https://kubernetes-sigs.github.io/node-feature-discovery/stable/get-started/).
1001+
{{< /note >}}
1002+
9451003
### pod-security.kubernetes.io/enforce
9461004

9471005
Example: `pod-security.kubernetes.io/enforce: "baseline"`

0 commit comments

Comments
 (0)