Skip to content

Commit 42b1251

Browse files
authored
Merge pull request #1555 from marquiz/devel/topology-updater-no-publish-docs
topology-updater: document the -no-publish flag correctly
2 parents 9be4f04 + d7ec0bf commit 42b1251

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

cmd/nfd-topology-updater/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ func initFlags(flagset *flag.FlagSet) (*topology.Args, *resourcemonitor.Args) {
102102
flagset.BoolVar(&args.Oneshot, "oneshot", false,
103103
"Update once and exit")
104104
flagset.BoolVar(&args.NoPublish, "no-publish", false,
105-
"Do not publish discovered features to the cluster-local Kubernetes API server.")
105+
"Do not create or update NodeResourceTopology objects.")
106106
flagset.StringVar(&args.KubeConfigFile, "kubeconfig", "",
107107
"Kube config file.")
108108
flagset.IntVar(&args.MetricsPort, "metrics", 8081,

docs/reference/topology-updater-commandline-reference.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ nfd-topology-updater -config=/opt/nfd/nfd-topology-updater.conf
4646

4747
### -no-publish
4848

49-
The `-no-publish` flag disables all communication with the nfd-master, making
50-
it a "dry-run" flag for nfd-topology-updater. NFD-Topology-Updater runs
51-
resource hardware topology detection normally, but no CR requests are sent to
52-
nfd-master.
49+
The `-no-publish` flag makes for a "dry-run" flag for nfd-topology-updater.
50+
NFD-Topology-Updater runs resource hardware topology detection normally, but
51+
[NodeResourceTopology](../usage/custom-resources.md#noderesourcetopology)
52+
objects are not created or updated.
5353

5454
Default: *false*
5555

0 commit comments

Comments
 (0)