Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: simplify quick-start page #973

Merged
merged 1 commit into from
Dec 1, 2022
Merged

docs: simplify quick-start page #973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 6 additions & 22 deletions docs/get-started/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -111,15 +99,11 @@ 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
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 changes: 16 additions & 1 deletion docs/usage/nfd-topology-updater.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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