Skip to content

Commit

Permalink
docs: describe supported Kubernetes versions
Browse files Browse the repository at this point in the history
  • Loading branch information
marquiz committed Jul 25, 2023
1 parent 5223d1f commit b1328b3
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 3 deletions.
3 changes: 3 additions & 0 deletions docs/deployment/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ sort: 2

# Deployment

Node Feature Discovery can be deployed on any recent version of Kubernetes
(v1.21+).

See [Image variants](image-variants.md) for description of the different NFD
container images available.

Expand Down
3 changes: 2 additions & 1 deletion docs/get-started/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ sort: 1
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 extended
resources and node taints.
resources and node taints. Node Feature Discovery is compatible with any recent
version of Kubernetes (v1.21+).

NFD consists of four software components:

Expand Down
7 changes: 5 additions & 2 deletions docs/usage/nfd-topology-updater.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,10 @@ given a configuration of resources to exclude via [`-excludeList`](../reference/

## Deployment Notes

Kubelet [PodResource API][podresource-api] is a prerequisite for
nfd-topology-updater to be able to run.
Kubelet [PodResource API][podresource-api] with the
[GetAllocatableResources][getallocatableresources] functionality enabled is a
prerequisite for nfd-topology-updater to be able to run (i.e. Kubernetes v1.21
or later is required).

Preceding Kubernetes v1.23, the `kubelet` must be started with
`--feature-gates=KubeletPodResourcesGetAllocatable=true`.
Expand Down Expand Up @@ -83,3 +85,4 @@ for creating a configuration.
<!-- Links -->
[podresource-api]: https://kubernetes.io/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins/#monitoring-device-plugin-resources
[feature-gate]: https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates
[getallocatableresources]: https://kubernetes.io/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins/#grpc-endpoint-getallocatableresources

0 comments on commit b1328b3

Please sign in to comment.