mirrors/node-feature-discovery
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2024-12-14 11:57:51 +00:00
Code Activity
node-feature-discovery/docs/usage/nfd-topology-updater.md

93 lines
4.3 KiB
Markdown
Raw Permalink Normal View History

docs: restructure docs Introduce two main sections "Deployment" and "Usage" and move "Developer guide" to the top level, too. In particular, split the huge deployment-and-usage file into multiple parts under the new main sections. Move customization guide from "Advanced" to "Usage". This patch also renames "Advanced" to "Reference" as only that is left there is reference documentation.
2022-11-02 12:34:37 +00:00
---
title: "NFD-Topology-Updater"
layout: default
sort: 5
---
# NFD-Topology-Updater
{: .no_toc}
---
documentaion: document the reactive updates feature Signed-off-by: Talor Itzhak <titzhak@redhat.com>
2023-02-21 15:09:04 +00:00
NFD-Topology-Updater is preferably run as a Kubernetes DaemonSet.
This assures re-examination on regular intervals
and/or per pod life-cycle events, capturing changes in the allocated
resources and hence the allocatable resources on a per-zone basis by updating
docs: fix internal cross-page references by injecting .md
2023-01-12 01:23:36 +00:00
[NodeResourceTopology](custom-resources.md#noderesourcetopology) custom resources.
nfd-topology-updater: update NodeResourceTopology objects directly Drop the gRPC communication to nfd-master and connect to the Kubernetes API server directly when updating NodeResourceTopology objects. Topology-updater already has connection to the API server for listing Pods so this is not that dramatic change. It also simplifies the code a lot as there is no need for the NFD gRPC client and no need for managing TLS certs/keys. This change aligns nfd-topology-updater with the future direction of nfd-worker where the gRPC API is being dropped and replaced by a CRD-based API. This patch also update deployment files and documentation to reflect this change.
2022-12-02 09:47:56 +00:00
It makes sure that new NodeResourceTopology instances are created for each new
nodes that get added to the cluster.
docs: restructure docs Introduce two main sections "Deployment" and "Usage" and move "Developer guide" to the top level, too. In particular, split the huge deployment-and-usage file into multiple parts under the new main sections. Move customization guide from "Advanced" to "Usage". This patch also renames "Advanced" to "Reference" as only that is left there is reference documentation.
2022-11-02 12:34:37 +00:00
docs: nfd-updater: clarify accounting Clarify that we account, and we can account, only resources exclusively allocated to Guaranteed QoS pods. Signed-off-by: Francesco Romani <fromani@redhat.com>
2023-08-31 06:41:44 +00:00
Because of the design and implementation of Kubernetes, only resources exclusively
allocated to [Guaranteed Quality of Service](https://kubernetes.io/docs/concepts/workloads/pods/pod-qos/#guaranteed)
pods will be accounted.
This includes
[CPU cores](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#static-policy),
[memory](https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policy-static)
and
[devices](https://kubernetes.io/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins/).
docs: restructure docs Introduce two main sections "Deployment" and "Usage" and move "Developer guide" to the top level, too. In particular, split the huge deployment-and-usage file into multiple parts under the new main sections. Move customization guide from "Advanced" to "Usage". This patch also renames "Advanced" to "Reference" as only that is left there is reference documentation.
2022-11-02 12:34:37 +00:00
When run as a daemonset, nodes are re-examined for the allocated resources
documentaion: document the reactive updates feature Signed-off-by: Talor Itzhak <titzhak@redhat.com>
2023-02-21 15:09:04 +00:00
(to determine the information of the allocatable resources on a per-zone basis
docs: restructure docs Introduce two main sections "Deployment" and "Usage" and move "Developer guide" to the top level, too. In particular, split the huge deployment-and-usage file into multiple parts under the new main sections. Move customization guide from "Advanced" to "Usage". This patch also renames "Advanced" to "Reference" as only that is left there is reference documentation.
2022-11-02 12:34:37 +00:00
where a zone can be a NUMA node) at an interval specified using the
docs: fix internal cross-page references by injecting .md
2023-01-12 01:23:36 +00:00
[`-sleep-interval`](../reference/topology-updater-commandline-reference.html.md#-sleep-interval)
documentaion: document the reactive updates feature Signed-off-by: Talor Itzhak <titzhak@redhat.com>
2023-02-21 15:09:04 +00:00
option. The default sleep interval is set to 60s
which is the value when no -sleep-interval is specified.
The re-examination can be disabled by setting the sleep-interval to 0.
Another option is to configure the updater to update
the allocated resources per pod life-cycle events.
The updater will monitor the checkpoint file stated in
[`-kubelet-state-dir`](../reference/topology-updater-commandline-reference.md#-kubelet-state-dir)
and triggers an update for every change occurs in the files.
docs: topology-updater: update docs for exclude-list feature Update the docs with explanations and examples about the exclude-list feature. Signed-off-by: Talor Itzhak <titzhak@redhat.com>
2022-11-09 17:25:58 +00:00
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)
docs: simplify quick-start page Move topology-updater deployment notes to the topology-updater usage page. Also, rework the plaintext and headings a bit.
2022-12-01 08:24:16 +00:00
## Deployment Notes
docs: describe supported Kubernetes versions
2023-07-21 11:36:56 +00:00
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).
docs: simplify quick-start page Move topology-updater deployment notes to the topology-updater usage page. Also, rework the plaintext and headings a bit.
2022-12-01 08:24:16 +00:00
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
docs: topology-updater: update docs for exclude-list feature Update the docs with explanations and examples about the exclude-list feature. Signed-off-by: Talor Itzhak <titzhak@redhat.com>
2022-11-09 17:25:58 +00:00
## Topology-Updater Configuration
NFD-Topology-Updater supports configuration through a configuration file. The
default location is `/etc/kubernetes/node-feature-discovery/topology-updater.conf`,
but, this can be changed by specifying the`-config` command line flag.
docs: unify formatting of NOTEs
2023-08-03 10:38:07 +00:00
docs: topology-updater: update docs for exclude-list feature Update the docs with explanations and examples about the exclude-list feature. Signed-off-by: Talor Itzhak <titzhak@redhat.com>
2022-11-09 17:25:58 +00:00
Topology-Updater configuration file is read inside the container,
and thus, Volumes and VolumeMounts are needed
to make your configuration available for NFD.
The preferred method is to use a ConfigMap
which provides easy deployment and re-configurability.
Drop dynamic run-time reconfiguration Simplify the code and reduce possible error scenarios by dropping fsnotify-based reconfiguration from nfd-master and nfd-worker. Also eliminates repeated re-configuration in scenarios where kubelet continuosly touches the (every minute) mounted file (configmap) on the filesystem. Also modifies the Helm and kustomize deployments so that nfd-master, nfd-worker and nfd-topology-updater pods are restarted on configmap updates. In kustomize, the slght downside of this is the name of the config map(s) depends on the content, so every time a user customizes the config data, the old unused configmap will be left and must be garbage-collected manually.
2024-08-19 13:11:09 +00:00
The provided deployment templates create an empty configmap
docs: topology-updater: update docs for exclude-list feature Update the docs with explanations and examples about the exclude-list feature. Signed-off-by: Talor Itzhak <titzhak@redhat.com>
2022-11-09 17:25:58 +00:00
and mount it inside the nfd-topology-updater containers.
In Helm deployments,
[Topology Updater parameters](../deployment/helm.md#topology-updater-parameters)
`toplogyUpdater.config` can be used to edit the respective configuration.
Drop dynamic run-time reconfiguration Simplify the code and reduce possible error scenarios by dropping fsnotify-based reconfiguration from nfd-master and nfd-worker. Also eliminates repeated re-configuration in scenarios where kubelet continuosly touches the (every minute) mounted file (configmap) on the filesystem. Also modifies the Helm and kustomize deployments so that nfd-master, nfd-worker and nfd-topology-updater pods are restarted on configmap updates. In kustomize, the slght downside of this is the name of the config map(s) depends on the content, so every time a user customizes the config data, the old unused configmap will be left and must be garbage-collected manually.
2024-08-19 13:11:09 +00:00
In Kustomize deployments, modify the `nfd-worker-conf` ConfigMap with a custom
overlay.
docs: topology-updater: update docs for exclude-list feature Update the docs with explanations and examples about the exclude-list feature. Signed-off-by: Talor Itzhak <titzhak@redhat.com>
2022-11-09 17:25:58 +00:00
See
[nfd-topology-updater configuration file reference](../reference/topology-updater-configuration-reference.md)
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
docs: simplify quick-start page Move topology-updater deployment notes to the topology-updater usage page. Also, rework the plaintext and headings a bit.
2022-12-01 08:24:16 +00:00
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
docs: describe supported Kubernetes versions
2023-07-21 11:36:56 +00:00
[getallocatableresources]: https://kubernetes.io/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins/#grpc-endpoint-getallocatableresources
Copy permalink