From b1328b316600ba9853399f723ad71babb644e76d Mon Sep 17 00:00:00 2001 From: Markus Lehtonen Date: Fri, 21 Jul 2023 14:36:56 +0300 Subject: [PATCH] docs: describe supported Kubernetes versions --- docs/deployment/index.md | 3 +++ docs/get-started/introduction.md | 3 ++- docs/usage/nfd-topology-updater.md | 7 +++++-- 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/deployment/index.md b/docs/deployment/index.md index 08954e3d44..bcabda8762 100644 --- a/docs/deployment/index.md +++ b/docs/deployment/index.md @@ -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. diff --git a/docs/get-started/introduction.md b/docs/get-started/introduction.md index 5e714479c5..569bea3e39 100644 --- a/docs/get-started/introduction.md +++ b/docs/get-started/introduction.md @@ -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: diff --git a/docs/usage/nfd-topology-updater.md b/docs/usage/nfd-topology-updater.md index 697f158753..f2098a5b5a 100644 --- a/docs/usage/nfd-topology-updater.md +++ b/docs/usage/nfd-topology-updater.md @@ -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`. @@ -83,3 +85,4 @@ for creating a configuration. [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