Merge pull request #1992 from Icarus9913/config-comments

📖 add comments for configuration

Author: k8s-ci-robot

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"`
 

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"