Merge pull request #505 from vasac/startup-probes

Add support for Startup Probes

Author: thegridman

api/v1/coherenceresourcespec_types.go

@@ -184,6 +184,14 @@ type CoherenceResourceSpec struct {
 	// ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/
 	// +optional
 	LivenessProbe *ReadinessProbeSpec `json:"livenessProbe,omitempty"`
+	// The startup probe config to be used for the Pods in this deployment.
+	// See: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
+	// +optional
+	StartupProbe *ReadinessProbeSpec `json:"startupProbe,omitempty"`
+	// ReadinessGates defines a list of additional conditions that the kubelet evaluates for Pod readiness.
+	// See: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-readiness-gate
+	// +optional
+	ReadinessGates []corev1.PodReadinessGate `json:"readinessGates,omitempty"`
 	// Resources is the optional resource requests and limits for the containers
 	//  ref: http://kubernetes.io/docs/user-guide/compute-resources/
 	//
@@ -664,6 +672,7 @@ func (in *CoherenceResourceSpec) CreateStatefulSet(deployment *Coherence) Resour
 				Tolerations:                  in.Tolerations,
 				Affinity:                     in.EnsurePodAffinity(deployment),
 				NodeSelector:                 in.NodeSelector,
+				ReadinessGates:               in.ReadinessGates,
 				InitContainers: []corev1.Container{
 					in.CreateUtilsContainer(deployment),
 				},
@@ -783,6 +792,11 @@ func (in *CoherenceResourceSpec) CreateCoherenceContainer(deployment *Coherence)
 	c.LivenessProbe = in.CreateDefaultLivenessProbe()
 	in.LivenessProbe.UpdateProbeSpec(healthPort, DefaultLivenessPath, c.LivenessProbe)
 
+	if in.StartupProbe != nil {
+		c.StartupProbe = in.CreateDefaultLivenessProbe()
+		in.StartupProbe.UpdateProbeSpec(healthPort, DefaultLivenessPath, c.StartupProbe)
+	}
+
 	return c
 }
 

api/v1/create_statefulset_probes_test.go

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020, Oracle and/or its affiliates.
+ * Copyright (c) 2020, 2021 Oracle and/or its affiliates.
  * Licensed under the Universal Permissive License v 1.0 as shown at
  * http://oss.oracle.com/licenses/upl.
  */
@@ -380,3 +380,204 @@ func TestCreateStatefulSetWithLivenessProbeSpecWithExec(t *testing.T) {
 	// assert that the StatefulSet is as expected
 	assertStatefulSetCreation(t, deployment, stsExpected)
 }
