fix: fix setting DataPlane readiness probe using GatewayConfiguration (#1118)

* fix: fix setting DataPlane readiness probe using GatewayConfiguration

* chore: fixup changed sample

Author: pmalek

CHANGELOG.md

@@ -127,6 +127,8 @@
 - Fix unexpected error logs caused by passing an odd number of arguments to the logger
   in the `KongConsumer` reconciler.
   [#983](https://github.com/Kong/gateway-operator/pull/983)
+- Fix setting `DataPlane`'s readiness probe using `GatewayConfiguration`.
+  [#1118](https://github.com/Kong/gateway-operator/pull/1118)
 
 ### Added
 

controller/gateway/controller.go

@@ -656,7 +656,11 @@ func setDataPlaneOptionsDefaults(opts *operatorv1beta1.DataPlaneOptions, default
 		if container.Image == "" {
 			container.Image = defaultImage
 		}
-		container.ReadinessProbe = k8sresources.GenerateDataPlaneReadinessProbe(consts.DataPlaneStatusReadyEndpoint)
+		if container.ReadinessProbe == nil {
+			// For Gateway we set DataPlane's readiness probe to /status/ready so that
+			// it's only marked ready when it receives the configuration from the ControlPlane.
+			container.ReadinessProbe = k8sresources.GenerateDataPlaneReadinessProbe(consts.DataPlaneStatusReadyEndpoint)
+		}
 	} else {
 		// Because we currently require image to be specified for DataPlanes
 		// we need to add it here. After #20 gets resolved this won't be needed

controller/gateway/controller_test.go

@@ -13,6 +13,7 @@ import (
 	networkingv1 "k8s.io/api/networking/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
+	"k8s.io/apimachinery/pkg/util/intstr"
 	"k8s.io/client-go/kubernetes/scheme"
 	controllerruntimeclient "sigs.k8s.io/controller-runtime/pkg/client"
 	fakectrlruntimeclient "sigs.k8s.io/controller-runtime/pkg/client/fake"
@@ -712,6 +713,94 @@ func Test_setDataPlaneOptionsDefaults(t *testing.T) {
 				},
 			},
 		},
+		{
+			name: "not providing the readiness probe sets it to default",
+			input: operatorv1beta1.DataPlaneOptions{
+				Deployment: operatorv1beta1.DataPlaneDeploymentOptions{},
+			},
+			expected: operatorv1beta1.DataPlaneOptions{
+				Deployment: operatorv1beta1.DataPlaneDeploymentOptions{
+					DeploymentOptions: operatorv1beta1.DeploymentOptions{
+						Replicas: lo.ToPtr(int32(1)),
+						PodTemplateSpec: &corev1.PodTemplateSpec{
+							Spec: corev1.PodSpec{
+								Containers: []corev1.Container{
+									{
+										Name:           consts.DataPlaneProxyContainerName,
+										Image:          consts.DefaultDataPlaneImage,
+										ReadinessProbe: resources.GenerateDataPlaneReadinessProbe(consts.DataPlaneStatusReadyEndpoint),
+									},
+								},
+							},
+						},
+					},
+				},
+			},
+		},
+		{
+			name: "providing the readiness probe sets it as expected",
+			input: operatorv1beta1.DataPlaneOptions{
+				Deployment: operatorv1beta1.DataPlaneDeploymentOptions{
+					DeploymentOptions: operatorv1beta1.DeploymentOptions{
+						PodTemplateSpec: &corev1.PodTemplateSpec{
+							Spec: corev1.PodSpec{
+								Containers: []corev1.Container{
+									{
+										Name:  consts.DataPlaneProxyContainerName,
+										Image: consts.DefaultDataPlaneImage,
+										ReadinessProbe: &corev1.Probe{
+											FailureThreshold:    6,
+											InitialDelaySeconds: 7,
+											PeriodSeconds:       8,
+											SuccessThreshold:    8,
+											TimeoutSeconds:      9,
+											ProbeHandler: corev1.ProbeHandler{
+												HTTPGet: &corev1.HTTPGetAction{
+													Path:   "/endpoint",
+													Port:   intstr.FromInt(4567),
+													Scheme: corev1.URISchemeHTTP,
+												},
+											},
+										},
+									},
+								},
+							},
+						},
+					},
+				},
+			},
+			expected: operatorv1beta1.DataPlaneOptions{
+				Deployment: operatorv1beta1.DataPlaneDeploymentOptions{
+					DeploymentOptions: operatorv1beta1.DeploymentOptions{
+						Replicas: lo.ToPtr(int32(1)),
+						PodTemplateSpec: &corev1.PodTemplateSpec{
+							Spec: corev1.PodSpec{
+								Containers: []corev1.Container{
+									{
+										Name:  consts.DataPlaneProxyContainerName,
+										Image: consts.DefaultDataPlaneImage,
+										ReadinessProbe: &corev1.Probe{
+											FailureThreshold:    6,
+											InitialDelaySeconds: 7,
+											PeriodSeconds:       8,
+											SuccessThreshold:    8,
+											TimeoutSeconds:      9,
+											ProbeHandler: corev1.ProbeHandler{
+												HTTPGet: &corev1.HTTPGetAction{
+													Path:   "/endpoint",
+													Port:   intstr.FromInt(4567),
+													Scheme: corev1.URISchemeHTTP,
+												},
+											},
+										},
+									},
+								},
+							},
+						},
+					},
+				},
+			},
+		},
 	}
 
 	for _, tc := range testcases {

test/integration/test_gatewayconfiguration.go

@@ -8,6 +8,7 @@ import (
 	"github.com/stretchr/testify/require"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/util/intstr"
 	gatewayv1 "sigs.k8s.io/gateway-api/apis/v1"
 
 	operatorv1beta1 "github.com/kong/gateway-operator/api/v1beta1"
@@ -77,6 +78,20 @@ func TestGatewayConfigurationEssentials(t *testing.T) {
 												},
 											},
 										},
+										ReadinessProbe: &corev1.Probe{
+											FailureThreshold:    6,
+											InitialDelaySeconds: 1,
+											PeriodSeconds:       2,
+											SuccessThreshold:    2,
+											TimeoutSeconds:      9,
+											ProbeHandler: corev1.ProbeHandler{
+												HTTPGet: &corev1.HTTPGetAction{
+													Path:   "/status/ready",
+													Port:   intstr.FromInt(4567),
+													Scheme: corev1.URISchemeHTTP,
+												},
+											},
+										},
 									},
 								},
 							},
@@ -178,6 +193,18 @@ func TestGatewayConfigurationEssentials(t *testing.T) {
 				return true
 			}
 		}
+		if container.ReadinessProbe == nil ||
+			container.ReadinessProbe.HTTPGet == nil ||
+			container.ReadinessProbe.HTTPGet.Path != "/status/ready" ||
+			container.ReadinessProbe.HTTPGet.Port.IntVal != 4567 ||
+			container.ReadinessProbe.HTTPGet.Scheme != corev1.URISchemeHTTP ||
+			container.ReadinessProbe.FailureThreshold != 6 ||
+			container.ReadinessProbe.InitialDelaySeconds != 1 ||
+			container.ReadinessProbe.PeriodSeconds != 2 ||
+			container.ReadinessProbe.SuccessThreshold != 2 ||
+			container.ReadinessProbe.TimeoutSeconds != 9 {
+			return false
+		}
 		return false
 	}, testutils.GatewayReadyTimeLimit, time.Second)