From d7ec0bf6743ee5e223ccf410f2e4fff08dca569f Mon Sep 17 00:00:00 2001 From: Markus Lehtonen Date: Mon, 22 Jan 2024 14:21:02 +0200 Subject: [PATCH] topology-updater: document the -no-publish flag correctly --- cmd/nfd-topology-updater/main.go | 2 +- docs/reference/topology-updater-commandline-reference.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/cmd/nfd-topology-updater/main.go b/cmd/nfd-topology-updater/main.go index 16e4318777..d35acc99d2 100644 --- 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 index 3fed551522..14500a4f93 100644 --- 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*