Apply suggestions from code review

Co-authored-by: Markus Lehtonen <markus.lehtonen@intel.com>
kubernetes-sigs · Sep 6, 2023 · 06fb81a · 06fb81a
1 parent b5bcafe
commit 06fb81a
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 9 deletions.
diff --git a/cmd/nfd-master/main.go b/cmd/nfd-master/main.go
@@ -118,7 +118,7 @@ func initFlags(flagset *flag.FlagSet) (*master.Args, *master.ConfigOverrideArgs)
 		"Kubeconfig to use")
 	flagset.BoolVar(&args.EnableNodeFeatureApi, "enable-nodefeature-api", true,
 		"Enable the NodeFeature CRD API for receiving node features. This will automatically disable the gRPC communication."+
-			"DEPRECATED: will be removed in a future release.")
+			"DEPRECATED: will be removed in a future release along with the deprecated gRPC API")
 	flagset.BoolVar(&args.CrdController, "featurerules-controller", true,
 		"Enable NFD CRD API controller. DEPRECATED: use -crd-controller instead")
 	flagset.BoolVar(&args.CrdController, "crd-controller", true,

diff --git a/cmd/nfd-worker/main.go b/cmd/nfd-worker/main.go
@@ -105,7 +105,7 @@ func initFlags(flagset *flag.FlagSet) (*worker.Args, *worker.ConfigOverrideArgs)
 		"Private key matching -cert-file")
 	flagset.BoolVar(&args.EnableNodeFeatureApi, "enable-nodefeature-api", true,
 		"Enable the NodeFeature CRD API for communicating with nfd-master. This will automatically disable the gRPC communication."+
-			"DEPRECATED: will be removed in a future release.")
+			"DEPRECATED: will be removed in a future release along with the deprecated gRPC API")
 	flagset.StringVar(&args.Kubeconfig, "kubeconfig", "",
 		"Kubeconfig to use")
 	flagset.BoolVar(&args.Oneshot, "oneshot", false,

diff --git a/docs/developer-guide/index.md b/docs/developer-guide/index.md
@@ -167,7 +167,7 @@ make e2e-test KUBECONFIG=$HOME/.kube/config
 ## Running locally
 
 > ****DEPRECATED**: Running NFD locally is deprecated and will be removed in a
-> future release. It depends on the GRPC API which is deprecated and will be
+> future release. It depends on the gRPC API which is deprecated and will be
 > removed in a future release. To run NFD locally, use the
 > `-enable-nodefeature-api=false` flag.
 
@@ -179,7 +179,7 @@ features-detection.
 
 When running as a standalone container labeling is expected to fail because
 Kubernetes API is not available. Thus, it is recommended to use `-no-publish`
-and `-crd-controller=false` command line flag. E.g.
+Also specify `-crd-controller=false` and `-enable-nodefeature-api=false` command line flags to disable CRD controller and enable gRPC. E.g.
 
 ```bash
 $ export NFD_CONTAINER_IMAGE={{ site.container_image }}

diff --git a/docs/reference/master-commandline-reference.md b/docs/reference/master-commandline-reference.md
@@ -153,7 +153,7 @@ nfd-master -verify-node-name -ca-file=/opt/nfd/ca.crt \
 
 ### -enable-nodefeature-api
 
-> **NOTE** the GRPC API is deprecated and will be removed in a future release.
+> **NOTE** the gRPC API is deprecated and will be removed in a future release.
 > and this flag will be removed as well.
 
 The `-enable-nodefeature-api` flag enables/disables the

diff --git a/docs/reference/worker-commandline-reference.md b/docs/reference/worker-commandline-reference.md
@@ -197,7 +197,7 @@ nfd-worker -label-sources=kernel,system,local
 
 ### -enable-nodefeature-api
 
-> **NOTE** the GRPC API is deprecated and will be removed in a future release.
+> **NOTE** the gRPC API is deprecated and will be removed in a future release.
 > and this flag will be removed as well.
 
 The `-enable-nodefeature-api` flag enables/disables the

diff --git a/docs/usage/customization-guide.md b/docs/usage/customization-guide.md
@@ -43,8 +43,7 @@ create and manipulate NodeFeature objects in their namespace.
 The NodeFeature CRD API can be disabled with the
 `-enable-nodefeature-api=false` command line flag. This flag must be specified
 for both nfd-master and nfd-worker as it will enable the gRPC communication
-between them. Note that this feature is **DEPRECATED** and will be removed in a
-future release.
+between them. Note that the gRPC API is **DEPRECATED** and will be removed in a future release, at which point the NodeFeature API cannot be disabled.
 
 ### A NodeFeature example
 

diff --git a/docs/usage/nfd-master.md b/docs/usage/nfd-master.md
@@ -30,7 +30,7 @@ and creates node labels accordingly. The feature data used as the input is
 received from nfd-worker instances through
 [NodeFeature](custom-resources.md#nodefeature-custom-resource) objects.
 
-> ****DEPRECATED**: when gRPC is used for communicating the features (by
+> **NOTE**: when gRPC (**DEPRECATED**) is used for communicating the features (by
 > setting the flag `-enable-nodefeature-api=false` on both nfd-master and
 > nfd-worker, or via Helm values.enableNodeFeatureApi=false),(re-)labelling
 > only happens when a request is received from nfd-worker. That is, in practice