topology-updater: document the -no-publish flag correctly

kubernetes-sigs · Jan 22, 2024 · d7ec0bf · d7ec0bf
1 parent d80e4f7
commit d7ec0bf
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/cmd/nfd-topology-updater/main.go b/cmd/nfd-topology-updater/main.go
@@ -102,7 +102,7 @@ func initFlags(flagset *flag.FlagSet) (*topology.Args, *resourcemonitor.Args) {
 	flagset.BoolVar(&args.Oneshot, "oneshot", false,
 		"Update once and exit")
 	flagset.BoolVar(&args.NoPublish, "no-publish", false,
-		"Do not publish discovered features to the cluster-local Kubernetes API server.")
+		"Do not create or update NodeResourceTopology objects.")
 	flagset.StringVar(&args.KubeConfigFile, "kubeconfig", "",
 		"Kube config file.")
 	flagset.IntVar(&args.MetricsPort, "metrics", 8081,

diff --git a/docs/reference/topology-updater-commandline-reference.md b/docs/reference/topology-updater-commandline-reference.md
@@ -46,10 +46,10 @@ nfd-topology-updater -config=/opt/nfd/nfd-topology-updater.conf
 
 ### -no-publish
 
-The `-no-publish` flag disables all communication with the nfd-master, making
-it a "dry-run" flag for nfd-topology-updater. NFD-Topology-Updater runs
-resource hardware topology detection normally, but no CR requests are sent to
-nfd-master.
+The `-no-publish` flag makes for a "dry-run" flag for nfd-topology-updater.
+NFD-Topology-Updater runs resource hardware topology detection normally, but
+[NodeResourceTopology](../usage/custom-resources.md#noderesourcetopology)
+objects are not created or updated.
 
 Default: *false*