improve crd docs

Author: Ahmed El-Sayed

api/v1alpha2/secretsync_types.go

@@ -7,15 +7,18 @@ import (
 
 // SecretSyncSpec
 type SecretSyncSpec struct {
-	// ClusterSelector specifies the label selector to match clusters with
+	// Label selector for Clusters. The Clusters that are
+	// selected by this will be the ones affected by this SecretSync.
+	// It must match the Cluster labels. This field is immutable.
+	// Label selector cannot be empty.
 	ClusterSelector metav1.LabelSelector `json:"clusterSelector"`
 	// SecretRef specifies the Secret to be bootstrapped to the matched clusters
 	// Secret must be in the same namespace of the SecretSync object
 	SecretRef v1.LocalObjectReference `json:"secretRef"`
 	// TargetNamespace specifies the namespace which the secret should be bootstrapped in
 	// The default value is the namespace of the referenced secret
 	//+optional
-	TargetNamespace string `json:"targetNamespace"`
+	TargetNamespace string `json:"targetNamespace,omitempty"`
 }
 
 // SecretSyncStatus secretsync object status

controllers/secretsync_controller.go

@@ -168,7 +168,7 @@ func (r *SecretSyncReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 	}
 
 	if err := patchHelper.Patch(ctx, &secretSync); err != nil {
-		return ctrl.Result{}, err
+		return ctrl.Result{}, fmt.Errorf("failed to patch object status: %w", err)
 	}
 
 	if requeue {