From 8a4538403770ebb51492c8e40a81ec3ecb8b05e9 Mon Sep 17 00:00:00 2001 From: Markus Lehtonen Date: Thu, 1 Dec 2022 10:24:16 +0200 Subject: [PATCH] docs: simplify quick-start page Move topology-updater deployment notes to the topology-updater usage page. Also, rework the plaintext and headings a bit. --- docs/get-started/quick-start.md | 28 ++++++---------------------- docs/usage/nfd-topology-updater.md | 17 ++++++++++++++++- 2 files changed, 22 insertions(+), 23 deletions(-) diff --git a/docs/get-started/quick-start.md b/docs/get-started/quick-start.md index c0400121b7..b2c234200c 100644 --- a/docs/get-started/quick-start.md +++ b/docs/get-started/quick-start.md @@ -76,30 +76,18 @@ feature-dependent-pod 1/1 Running 0 23s 10.36.0.4 node-2 ## Additional Optional Installation Steps -In order to deploy nfd-master and nfd-topology-updater daemons -use `topologyupdater` overlay. +### Deploy nfd-topology-updater -Deploy with kustomize -- creates a new namespace, service and required RBAC -rules and nfd-master and nfd-topology-updater daemons. +In order to deploy nfd-master and nfd-topology-updater daemons +use `topologyupdater` kustomize overlay. ```bash kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref={{ site.release }} ``` -**NOTE:** - -[PodResource API][podresource-api] is a prerequisite for nfd-topology-updater. - -Preceding Kubernetes v1.23, the `kubelet` must be started with the following flag: +### Verify nfd-topology-updater -`--feature-gates=KubeletPodResourcesGetAllocatable=true` - -Starting Kubernetes v1.23, the `GetAllocatableResources` is enabled by default -through `KubeletPodResourcesGetAllocatable` [feature gate][feature-gate]. - -## Verify - -Wait until NFD master and NFD topologyupdater are running. +Wait until NFD topologyupdater (and NFD master) are running. ```bash $ kubectl -n node-feature-discovery get ds,deploy @@ -111,7 +99,7 @@ deployment.apps/nfd-master 1/1 1 1 17s ``` -Check that the NodeResourceTopology CR instances are created +Check that the NodeResourceTopology objects are created ```bash $ kubectl get noderesourcetopologies.topology.node.k8s.io @@ -119,7 +107,3 @@ NAME AGE kind-control-plane 23s kind-worker 23s ``` - - -[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 diff --git a/docs/usage/nfd-topology-updater.md b/docs/usage/nfd-topology-updater.md index 353b43d9a9..bb2ad7f1f6 100644 --- a/docs/usage/nfd-topology-updater.md +++ b/docs/usage/nfd-topology-updater.md @@ -25,6 +25,17 @@ option. The default sleep interval is set to 60s which is the value when no In addition, it can avoid examining specific allocated resources given a configuration of resources to exclude via [`-excludeList`](../reference/topology-updater-configuration-reference.md#excludelist) +## Deployment Notes + +Kubelet [PodResource API][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][feature-gate]. is enabled by default + ## Topology-Updater Configuration NFD-Topology-Updater supports configuration through a configuration file. The @@ -58,4 +69,8 @@ for more details. The (empty-by-default) [example config](https://github.com/kubernetes-sigs/node-feature-discovery/blob/{{site.release}}/deployment/components/topology-updater-config/nfd-topology-updater.conf.example) contains all available configuration options and can be used as a reference -for creating a configuration. \ No newline at end of file +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