[Development][Add] Added custom probe capability (#178)

iamabhishek-dubey · web-flow · commit e0892b4691f8 · 2021-11-30T13:13:25.000+05:30
* Added probe feature in redis operator

Signed-off-by: iamabhishek-dubey &lt;abhishekbhardwaj510@gmail.com&gt;

* Added examples for probes

Signed-off-by: iamabhishek-dubey &lt;abhishekbhardwaj510@gmail.com&gt;
diff --git a/api/v1beta1/redis_types.go b/api/v1beta1/redis_types.go
@@ -35,6 +35,8 @@ type RedisSpec struct {
 	PriorityClassName string                     `json:"priorityClassName,omitempty"`
 	Affinity          *corev1.Affinity           `json:"affinity,omitempty"`
 	Tolerations       *[]corev1.Toleration       `json:"tolerations,omitempty"`
+	ReadinessProbe    *corev1.Probe              `json:"readinessProbe,omitempty" protobuf:"bytes,11,opt,name=readinessProbe"`
+	LivenessProbe     *corev1.Probe              `json:"livenessProbe,omitempty" protobuf:"bytes,11,opt,name=livenessProbe"`
 }
 
 // RedisStatus defines the observed state of Redis
diff --git a/api/v1beta1/rediscluster_types.go b/api/v1beta1/rediscluster_types.go
@@ -40,16 +40,20 @@ type RedisClusterSpec struct {
 // RedisLeader interface will have the redis leader configuration
 type RedisLeader struct {
 	// +kubebuilder:validation:Minimum=3
-	Replicas    *int32           `json:"replicas,omitempty"`
-	RedisConfig *RedisConfig     `json:"redisConfig,omitempty"`
-	Affinity    *corev1.Affinity `json:"affinity,omitempty"`
+	Replicas       *int32           `json:"replicas,omitempty"`
+	RedisConfig    *RedisConfig     `json:"redisConfig,omitempty"`
+	Affinity       *corev1.Affinity `json:"affinity,omitempty"`
+	ReadinessProbe *corev1.Probe    `json:"readinessProbe,omitempty" protobuf:"bytes,11,opt,name=readinessProbe"`
+	LivenessProbe  *corev1.Probe    `json:"livenessProbe,omitempty" protobuf:"bytes,11,opt,name=livenessProbe"`
 }
 
 // RedisFollower interface will have the redis follower configuration
 type RedisFollower struct {
-	Replicas    *int32           `json:"replicas,omitempty"`
-	RedisConfig *RedisConfig     `json:"redisConfig,omitempty"`
-	Affinity    *corev1.Affinity `json:"affinity,omitempty"`
+	Replicas       *int32           `json:"replicas,omitempty"`
+	RedisConfig    *RedisConfig     `json:"redisConfig,omitempty"`
+	Affinity       *corev1.Affinity `json:"affinity,omitempty"`
+	ReadinessProbe *corev1.Probe    `json:"readinessProbe,omitempty" protobuf:"bytes,11,opt,name=readinessProbe"`
+	LivenessProbe  *corev1.Probe    `json:"livenessProbe,omitempty" protobuf:"bytes,11,opt,name=livenessProbe"`
 }
 
 // RedisClusterStatus defines the observed state of RedisCluster
diff --git a/api/v1beta1/zz_generated.deepcopy.go b/api/v1beta1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/redis.redis.opstreelabs.in_redis.yaml b/config/crd/bases/redis.redis.opstreelabs.in_redis.yaml
diff --git a/config/crd/bases/redis.redis.opstreelabs.in_redisclusters.yaml b/config/crd/bases/redis.redis.opstreelabs.in_redisclusters.yaml
diff --git a/config/rbac/role.yaml b/config/rbac/role.yaml
@@ -40,6 +40,7 @@ rules:
   resources:
   - secrets
   - pods/exec
+  - pods
   - services
   - configmaps
   verbs:
diff --git a/example/probes/cluster.yaml b/example/probes/cluster.yaml
@@ -0,0 +1,70 @@
+---
+apiVersion: redis.redis.opstreelabs.in/v1beta1
+kind: RedisCluster
+metadata:
+  name: redis-cluster
+spec:
+  clusterSize: 3
+  kubernetesConfig:
+    image: quay.io/opstree/redis:v6.2.5
+    imagePullPolicy: IfNotPresent
+    resources:
+      requests:
+        cpu: 101m
+        memory: 128Mi
+      limits:
+        cpu: 101m
+        memory: 128Mi
+  redisExporter:
+    enabled: false
+    image: quay.io/opstree/redis-exporter:1.0
+  redisLeader:
+    readinessProbe:
+      exec:
+        command:
+        - bash
+        - /usr/bin/healthcheck.sh
+      failureThreshold: 5
+      initialDelaySeconds: 15
+      periodSeconds: 15
+      successThreshold: 1
+      timeoutSeconds: 5
+    livenessProbe:
+      exec:
+        command:
+        - bash
+        - /usr/bin/healthcheck.sh
+      failureThreshold: 5
+      initialDelaySeconds: 15
+      periodSeconds: 15
+      successThreshold: 1
+      timeoutSeconds: 5
+  redisFollower:
+    readinessProbe:
+      exec:
+        command:
+        - bash
+        - /usr/bin/healthcheck.sh
+      failureThreshold: 5
+      initialDelaySeconds: 15
+      periodSeconds: 15
+      successThreshold: 1
+      timeoutSeconds: 5
+    livenessProbe:
+      exec:
+        command:
+        - bash
+        - /usr/bin/healthcheck.sh
+      failureThreshold: 5
+      initialDelaySeconds: 15
+      periodSeconds: 15
+      successThreshold: 1
+      timeoutSeconds: 5
+  storage:
+    volumeClaimTemplate:
+      spec:
+        # storageClassName: standard
+        accessModes: ["ReadWriteOnce"]
+        resources:
+          requests:
+            storage: 1Gi
diff --git a/example/probes/standalone.yaml b/example/probes/standalone.yaml
@@ -0,0 +1,47 @@
+---
+apiVersion: redis.redis.opstreelabs.in/v1beta1
+kind: Redis
+metadata:
+  name: redis-standalone
+spec:
+  kubernetesConfig:
+    image: quay.io/opstree/redis:v6.2.5
+    imagePullPolicy: IfNotPresent
+    resources:
+      requests:
+        cpu: 101m
+        memory: 128Mi
+      limits:
+        cpu: 101m
+        memory: 128Mi
+  storage:
+    volumeClaimTemplate:
+      spec:
+        # storageClassName: standard
+        accessModes: ["ReadWriteOnce"]
+        resources:
+          requests:
+            storage: 1Gi
+  redisExporter:
+    enabled: false
+    image: quay.io/opstree/redis-exporter:1.0
+  readinessProbe:
+    exec:
+      command:
+      - bash
+      - /usr/bin/healthcheck.sh
+    failureThreshold: 5
+    initialDelaySeconds: 15
+    periodSeconds: 15
+    successThreshold: 1
+    timeoutSeconds: 5
+  livenessProbe:
+    exec:
+      command:
+      - bash
+      - /usr/bin/healthcheck.sh
+    failureThreshold: 5
+    initialDelaySeconds: 15
+    periodSeconds: 15
+    successThreshold: 1
+    timeoutSeconds: 5
diff --git a/k8sutils/redis-cluster.go b/k8sutils/redis-cluster.go
@@ -10,6 +10,8 @@ type RedisClusterSTS struct {
 	RedisStateFulType string
 	ExternalConfig    *string
 	Affinity          *corev1.Affinity `json:"affinity,omitempty"`
+	ReadinessProbe    *corev1.Probe
+	LivenessProbe     *corev1.Probe
 }
 
 // RedisClusterService is a interface to call Redis Service function
@@ -43,7 +45,7 @@ func generateRedisClusterParams(cr *redisv1beta1.RedisCluster, replicas *int32,
 }
 
 // generateRedisStandaloneContainerParams generates Redis container information
-func generateRedisClusterContainerParams(cr *redisv1beta1.RedisCluster) containerParameters {
+func generateRedisClusterContainerParams(cr *redisv1beta1.RedisCluster, readinessProbeDef *corev1.Probe, livenessProbeDef *corev1.Probe) containerParameters {
 	trueProperty := true
 	falseProperty := false
 	containerProp := containerParameters{
@@ -72,6 +74,12 @@ func generateRedisClusterContainerParams(cr *redisv1beta1.RedisCluster) containe
 		}
 
 	}
+	if readinessProbeDef != nil {
+		containerProp.ReadinessProbe = readinessProbeDef
+	}
+	if livenessProbeDef != nil {
+		containerProp.LivenessProbe = livenessProbeDef
+	}
 	if cr.Spec.Storage != nil {
 		containerProp.PersistenceEnabled = &trueProperty
 	}
@@ -83,6 +91,8 @@ func CreateRedisLeader(cr *redisv1beta1.RedisCluster) error {
 	prop := RedisClusterSTS{
 		RedisStateFulType: "leader",
 		Affinity:          cr.Spec.RedisLeader.Affinity,
+		ReadinessProbe:    cr.Spec.RedisLeader.ReadinessProbe,
+		LivenessProbe:     cr.Spec.RedisLeader.LivenessProbe,
 	}
 	if cr.Spec.RedisLeader.RedisConfig != nil {
 		prop.ExternalConfig = cr.Spec.RedisLeader.RedisConfig.AdditionalRedisConfig
@@ -95,6 +105,8 @@ func CreateRedisFollower(cr *redisv1beta1.RedisCluster) error {
 	prop := RedisClusterSTS{
 		RedisStateFulType: "follower",
 		Affinity:          cr.Spec.RedisFollower.Affinity,
+		ReadinessProbe:    cr.Spec.RedisFollower.ReadinessProbe,
+		LivenessProbe:     cr.Spec.RedisFollower.LivenessProbe,
 	}
 	if cr.Spec.RedisFollower.RedisConfig != nil {
 		prop.ExternalConfig = cr.Spec.RedisFollower.RedisConfig.AdditionalRedisConfig
@@ -145,7 +157,7 @@ func (service RedisClusterSTS) CreateRedisClusterSetup(cr *redisv1beta1.RedisClu
 		labels,
 		generateRedisClusterParams(cr, service.getReplicaCount(cr), service.ExternalConfig, service.Affinity),
 		redisClusterAsOwner(cr),
-		generateRedisClusterContainerParams(cr),
+		generateRedisClusterContainerParams(cr, service.ReadinessProbe, service.LivenessProbe),
 	)
 	if err != nil {
 		logger.Error(err, "Cannot create statefulset for Redis", "Setup.Type", service.RedisStateFulType)
diff --git a/k8sutils/redis-standalone.go b/k8sutils/redis-standalone.go
@@ -106,6 +106,12 @@ func generateRedisStandaloneContainerParams(cr *redisv1beta1.Redis) containerPar
 		}
 
 	}
+	if cr.Spec.ReadinessProbe != nil {
+		containerProp.ReadinessProbe = cr.Spec.ReadinessProbe
+	}
+	if cr.Spec.LivenessProbe != nil {
+		containerProp.LivenessProbe = cr.Spec.LivenessProbe
+	}
 	if cr.Spec.Storage != nil {
 		containerProp.PersistenceEnabled = &trueProperty
 	}
diff --git a/k8sutils/statefulset.go b/k8sutils/statefulset.go
@@ -45,6 +45,8 @@ type containerParameters struct {
 	SecretName                   *string
 	SecretKey                    *string
 	PersistenceEnabled           *bool
+	ReadinessProbe               *corev1.Probe
+	LivenessProbe                *corev1.Probe
 }
 
 // CreateOrUpdateStateFul method will create or update Redis service
@@ -170,11 +172,20 @@ func generateContainerDef(name string, containerParams containerParameters, enab
 			Image:           containerParams.Image,
 			ImagePullPolicy: containerParams.ImagePullPolicy,
 			Env:             getEnvironmentVariables(containerParams.Role, containerParams.EnabledPassword, containerParams.SecretName, containerParams.SecretKey, containerParams.PersistenceEnabled, containerParams.RedisExporterEnv),
-			ReadinessProbe:  getProbeInfo(),
-			LivenessProbe:   getProbeInfo(),
 			VolumeMounts:    getVolumeMount(name, containerParams.PersistenceEnabled, externalConfig),
 		},
 	}
+	if containerParams.ReadinessProbe != nil {
+		containerDefinition[0].ReadinessProbe = containerParams.ReadinessProbe
+	} else {
+		containerDefinition[0].ReadinessProbe = getProbeInfo()
+	}
+	if containerParams.LivenessProbe != nil {
+		containerDefinition[0].LivenessProbe = containerParams.LivenessProbe
+	} else {
+		containerDefinition[0].LivenessProbe = getProbeInfo()
+	}
+
 	if containerParams.Resources != nil {
 		containerDefinition[0].Resources = *containerParams.Resources
 	}

Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,8 @@ type RedisSpec struct {`
`35`	`35`	PriorityClassName string `json:"priorityClassName,omitempty"`
`36`	`36`	Affinity *corev1.Affinity `json:"affinity,omitempty"`
`37`	`37`	Tolerations *[]corev1.Toleration `json:"tolerations,omitempty"`
	`38`	+ ReadinessProbe *corev1.Probe `json:"readinessProbe,omitempty" protobuf:"bytes,11,opt,name=readinessProbe"`
	`39`	+ LivenessProbe *corev1.Probe `json:"livenessProbe,omitempty" protobuf:"bytes,11,opt,name=livenessProbe"`
`38`	`40`	`}`
`39`	`41`
`40`	`42`	`// RedisStatus defines the observed state of Redis`
Original file line number	Diff line number	Diff line change
`@@ -106,6 +106,12 @@ func generateRedisStandaloneContainerParams(cr *redisv1beta1.Redis) containerPar`
`106`	`106`	`}`
`107`	`107`
`108`	`108`	`}`
	`109`	`+ if cr.Spec.ReadinessProbe != nil {`
	`110`	`+ containerProp.ReadinessProbe = cr.Spec.ReadinessProbe`
	`111`	`+ }`
	`112`	`+ if cr.Spec.LivenessProbe != nil {`
	`113`	`+ containerProp.LivenessProbe = cr.Spec.LivenessProbe`
	`114`	`+ }`
`109`	`115`	`if cr.Spec.Storage != nil {`
`110`	`116`	`containerProp.PersistenceEnabled = &trueProperty`
`111`	`117`	`}`