mirrors/node-feature-discovery
mirrors/node-feature-discovery
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2025-03-13 20:30:03 +00:00
Code Activity

docs: simplify quick-start page

Browse source 
Move topology-updater deployment notes to the topology-updater usage
page. Also, rework the plaintext and headings a bit.
This commit is contained in:
Markus Lehtonen 2022-12-01 10:24:16 +02:00
parent d5e7f9091f
commit 8a45384037
2 changed files with 22 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
docs/get-started/quick-start.md
View file

@ -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:**
### Verify nfd-topology-updater
[PodResource API][podresource-api] is a prerequisite for nfd-topology-updater.
Preceding Kubernetes v1.23, the `kubelet` must be started with the following flag:
`--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
```
<!-- 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

17
docs/usage/nfd-topology-updater.md
View file

@ -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.
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