Documenting node discover annotations

Signed-off-by: Ritikaa96 <ritika@india.nec.com>
pull/40462/head
Ritikaa96 2023-03-31 19:58:05 +05:30
parent 720f535cc4
commit 9458ee79df
1 changed files with 58 additions and 0 deletions

View File

@ -930,6 +930,64 @@ Example: `node.cloudprovider.kubernetes.io/shutdown: "NoSchedule"`
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`.
### feature.node.kubernetes.io/*
Used on: Nodes
Example: `feature.node.kubernetes.io/network-sriov.capable: "true"`
These features are advertised as labels in the Kubernetes Node object on nodes running NFD.
All built-in labels use the feature.node.kubernetes.io label namespace and have the format
`feature.node.kubernetes.io/<feature-name>: <true>`.
NFD has many extension points for creating vendor and application-specific labels.
For details, see the [customization guide](https://kubernetes-sigs.github.io/node-feature-discovery/v0.12/usage/customization-guide).
### nfd.node.kubernetes.io/master.version
Example: `nfd.node.kubernetes.io/master.version: "v0.6.0"`
Used on: Nodes
For node(s) where the Node Feature Discovery (NFD)
[master](https://kubernetes-sigs.github.io/node-feature-discovery/stable/usage/nfd-master.html)
is scheduled, this annotation records the version of the NFD master.
It is used for informative use only.
### nfd.node.kubernetes.io/worker.version
Example: `nfd.node.kubernetes.io/worker.version: "v0.4.0"`
Used on: Nodes
This annotation records the version for a Node Feature Discovery's
[worker](https://kubernetes-sigs.github.io/node-feature-discovery/stable/usage/nfd-worker.html)
if there is one running on a node.
It's used for informative use only.
### nfd.node.kubernetes.io/feature-labels
Example: `nfd.node.kubernetes.io/feature-labels: "cpu-cpuid.ADX,cpu-cpuid.AESNI,cpu-hardware_multithreading,kernel-version.full"`
Used on: Nodes
This annotation records a comma-separated list of node feature labels managed by
[Node Feature Discovery](https://kubernetes-sigs.github.io/node-feature-discovery/) (NFD).
NFD uses this for an internal mechanism. You should not edit this annotation yourself.
### nfd.node.kubernetes.io/extended-resources
Example: `nfd.node.kubernetes.io/extended-resources: "accelerator.acme.example/q500,example.com/coprocessor-fx5"`
Used on: Nodes
This annotation records a comma-separated list of [extended resources](/docs/concepts/configuration/manage-resources-containers/#extended-resources)
managed by [Node Feature Discovery](https://kubernetes-sigs.github.io/node-feature-discovery/) (NFD).
NFD uses this for an internal mechanism. You should not edit this annotation yourself.
{{< note >}}
These annotations only applies to nodes where NFD is running.
To learn more about NFD and its components go to its official
[documentation](https://kubernetes-sigs.github.io/node-feature-discovery/stable/get-started/).
{{< /note >}}
### pod-security.kubernetes.io/enforce
Example: `pod-security.kubernetes.io/enforce: "baseline"`