Merge pull request #1992 from Icarus9913/config-comments

📖 add comments for configuration
kubernetes-sigs · Sep 7, 2022 · c83076e · c83076e
2 parents 15b6689 + 101a413
commit c83076e
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/pkg/config/v1alpha1/types.go b/pkg/config/v1alpha1/types.go
@@ -109,6 +109,7 @@ type ControllerMetrics struct {
 type ControllerHealth struct {
 	// HealthProbeBindAddress is the TCP address that the controller should bind to
 	// for serving health probes
+	// It can be set to "0" or "" to disable serving the health probe.
 	// +optional
 	HealthProbeBindAddress string `json:"healthProbeBindAddress,omitempty"`
 

diff --git a/pkg/manager/manager.go b/pkg/manager/manager.go
@@ -219,6 +219,7 @@ type Options struct {
 
 	// HealthProbeBindAddress is the TCP address that the controller should bind to
 	// for serving health probes
+	// It can be set to "0" or "" to disable serving the health probe.
 	HealthProbeBindAddress string
 
 	// Readiness probe endpoint name, defaults to "readyz"