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: describe nfd-topology-gc in introduction.md #1062

Merged
merged 1 commit into from
Feb 21, 2023
Merged

docs: describe nfd-topology-gc in introduction.md #1062

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
7 changes: 4 additions & 3 deletions docs/get-started/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,12 @@ This software enables node feature discovery for Kubernetes. It detects
hardware features available on each node in a Kubernetes cluster, and
advertises those features using node labels and optionally node taints.

NFD consists of three software components:
NFD consists of four software components:

1. nfd-master
1. nfd-worker
1. nfd-topology-updater
1. nfd-topology-gc
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also adjust the NFD consists of three software components: text above

Also, add a new sub-section for "NFD-Topology-GC". Just a one sentence description is enough for now


## NFD-Master

Expand All @@ -47,9 +48,9 @@ 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-Garbage-Collector
## NFD-Topology-GC

NFD-Topology-Garbage-Collector is a daemon responsible for cleaning obsolete
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.

Expand Down