feat: add liveness and readiness probe (#205)

* add liveness and readiness probe

* add comment

* handle wireguard state with probe

* decrease period second

Author: winston0410

cmd/agent/main.go

@@ -3,12 +3,14 @@ package main
 import (
 	"flag"
 	"fmt"
+	"log"
+	"net/http"
+	"os"
+
 	"github.com/go-logr/stdr"
 	"github.com/jodevsa/wireguard-operator/internal/iptables"
 	"github.com/jodevsa/wireguard-operator/pkg/agent"
 	"github.com/jodevsa/wireguard-operator/pkg/wireguard"
-	"log"
-	"os"
 )
 
 func main() {
@@ -98,6 +100,36 @@ func main() {
 
 	defer close()
 
-	// Block main goroutine forever.
-	<-make(chan struct{})
+	httpLog := log.WithName("http")
+
+	http.HandleFunc("/health", func(w http.ResponseWriter, r *http.Request) {
+		state, _, err := agent.GetDesiredState(configFilePath)
+
+		if err != nil {
+			httpLog.Error(err, "agent is not ready as it cannot get server state")
+			w.WriteHeader(http.StatusServiceUnavailable)
+			return
+		}
+
+		err = agent.IsStateValid(state)
+
+		if err != nil {
+			httpLog.Error(err, "agent is not ready as server state not valid")
+			w.WriteHeader(http.StatusServiceUnavailable)
+			return
+		}
+
+		err = wg.Sync(state)
+
+		if err != nil {
+			httpLog.Error(err, "agent is not ready as it cannot sync wireguard")
+			w.WriteHeader(http.StatusServiceUnavailable)
+			return
+		}
+
+		httpLog.Info("agent is ready")
+
+		w.WriteHeader(http.StatusOK)
+	})
+	http.ListenAndServe(":8080", nil)
 }

pkg/agent/agent.go

@@ -5,10 +5,11 @@ import (
 	"encoding/hex"
 	"encoding/json"
 	"fmt"
-	"github.com/go-logr/logr"
 	"os"
 	"path/filepath"
 
+	"github.com/go-logr/logr"
+
 	"github.com/fsnotify/fsnotify"
 	"github.com/jodevsa/wireguard-operator/pkg/api/v1alpha1"
 )
@@ -19,7 +20,7 @@ type State struct {
 	Peers            []v1alpha1.WireguardPeer
 }
 
-func isStateValid(state State) error {
+func IsStateValid(state State) error {
 
 	if state.ServerPrivateKey == "" {
 		return fmt.Errorf("server private key is not defined")
@@ -66,7 +67,7 @@ func OnStateChange(path string, logger logr.Logger, onFileChange func(State)) (f
 	state, hash, err := GetDesiredState(path)
 
 	if err == nil {
-		err := isStateValid(state)
+		err := IsStateValid(state)
 
 		if err != nil {
 			logger.Error(err, "State is not valid")
@@ -100,7 +101,7 @@ func OnStateChange(path string, logger logr.Logger, onFileChange func(State)) (f
 					logger.V(9).Info("State content changed", "oldHash", hash, "newHash", newHash)
 					hash = newHash
 
-					err = isStateValid(state)
+					err = IsStateValid(state)
 
 					if err != nil {
 						logger.Error(err, "State is not valid")

pkg/controllers/wireguard_controller.go

@@ -44,6 +44,7 @@ import (
 // WireguardReconciler reconciles a Wireguard object
 
 const port = 51820
+const httpPort = 8080
 
 const metricsPort = 9586
 
@@ -795,12 +796,34 @@ func (r *WireguardReconciler) deploymentForWireguard(m *v1alpha1.Wireguard) *app
 									ContainerPort: port,
 									Name:          "wireguard",
 									Protocol:      corev1.ProtocolUDP,
-								}},
+								},
+								{
+									ContainerPort: port,
+									Name:          "http",
+									Protocol:      corev1.ProtocolTCP,
+								},
+							},
 							EnvFrom: []corev1.EnvFromSource{{
 								ConfigMapRef: &corev1.ConfigMapEnvSource{
 									LocalObjectReference: corev1.LocalObjectReference{Name: m.Name + "-config"},
 								},
 							}},
+							ReadinessProbe: &corev1.Probe{
+								ProbeHandler: corev1.ProbeHandler{
+									HTTPGet: &corev1.HTTPGetAction{
+										Port: intstr.FromInt(httpPort),
+										Path: "/health",
+									},
+								},
+							},
+							LivenessProbe: &corev1.Probe{
+								PeriodSeconds: 5,
+								ProbeHandler: corev1.ProbeHandler{
+									TCPSocket: &corev1.TCPSocketAction{
+										Port: intstr.FromInt(httpPort),
+									},
+								},
+							},
 							VolumeMounts: []corev1.VolumeMount{
 								{
 									Name:      "socket",