fix: make probe enabled defaults explicit

Author: ThomasK33

api/v1alpha1/types_shared.go

@@ -69,8 +69,8 @@ type TLSSpec struct {
 // ProbeSpec configures a Kubernetes probe with an enable toggle.
 type ProbeSpec struct {
 	// Enabled toggles the probe on or off.
-	// +kubebuilder:default=true
-	Enabled bool `json:"enabled,omitempty"`
+	// When omitted, readiness defaults to enabled while liveness defaults to disabled.
+	Enabled *bool `json:"enabled,omitempty"`
 	// InitialDelaySeconds is the delay before the probe starts.
 	// +kubebuilder:default=0
 	InitialDelaySeconds int32 `json:"initialDelaySeconds,omitempty"`

api/v1alpha1/zz_generated.deepcopy.go

@@ -958,7 +958,7 @@ spec:
                   secrets:
                     description: |-
                       Secrets lists Secret key selectors for CA certificates.
-                      Each is mounted at /etc/ssl/certs/<name>.crt.
+                      Each is mounted at `/etc/ssl/certs/{name}.crt`.
                     items:
                       description: CertSecretSelector identifies a key within a Secret
                         for CA cert mounting.
@@ -1312,8 +1312,9 @@ spec:
                   plane container.
                 properties:
                   enabled:
-                    default: true
-                    description: Enabled toggles the probe on or off.
+                    description: |-
+                      Enabled toggles the probe on or off.
+                      When omitted, readiness defaults to enabled while liveness defaults to disabled.
                     type: boolean
                   failureThreshold:
                     description: FailureThreshold is the minimum consecutive failures
@@ -1673,8 +1674,9 @@ spec:
                   control plane container.
                 properties:
                   enabled:
-                    default: true
-                    description: Enabled toggles the probe on or off.
+                    description: |-
+                      Enabled toggles the probe on or off.
+                      When omitted, readiness defaults to enabled while liveness defaults to disabled.
                     type: boolean
                   failureThreshold:
                     description: FailureThreshold is the minimum consecutive failures

config/crd/bases/coder.com_codercontrolplanes.yaml

@@ -143,7 +143,7 @@ ProbeSpec configures a Kubernetes probe with an enable toggle.
 
 | Field | Type | Description |
 | --- | --- | --- |
-| `enabled` | boolean | Enabled toggles the probe on or off. |
+| `enabled` | boolean | Enabled toggles the probe on or off. When omitted, readiness defaults to enabled while liveness defaults to disabled. |
 | `initialDelaySeconds` | integer | InitialDelaySeconds is the delay before the probe starts. |
 | `periodSeconds` | integer | PeriodSeconds controls how often the probe is performed. |
 | `timeoutSeconds` | integer | TimeoutSeconds is the probe timeout. |

docs/reference/api/codercontrolplane.md

@@ -721,6 +721,14 @@ func (r *CoderControlPlaneReconciler) cleanupManagedWorkspaceRBAC(
 	return nil
 }
 
+func probeEnabled(explicit *bool, defaultEnabled bool) bool {
+	if explicit == nil {
+		return defaultEnabled
+	}
+
+	return *explicit
+}
+
 func buildProbe(spec coderv1alpha1.ProbeSpec, path, portName string) *corev1.Probe {
 	probe := &corev1.Probe{
 		ProbeHandler: corev1.ProbeHandler{
@@ -930,10 +938,10 @@ func (r *CoderControlPlaneReconciler) reconcileDeployment(ctx context.Context, c
 		if coderControlPlane.Spec.Resources != nil {
 			container.Resources = *coderControlPlane.Spec.Resources
 		}
-		if coderControlPlane.Spec.ReadinessProbe.Enabled {
+		if probeEnabled(coderControlPlane.Spec.ReadinessProbe.Enabled, true) {
 			container.ReadinessProbe = buildProbe(coderControlPlane.Spec.ReadinessProbe, "/healthz", "http")
 		}
-		if coderControlPlane.Spec.LivenessProbe.Enabled {
+		if probeEnabled(coderControlPlane.Spec.LivenessProbe.Enabled, false) {
 			container.LivenessProbe = buildProbe(coderControlPlane.Spec.LivenessProbe, "/healthz", "http")
 		}
 

internal/controller/codercontrolplane_controller.go

@@ -3005,21 +3005,42 @@ func TestReconcile_ProbeConfiguration(t *testing.T) {
 		}
 	})
 
+	t.Run("LivenessProbeEmptyObjectRemainsDisabled", func(t *testing.T) {
+		cp := createCoderControlPlaneUnstructured(ctx, t, "test-probe-liveness-empty-object", "default", map[string]any{
+			"image":         "test-probes:latest",
+			"livenessProbe": map[string]any{},
+		})
+
+		r := &controller.CoderControlPlaneReconciler{Client: k8sClient, Scheme: scheme}
+		if _, err := r.Reconcile(ctx, ctrl.Request{NamespacedName: types.NamespacedName{Name: cp.Name, Namespace: cp.Namespace}}); err != nil {
+			t.Fatalf("reconcile control plane: %v", err)
+		}
+
+		deployment := &appsv1.Deployment{}
+		if err := k8sClient.Get(ctx, types.NamespacedName{Name: cp.Name, Namespace: cp.Namespace}, deployment); err != nil {
+			t.Fatalf("get deployment: %v", err)
+		}
+		container := deployment.Spec.Template.Spec.Containers[0]
+		if container.LivenessProbe != nil {
+			t.Fatalf("expected liveness probe to stay disabled for empty object, got %#v", container.LivenessProbe)
+		}
+	})
+
 	t.Run("BothProbesEnabledWithCustomTiming", func(t *testing.T) {
 		cp := &coderv1alpha1.CoderControlPlane{
 			ObjectMeta: metav1.ObjectMeta{Name: "test-probe-custom", Namespace: "default"},
 			Spec: coderv1alpha1.CoderControlPlaneSpec{
 				Image: "test-probes:latest",
 				ReadinessProbe: coderv1alpha1.ProbeSpec{
-					Enabled:             true,
+					Enabled:             ptrTo(true),
 					InitialDelaySeconds: 3,
 					PeriodSeconds:       ptrTo(int32(7)),
 					TimeoutSeconds:      ptrTo(int32(2)),
 					SuccessThreshold:    ptrTo(int32(2)),
 					FailureThreshold:    ptrTo(int32(5)),
 				},
 				LivenessProbe: coderv1alpha1.ProbeSpec{
-					Enabled:             true,
+					Enabled:             ptrTo(true),
 					InitialDelaySeconds: 11,
 					PeriodSeconds:       ptrTo(int32(13)),
 					TimeoutSeconds:      ptrTo(int32(4)),