Add Liveness Probe for EventListener Deployment

Add a Liveness Probe for EventListener Deployment at URL /live

Author: khrm

.errcheck.txt

@@ -2,6 +2,7 @@
 flag.Set
 os.Setenv
 logger.Sync
+fmt.Fprint
 fmt.Fprintf
 fmt.Fprintln
 (io.Closer).Close

cmd/eventlistenersink/main.go

@@ -97,5 +97,10 @@ func main() {
 	// Listen and serve
 	logger.Infof("Listen and serve on port %s", sinkArgs.Port)
 	http.HandleFunc("/", r.HandleEvent)
+	// For handling Liveness Probe
+	http.HandleFunc("/live", func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(200)
+		fmt.Fprint(w, "ok")
+	})
 	logger.Fatal(http.ListenAndServe(fmt.Sprintf(":%s", sinkArgs.Port), nil))
 }

config/controller.yaml

@@ -45,7 +45,9 @@ spec:
           "-logtostderr",
           "-stderrthreshold", "INFO",
           "-el-image", "github.com/tektoncd/triggers/cmd/eventlistenersink",
-          "-el-port", "8080"
+          "-el-port", "8080",
+          "-period-seconds", "10",
+          "-failure-threshold", "1"
         ]
         volumeMounts:
         - name: config-logging

pkg/reconciler/v1alpha1/eventlistener/eventlistener.go

@@ -64,6 +64,12 @@ var (
 	// ElPort defines the port for the EventListener to listen on
 	ElPort = flag.Int("el-port", 8080,
 		"The container port for the EventListener to listen on.")
+	// PeriodSeconds defines Period Seconds for the EventListener Liveness Probe
+	PeriodSeconds = flag.Int("period-seconds", 10,
+		"The Period Seconds for the EventListener Liveness Probe.")
+	// FailureThreshold defines the Failure Threshold for the EventListener Liveness Probe
+	FailureThreshold = flag.Int("failure-threshold", 1,
+		"The Failure Threshold for the EventListener Liveness Probe.")
 	// StaticResourceLabels is a map with all the labels that should be on
 	// all resources generated by the EventListener
 	StaticResourceLabels = map[string]string{
@@ -260,6 +266,17 @@ func (c *Reconciler) reconcileDeployment(el *v1alpha1.EventListener) error {
 			ContainerPort: int32(*ElPort),
 			Protocol:      corev1.ProtocolTCP,
 		}},
+		LivenessProbe: &corev1.Probe{
+			Handler: corev1.Handler{
+				HTTPGet: &corev1.HTTPGetAction{
+					Path:   "/live",
+					Scheme: corev1.URISchemeHTTP,
+					Port:   intstr.FromInt((*ElPort)),
+				},
+			},
+			PeriodSeconds:    int32(*PeriodSeconds),
+			FailureThreshold: int32(*FailureThreshold),
+		},
 		Args: []string{
 			"-el-name", el.Name,
 			"-el-namespace", el.Namespace,

pkg/reconciler/v1alpha1/eventlistener/eventlistener_test.go

@@ -284,6 +284,17 @@ func Test_reconcileDeployment(t *testing.T) {
 									Protocol:      corev1.ProtocolTCP,
 								},
 							},
+							LivenessProbe: &corev1.Probe{
+								Handler: corev1.Handler{
+									HTTPGet: &corev1.HTTPGetAction{
+										Path:   "/live",
+										Scheme: corev1.URISchemeHTTP,
+										Port:   intstr.FromInt((*ElPort)),
+									},
+								},
+								PeriodSeconds:    int32(*PeriodSeconds),
+								FailureThreshold: int32(*FailureThreshold),
+							},
 							Args: []string{
 								"-el-name", eventListenerName,
 								"-el-namespace", namespace,
@@ -541,6 +552,17 @@ func TestReconcile(t *testing.T) {
 							ContainerPort: int32(*ElPort),
 							Protocol:      corev1.ProtocolTCP,
 						}},
+						LivenessProbe: &corev1.Probe{
+							Handler: corev1.Handler{
+								HTTPGet: &corev1.HTTPGetAction{
+									Path:   "/live",
+									Scheme: corev1.URISchemeHTTP,
+									Port:   intstr.FromInt((*ElPort)),
+								},
+							},
+							PeriodSeconds:    int32(*PeriodSeconds),
+							FailureThreshold: int32(*FailureThreshold),
+						},
 						Args: []string{
 							"-el-name", eventListenerName,
 							"-el-namespace", namespace,