+
+func TestCreateStatefulSetWithNilStartupProbeSpec(t *testing.T) {
+
+	spec := coh.CoherenceResourceSpec{
+		StartupProbe: nil,
+	}
+
+	// Create the test deployment
+	deployment := createTestDeployment(spec)
+
+	// Create expected StatefulSet
+	stsExpected := createMinimalExpectedStatefulSet(deployment)
+
+	// assert that the StatefulSet is as expected
+	assertStatefulSetCreation(t, deployment, stsExpected)
+}
+
+func TestCreateStatefulSetWithEmptyStartupProbeSpec(t *testing.T) {
+
+	probe := coh.ReadinessProbeSpec{}
+
+	spec := coh.CoherenceResourceSpec{
+		StartupProbe: &probe,
+	}
+
+	// Create the test deployment
+	deployment := createTestDeployment(spec)
+
+	// Create expected probe
+	probeExpected := spec.UpdateDefaultLivenessProbeAction(spec.CreateDefaultLivenessProbe())
+
+	// Create expected StatefulSet
+	stsExpected := createMinimalExpectedStatefulSet(deployment)
+	stsExpected.Spec.Template.Spec.Containers[0].StartupProbe = probeExpected
+
+	// assert that the StatefulSet is as expected
+	assertStatefulSetCreation(t, deployment, stsExpected)
+}
+
+func TestCreateStatefulSetWithStartupProbeSpec(t *testing.T) {
+
+	probe := coh.ReadinessProbeSpec{
+		InitialDelaySeconds: int32Ptr(10),
+		TimeoutSeconds:      int32Ptr(20),
+		PeriodSeconds:       int32Ptr(30),
+		SuccessThreshold:    int32Ptr(40),
+		FailureThreshold:    int32Ptr(50),
+	}
+
+	spec := coh.CoherenceResourceSpec{
+		StartupProbe: &probe,
+	}
+
+	// Create the test deployment
+	deployment := createTestDeployment(spec)
+	// Create expected StatefulSet
+	stsExpected := createMinimalExpectedStatefulSet(deployment)
+	stsExpected.Spec.Template.Spec.Containers[0].StartupProbe = &corev1.Probe{
+		Handler: corev1.Handler{
+			Exec: nil,
+			HTTPGet: &corev1.HTTPGetAction{
+				Path:   coh.DefaultLivenessPath,
+				Port:   intstr.FromInt(int(coh.DefaultHealthPort)),
+				Scheme: "HTTP",
+			},
+			TCPSocket: nil,
+		},
+		InitialDelaySeconds: 10,
+		TimeoutSeconds:      20,
+		PeriodSeconds:       30,
+		SuccessThreshold:    40,
+		FailureThreshold:    50,
+	}
+
+	// assert that the StatefulSet is as expected
+	assertStatefulSetCreation(t, deployment, stsExpected)
+}
+
+func TestCreateStatefulSetWithStartupProbeSpecWithHttpGet(t *testing.T) {
+
+	handler := &corev1.HTTPGetAction{
+		Path: "/test/ready",
+		Port: intstr.FromInt(1234),
+	}
+
+	probe := coh.ReadinessProbeSpec{
+		ProbeHandler: coh.ProbeHandler{
+			Exec:      nil,
+			HTTPGet:   handler,
+			TCPSocket: nil,
+		},
+		InitialDelaySeconds: int32Ptr(10),
+		TimeoutSeconds:      int32Ptr(20),
+		PeriodSeconds:       int32Ptr(30),
+		SuccessThreshold:    int32Ptr(40),
+		FailureThreshold:    int32Ptr(50),
+	}
+
+	spec := coh.CoherenceResourceSpec{
+		StartupProbe: &probe,
+	}
+
+	// Create the test deployment
+	deployment := createTestDeployment(spec)
+	// Create expected StatefulSet
+	stsExpected := createMinimalExpectedStatefulSet(deployment)
+	stsExpected.Spec.Template.Spec.Containers[0].StartupProbe = &corev1.Probe{
+		Handler: corev1.Handler{
+			HTTPGet: handler,
+		},
+		InitialDelaySeconds: 10,
+		TimeoutSeconds:      20,
+		PeriodSeconds:       30,
+		SuccessThreshold:    40,
+		FailureThreshold:    50,
+	}
+
+	// assert that the StatefulSet is as expected
+	assertStatefulSetCreation(t, deployment, stsExpected)
+}
+
+func TestCreateStatefulSetWithStartupProbeSpecWithTCPSocket(t *testing.T) {
+
+	handler := &corev1.TCPSocketAction{
+		Port: intstr.FromInt(1234),
+		Host: "foo.com",
+	}
+
+	probe := coh.ReadinessProbeSpec{
+		ProbeHandler: coh.ProbeHandler{
+			TCPSocket: handler,
+		},
+		InitialDelaySeconds: int32Ptr(10),
+		TimeoutSeconds:      int32Ptr(20),
+		PeriodSeconds:       int32Ptr(30),
+		SuccessThreshold:    int32Ptr(40),
+		FailureThreshold:    int32Ptr(50),
+	}
+
+	spec := coh.CoherenceResourceSpec{
+		StartupProbe: &probe,
+	}
+
+	// Create the test deployment
+	deployment := createTestDeployment(spec)
+	// Create expected StatefulSet
+	stsExpected := createMinimalExpectedStatefulSet(deployment)
+	stsExpected.Spec.Template.Spec.Containers[0].StartupProbe = &corev1.Probe{
+		Handler: corev1.Handler{
+			TCPSocket: handler,
+		},
+		InitialDelaySeconds: 10,
+		TimeoutSeconds:      20,
+		PeriodSeconds:       30,
+		SuccessThreshold:    40,
+		FailureThreshold:    50,
+	}
+
+	// assert that the StatefulSet is as expected
+	assertStatefulSetCreation(t, deployment, stsExpected)
+}
+
+func TestCreateStatefulSetWithStartupProbeSpecWithExec(t *testing.T) {
+
+	handler := &corev1.ExecAction{
+		Command: []string{"exec", "something"},
+	}
+
+	probe := coh.ReadinessProbeSpec{
+		ProbeHandler: coh.ProbeHandler{
+			Exec: handler,
+		},
+		InitialDelaySeconds: int32Ptr(10),
+		TimeoutSeconds:      int32Ptr(20),
+		PeriodSeconds:       int32Ptr(30),
+		SuccessThreshold:    int32Ptr(40),
+		FailureThreshold:    int32Ptr(50),
+	}
+
+	spec := coh.CoherenceResourceSpec{
+		StartupProbe: &probe,
+	}
+
+	// Create the test deployment
+	deployment := createTestDeployment(spec)
+	// Create expected StatefulSet
+	stsExpected := createMinimalExpectedStatefulSet(deployment)
+	stsExpected.Spec.Template.Spec.Containers[0].StartupProbe = &corev1.Probe{
+		Handler: corev1.Handler{
+			Exec: handler,
+		},
+		InitialDelaySeconds: 10,
+		TimeoutSeconds:      20,
+		PeriodSeconds:       30,
+		SuccessThreshold:    40,
+		FailureThreshold:    50,
+	}
+
+	// assert that the StatefulSet is as expected
+	assertStatefulSetCreation(t, deployment, stsExpected)
+}