1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2024-12-14 11:57:51 +00:00

docs: update to cover nfd-gc

This commit is contained in:
Markus Lehtonen 2023-08-18 14:38:13 +03:00
parent ceb672bde0
commit a15b5690b6
4 changed files with 41 additions and 40 deletions

View file

@ -26,7 +26,7 @@ NFD consists of four software components:
1. nfd-master
1. nfd-worker
1. nfd-topology-updater
1. nfd-topology-gc
1. nfd-gc
## NFD-Master
@ -50,13 +50,13 @@ creates or updates a
resource object specific to this node. One instance of nfd-topology-updater is
supposed to be running on each node of the cluster.
## NFD-Topology-GC
## NFD-GC
NFD-Topology-GC is a daemon responsible for cleaning obsolete
[NodeResourceTopology](../usage/custom-resources.md#noderesourcetopology) objects,
obsolete means that there is no corresponding worker node.
NFD-GC is a daemon responsible for cleaning obsolete
[NodeFeature](../usage/custom-resources.md#nodefeature) and
[NodeResourceTopology](../usage/custom-resources.md#noderesourcetopology) objects.
One instance of nfd-topology-gc is supposed to be running in the cluster.
One instance of nfd-gc is supposed to be running in the cluster.
## Feature Discovery

View file

@ -1,10 +1,10 @@
---
title: "Topology Garbage Collector Cmdline Reference"
title: "Garbage Collector Cmdline Reference"
layout: default
sort: 7
---
# NFD-Topology-Garbage-Collector Commandline Flags
# NFD-GC Commandline Flags
{: .no_toc }
## Table of Contents
@ -15,12 +15,12 @@ sort: 7
---
To quickly view available command line flags execute `nfd-topology-gc -help`.
To quickly view available command line flags execute `nfd-gc -help`.
In a docker container:
```bash
docker run {{ site.container_image }} \
nfd-topology-gc -help
nfd-gc -help
```
### -h, -help
@ -40,5 +40,5 @@ Default: 1h
Example:
```bash
nfd-topology-gc -gc-interval=1h
nfd-gc -gc-interval=1h
```

30
docs/usage/nfd-gc.md Normal file
View file

@ -0,0 +1,30 @@
---
title: "NFD-Garbage-Collector"
layout: default
sort: 6
---
# NFD-GC
{: .no_toc}
---
NFD-GC (NFD Garbage-Collector) is preferably run as a Kubernetes deployment
with one replica. It makes sure that all
[NodeFeature](custom-resources.md#nodefeature) and
[NodeResourceTopology](custom-resources.md#noderesourcetopology) objects
have corresponding nodes and removes stale objects for non-existent nodes.
The daemon watches for Node deletion events and removes NodeFeature and
NodeResourceTopology objects upon them. It also runs periodically to make sure
no node delete event was missed and to remove any NodeFeature or
NodeResourceTopology objects that were created without corresponding node. The
default garbage collector interval is set to 1h which is the value when no
-gc-interval is specified.
## Configuration
In Helm deployments (see
[garbage collector parameters](../deployment/helm.md#garbage-collector-parameters))
NFD-GC will only be deployed when `enableNodeFeatureApi` or
`topologyUpdater.enable` is set to true.

View file

@ -1,29 +0,0 @@
---
title: "NFD-Topology-Garbage-Collector"
layout: default
sort: 6
---
# NFD-Topology-Garbage-Collector
{: .no_toc}
---
NFD-Topology-Garbage-Collector is preferably run as a Kubernetes deployment
with one replica. It makes sure that all
[NodeResourceTopology](custom-resources.md#noderesourcetopology)
have corresponding worker nodes and removes stale objects for worker nodes
which are no longer part of Kubernetes cluster.
This service watches for Node deletion events and removes NodeResourceTopology
objects upon them. It is also running periodically to make sure no event was
missed or NodeResourceTopology object was created without corresponding worker
node. The default garbage collector interval is set to 1h which is the value
when no -gc-interval is specified.
## Topology-Garbage-Collector Configuration
In Helm deployments,
(see [Topology Garbage Collector](../deployment/helm.md#topology-garbage-collector-parameters)
for parameters). NFD-Topology-Garbage-Collector will only be deployed when
topologyUpdater.enable is set to true.