feat(general): support disable healthz check

kubewharf · Mar 8, 2024 · f9ab27a · f9ab27a
1 parent d44805f
commit f9ab27a
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 3 deletions.
diff --git a/cmd/base/context.go b/cmd/base/context.go
@@ -205,7 +205,7 @@ func NewGenericContext(
 
 	// add profiling and health check http paths listening on generic endpoint
 	serveProfilingHTTP(mux)
-	c.serveHealthZHTTP(mux)
+	c.serveHealthZHTTP(mux, genericConf.EnableHealthzCheck)
 
 	return c, nil
 }
@@ -264,8 +264,14 @@ func (c *GenericContext) StartInformer(ctx context.Context) {
 }
 
 // serveHealthZHTTP is used to provide health check for current running components.
-func (c *GenericContext) serveHealthZHTTP(mux *http.ServeMux) {
+func (c *GenericContext) serveHealthZHTTP(mux *http.ServeMux, enableHealthzCheck bool) {
 	mux.HandleFunc(healthZPath, func(w http.ResponseWriter, r *http.Request) {
+		if !enableHealthzCheck {
+			w.WriteHeader(200)
+			_, _ = w.Write([]byte("healthz check is disabled"))
+			return
+		}
+
 		ok, content := c.healthChecker.CheckHealthy()
 		if ok {
 			w.WriteHeader(200)

diff --git a/cmd/base/options/generic.go b/cmd/base/options/generic.go
@@ -31,7 +31,8 @@ import (
 
 // GenericOptions holds the configurations for multi components.
 type GenericOptions struct {
-	DryRun bool
+	DryRun             bool
+	EnableHealthzCheck bool
 
 	MasterURL  string
 	KubeConfig string
@@ -53,6 +54,7 @@ type GenericOptions struct {
 func NewGenericOptions() *GenericOptions {
 	return &GenericOptions{
 		DryRun:                    false,
+		EnableHealthzCheck:        false,
 		TransformedInformerForPod: false,
 		GenericEndpoint:           ":9316",
 		qosOptions:                NewQoSOptions(),
@@ -75,6 +77,7 @@ func (o *GenericOptions) AddFlags(fss *cliflag.NamedFlagSets) {
 	})
 
 	fs.BoolVar(&o.DryRun, "dry-run", o.DryRun, "A bool to enable and disable dry-run.")
+	fs.BoolVar(&o.EnableHealthzCheck, "enable-healthz-check", o.EnableHealthzCheck, "A bool to enable and disable healthz check.")
 
 	fs.BoolVar(&o.TransformedInformerForPod, "transformed-informer-pod", o.TransformedInformerForPod,
 		"whether we should enable the ability of transformed informer for pods")
@@ -100,6 +103,7 @@ func (o *GenericOptions) AddFlags(fss *cliflag.NamedFlagSets) {
 // ApplyTo fills up config with options
 func (o *GenericOptions) ApplyTo(c *generic.GenericConfiguration) error {
 	c.DryRun = o.DryRun
+	c.EnableHealthzCheck = o.EnableHealthzCheck
 
 	c.TransformedInformerForPod = o.TransformedInformerForPod
 

diff --git a/pkg/config/generic/generic_base.go b/pkg/config/generic/generic_base.go
@@ -25,6 +25,8 @@ import (
 type GenericConfiguration struct {
 	DryRun bool
 
+	EnableHealthzCheck bool
+
 	// for some cases, we may need to enable the ability of transformed informer
 	TransformedInformerForPod bool