Merge pull request #13 from cert-manager/healthz-to-readyz

Change healthz to readyz for readiness probe

Author: JoshVanL

cmd/app/app.go

@@ -31,14 +31,14 @@ func NewCommand(ctx context.Context) *cobra.Command {
 				return err
 			}
 
-			healthz := healthz.New(opts.Logr, opts.HealthzPort, opts.HealthzPath)
-			if err := healthz.Start(ctx); err != nil {
+			readyz := healthz.New(opts.Logr, opts.ReadyzPort, opts.ReadyzPath)
+			if err := readyz.Start(ctx); err != nil {
 				return err
 			}
 
 			// Create a new TLS provider for the serving certificate and private key.
 			tlsProvider, err := agenttls.NewProvider(ctx, opts.Logr, opts.TLSOptions,
-				opts.KubeOptions, opts.CertManagerOptions, healthz.Register())
+				opts.KubeOptions, opts.CertManagerOptions, readyz.Register())
 			if err != nil {
 				return err
 			}
@@ -52,7 +52,7 @@ func NewCommand(ctx context.Context) *cobra.Command {
 			// Create an new server instance that implements the certificate signing API
 			server := server.New(opts.Logr,
 				opts.CertManagerOptions, opts.KubeOptions,
-				healthz.Register())
+				readyz.Register())
 
 			// Build the data which should be present in the well-known configmap in
 			// all namespaces.

cmd/app/options/options.go

@@ -34,8 +34,8 @@ type AppOptions struct {
 	logLevel string
 	Logr     *logrus.Entry
 
-	HealthzPort int
-	HealthzPath string
+	ReadyzPort int
+	ReadyzPath string
 }
 
 type CertManagerOptions struct {
@@ -151,12 +151,12 @@ func (a *AppOptions) addFlags(fs *pflag.FlagSet) {
 		"log-level", "v", "info",
 		"Log level (debug, info, warn, error, fatal, panic).")
 
-	fs.IntVar(&a.HealthzPort,
-		"healthz-port", 8080,
+	fs.IntVar(&a.ReadyzPort,
+		"readiness-probe-port", 8080,
 		"Port to expose the readiness probe.")
 
-	fs.StringVar(&a.HealthzPath,
-		"healthz-path", "/healthz",
+	fs.StringVar(&a.ReadyzPath,
+		"readiness-probe-path", "/readyz",
 		"HTTP path to expose the readiness probe server.")
 }
 

deploy/charts/istio-csr/templates/deployment.yaml

@@ -30,8 +30,8 @@ spec:
         command: ["cert-manager-istio-agent"]
         args:
           - "--log-level={{.Values.agent.logLevel}}"
-          - "--healthz-port={{.Values.agent.readinessProbe.port}}"
-          - "--healthz-path={{.Values.agent.readinessProbe.path}}"
+          - "--readiness-probe-port={{.Values.agent.readinessProbe.port}}"
+          - "--readiness-probe-path={{.Values.agent.readinessProbe.path}}"
 
           - "--serving-address={{.Values.agent.servingAddress}}:{{.Values.agent.servingPort}}"
           - "--serving-certificate-duration={{.Values.agent.certificateDuration}}"

deploy/charts/istio-csr/values.yaml

@@ -17,7 +17,7 @@ agent:
   logLevel: info # debug, info, warn, error, fatal, panic
   readinessProbe:
     port: 8080
-    path: "/healthz"
+    path: "/readyz"
 
   servingAddress: 0.0.0.0
   servingPort: 6443

pkg/server/server.go

@@ -40,13 +40,13 @@ type Server struct {
 	issuerRef   cmmeta.ObjectReference
 	preserveCRs bool
 
-	healthz *healthz.Check
+	readyz *healthz.Check
 }
 
 func New(log *logrus.Entry,
 	cmOptions *options.CertManagerOptions,
 	kubeOptions *options.KubeOptions,
-	healthz *healthz.Check,
+	readyz *healthz.Check,
 ) *Server {
 	return &Server{
 		log:         log.WithField("module", "certificate_provider"),
@@ -55,7 +55,7 @@ func New(log *logrus.Entry,
 		maxDuration: cmOptions.MaximumClientCertificateDuration,
 		issuerRef:   cmOptions.IssuerRef,
 		preserveCRs: cmOptions.PreserveCRs,
-		healthz:     healthz,
+		readyz:      readyz,
 	}
 }
 
@@ -77,14 +77,14 @@ func (s *Server) Run(ctx context.Context, tlsConfig *tls.Config, listenAddress s
 	// handle termination gracefully
 	go func() {
 		<-ctx.Done()
-		s.healthz.Set(false)
+		s.readyz.Set(false)
 		s.log.Info("shutting down grpc server")
 		grpcServer.GracefulStop()
 		s.log.Info("grpc server stopped")
 	}()
 
 	s.log.Infof("grpc serving on %s", listener.Addr())
-	s.healthz.Set(true)
+	s.readyz.Set(true)
 
 	return grpcServer.Serve(listener)
 }

pkg/tls/tls.go

@@ -41,14 +41,14 @@ type Provider struct {
 	issuerRef cmmeta.ObjectReference
 
 	mu        sync.RWMutex
-	healthz   *healthz.Check
+	readyz    *healthz.Check
 	tlsConfig *tls.Config
 }
 
 // NewProvider will return a new provider where a TLS config is ready to be fetched.
 func NewProvider(ctx context.Context, log *logrus.Entry, tlsOptions *options.TLSOptions,
 	kubeOptions *options.KubeOptions, cmOptions *options.CertManagerOptions,
-	healthz *healthz.Check) (*Provider, error) {
+	readyz *healthz.Check) (*Provider, error) {
 
 	p := &Provider{
 		log:                   log.WithField("module", "serving_certificate"),
@@ -57,7 +57,7 @@ func NewProvider(ctx context.Context, log *logrus.Entry, tlsOptions *options.TLS
 		customRootCA:          len(tlsOptions.RootCACertFile) > 0,
 		client:                kubeOptions.CMClient,
 		issuerRef:             cmOptions.IssuerRef,
-		healthz:               healthz,
+		readyz:                readyz,
 	}
 
 	if len(tlsOptions.RootCACertFile) > 0 {
@@ -86,7 +86,7 @@ func NewProvider(ctx context.Context, log *logrus.Entry, tlsOptions *options.TLS
 
 			select {
 			case <-ctx.Done():
-				p.healthz.Set(false)
+				p.readyz.Set(false)
 				p.log.Infof("closing renewal: %s", ctx.Err())
 				timer.Stop()
 				return
@@ -101,7 +101,7 @@ func NewProvider(ctx context.Context, log *logrus.Entry, tlsOptions *options.TLS
 		}
 	}()
 
-	p.healthz.Set(true)
+	p.readyz.Set(true)
 
 	return p, nil
 }