Skip to content

Commit

Permalink
docs: update to cover nfd-gc
Browse files Browse the repository at this point in the history
  • Loading branch information
marquiz committed Aug 21, 2023
1 parent 9d151c4 commit 34b5221
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 40 deletions.
12 changes: 6 additions & 6 deletions docs/get-started/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand All @@ -40,5 +40,5 @@ Default: 1h
Example:

```bash
nfd-topology-gc -gc-interval=1h
nfd-gc -gc-interval=1h
```
30 changes: 30 additions & 0 deletions docs/usage/nfd-gc.md
Original file line number Diff line number Diff line change
@@ -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.
29 changes: 0 additions & 29 deletions docs/usage/nfd-topology-gc.md

This file was deleted.

0 comments on commit 34b5221

Please sign in to comment.