support deploying provision probe or mount probe only

Currently, when a user deploys a PieProbe object, both of provision and
mount probes are deployed. However, under some circumstances, it is
enough to deploy either provision probes or mount probes only.

This commit supports deploying either provision probes or mount probes
only, by adding disableProvisionProbes and disableMountProbes fields to
PieProbe spec.

Signed-off-by: Ryotaro Banno <[email protected]>

Author: ushitora-anqou

api/pie/v1alpha1/pieprobe_types.go

@@ -32,6 +32,16 @@ type PieProbeSpec struct {
 	//+kubebuilder:validation:Optional
 	//+kubebuilder:validation:XValidation:rule="self == oldSelf",message="pvcCapacity is immutable"
 	PVCCapacity *resource.Quantity `json:"pvcCapacity"`
+
+	//+kubebuilder:default:=false
+	//+kubebuilder:validation:Optional
+	//+kubebuilder:validation:XValidation:rule="self == oldSelf",message="disableProvisionProbe is immutable"
+	DisableProvisionProbes bool `json:"disableProvisionProbe"`
+
+	//+kubebuilder:default:=false
+	//+kubebuilder:validation:Optional
+	//+kubebuilder:validation:XValidation:rule="self == oldSelf",message="disableMountProbe is immutable"
+	DisableMountProbes bool `json:"disableMountProbe"`
 }
 
 // PieProbeStatus defines the observed state of PieProbe

charts/pie/templates/pie.topolvm.io_pieprobes.yaml

@@ -39,6 +39,18 @@ spec:
           spec:
             description: PieProbeSpec defines the desired state of PieProbe
             properties:
+              disableMountProbe:
+                default: false
+                type: boolean
+                x-kubernetes-validations:
+                - message: disableMountProbe is immutable
+                  rule: self == oldSelf
+              disableProvisionProbe:
+                default: false
+                type: boolean
+                x-kubernetes-validations:
+                - message: disableProvisionProbe is immutable
+                  rule: self == oldSelf
               monitoringStorageClass:
                 type: string
                 x-kubernetes-validations:

config/crd/bases/pie.topolvm.io_pieprobes.yaml

@@ -39,6 +39,18 @@ spec:
           spec:
             description: PieProbeSpec defines the desired state of PieProbe
             properties:
+              disableMountProbe:
+                default: false
+                type: boolean
+                x-kubernetes-validations:
+                - message: disableMountProbe is immutable
+                  rule: self == oldSelf
+              disableProvisionProbe:
+                default: false
+                type: boolean
+                x-kubernetes-validations:
+                - message: disableProvisionProbe is immutable
+                  rule: self == oldSelf
               monitoringStorageClass:
                 type: string
                 x-kubernetes-validations:

internal/controller/pie/pieprobe_controller.go

@@ -87,21 +87,31 @@ func (r *PieProbeReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
 		return ctrl.Result{}, nil
 	}
 
-	// Create a provision-probe CronJob for each sc
-	err = r.createOrUpdateJob(
-		ctx,
-		ProvisionProbe,
-		&pieProbe,
-		nil,
-	)
-	if err != nil {
-		return ctrl.Result{}, err
+	if !pieProbe.Spec.DisableProvisionProbes {
+		if err := r.reconcileProvisionProbe(ctx, &pieProbe); err != nil {
+			return ctrl.Result{}, err
+		}
+	}
+
+	if !pieProbe.Spec.DisableMountProbes {
+		if err := r.reconcileMountProbes(ctx, &pieProbe); err != nil {
+			return ctrl.Result{}, err
+		}
 	}
 
+	return ctrl.Result{}, nil
+}
+
+func (r *PieProbeReconciler) reconcileProvisionProbe(ctx context.Context, pieProbe *piev1alpha1.PieProbe) error {
+	// Create a provision-probe CronJob for each sc
+	return r.createOrUpdateJob(ctx, ProvisionProbe, pieProbe, nil)
+}
+
+func (r *PieProbeReconciler) reconcileMountProbes(ctx context.Context, pieProbe *piev1alpha1.PieProbe) error {
 	// Get a node list and create a PVC and a mount-probe CronJob for each node and sc.
 	nodeSelector, err := nodeaffinity.NewNodeSelector(&pieProbe.Spec.NodeSelector)
 	if err != nil {
-		return ctrl.Result{}, err
+		return err
 	}
 	allNodeList := corev1.NodeList{}
 	r.client.List(ctx, &allNodeList)
@@ -112,22 +122,13 @@ func (r *PieProbeReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
 		}
 		availableNodeList = append(availableNodeList, node)
 
-		err = r.createOrUpdatePVC(
-			ctx,
-			node.Name,
-			&pieProbe,
-		)
+		err = r.createOrUpdatePVC(ctx, node.Name, pieProbe)
 		if err != nil {
-			return ctrl.Result{}, err
+			return err
 		}
-		err = r.createOrUpdateJob(
-			ctx,
-			MountProbe,
-			&pieProbe,
-			&node.Name,
-		)
+		err = r.createOrUpdateJob(ctx, MountProbe, pieProbe, &node.Name)
 		if err != nil {
-			return ctrl.Result{}, err
+			return err
 		}
 	}
 
@@ -144,7 +145,7 @@ func (r *PieProbeReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
 		}),
 	})
 	if err != nil {
-		return ctrl.Result{}, err
+		return err
 	}
 	for _, cronJob := range cronJobList.Items {
 		nodeName := cronJob.GetLabels()[constants.ProbeNodeLabelKey]
@@ -156,7 +157,7 @@ func (r *PieProbeReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
 		}
 		err := r.deleteCronJob(ctx, &cronJob)
 		if client.IgnoreNotFound(err) != nil {
-			return ctrl.Result{}, err
+			return err
 		}
 	}
 
@@ -168,7 +169,7 @@ func (r *PieProbeReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
 		}),
 	})
 	if err != nil {
-		return ctrl.Result{}, err
+		return err
 	}
 	for _, pvc := range pvcList.Items {
 		nodeName := pvc.GetLabels()[constants.ProbeNodeLabelKey]
@@ -177,11 +178,11 @@ func (r *PieProbeReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
 		}
 		err = r.deletePVC(ctx, &pvc)
 		if client.IgnoreNotFound(err) != nil {
-			return ctrl.Result{}, err
+			return err
 		}
 	}
 
-	return ctrl.Result{}, nil
+	return nil
 }
 
 func (r *PieProbeReconciler) deletePVC(ctx context.Context, pvc *corev1.PersistentVolumeClaim) error {