non-reconciliable & readiness of static objects

Remove reconcile subcommand for static object APIs Alerts and Providers. Add a hasReconciler() method on all the object adapters to determine if their configuration supports reconciliation. The objects that don't support reconciliation are skilled from reconciliation and readiness checks like HelmRepository of type OCI. Add default ready message for `get` subcommand output for static objects, Alerts, Providers and HelmRepositories of type OCI, as ready message can't be derived for them from their status. Signed-off-by: Sunny <[email protected]>
fluxcd · Oct 13, 2023 · 0f928ed · 0f928ed
1 parent e13ab33
commit 0f928ed
Show file tree

Hide file tree

Showing 22 changed files with 81 additions and 97 deletions.
diff --git a/cmd/flux/create_alert.go b/cmd/flux/create_alert.go
@@ -132,7 +132,7 @@ func createAlertCmdRun(cmd *cobra.Command, args []string) error {
 
 	logger.Waitingf("waiting for Alert reconciliation")
 	if err := wait.PollImmediate(rootArgs.pollInterval, rootArgs.timeout,
-		isObjectReadyConditionFunc(ctx, kubeClient, namespacedName, &alert)); err != nil {
+		isStaticObjectReadyConditionFunc(ctx, kubeClient, namespacedName, &alert)); err != nil {
 		return err
 	}
 	logger.Successf("Alert %s is ready", name)

diff --git a/cmd/flux/create_alertprovider.go b/cmd/flux/create_alertprovider.go
@@ -127,7 +127,7 @@ func createAlertProviderCmdRun(cmd *cobra.Command, args []string) error {
 
 	logger.Waitingf("waiting for Provider reconciliation")
 	if err := wait.PollImmediate(rootArgs.pollInterval, rootArgs.timeout,
-		isObjectReadyConditionFunc(ctx, kubeClient, namespacedName, &provider)); err != nil {
+		isStaticObjectReadyConditionFunc(ctx, kubeClient, namespacedName, &provider)); err != nil {
 		return err
 	}
 

diff --git a/cmd/flux/create_source_helm.go b/cmd/flux/create_source_helm.go
@@ -230,8 +230,12 @@ func createSourceHelmCmdRun(cmd *cobra.Command, args []string) error {
 	}
 
 	logger.Waitingf("waiting for HelmRepository source reconciliation")
-	if err := wait.PollImmediate(rootArgs.pollInterval, rootArgs.timeout,
-		isObjectReadyConditionFunc(ctx, kubeClient, namespacedName, helmRepository)); err != nil {
+	readyConditionFunc := isObjectReadyConditionFunc(ctx, kubeClient, namespacedName, helmRepository)
+	if helmRepository.Spec.Type == sourcev1.HelmRepositoryTypeOCI {
+		// HelmRepository type OCI is a static object.
+		readyConditionFunc = isStaticObjectReadyConditionFunc(ctx, kubeClient, namespacedName, helmRepository)
+	}
+	if err := wait.PollImmediate(rootArgs.pollInterval, rootArgs.timeout, readyConditionFunc); err != nil {
 		return err
 	}
 	logger.Successf("HelmRepository source reconciliation completed")

diff --git a/cmd/flux/get_alert.go b/cmd/flux/get_alert.go
@@ -22,6 +22,7 @@ import (
 	"strings"
 
 	"github.com/spf13/cobra"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 
 	notificationv1 "github.com/fluxcd/notification-controller/api/v1beta2"
@@ -76,7 +77,7 @@ func init() {
 
 func (s alertListAdapter) summariseItem(i int, includeNamespace bool, includeKind bool) []string {
 	item := s.Items[i]
-	status, msg := statusAndMessage(item.Status.Conditions)
+	status, msg := string(metav1.ConditionTrue), "Alert is Ready"
 	return append(nameColumns(&item, includeNamespace, includeKind), strings.Title(strconv.FormatBool(item.Spec.Suspend)), status, msg)
 }
 

diff --git a/cmd/flux/get_alertprovider.go b/cmd/flux/get_alertprovider.go
@@ -20,6 +20,7 @@ import (
 	"fmt"
 
 	"github.com/spf13/cobra"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 
 	notificationv1 "github.com/fluxcd/notification-controller/api/v1beta2"
@@ -74,7 +75,7 @@ func init() {
 
 func (s alertProviderListAdapter) summariseItem(i int, includeNamespace bool, includeKind bool) []string {
 	item := s.Items[i]
-	status, msg := statusAndMessage(item.Status.Conditions)
+	status, msg := string(metav1.ConditionTrue), "Provider is Ready"
 	return append(nameColumns(&item, includeNamespace, includeKind), status, msg)
 }
 

diff --git a/cmd/flux/get_source_helm.go b/cmd/flux/get_source_helm.go
@@ -22,6 +22,7 @@ import (
 	"strings"
 
 	"github.com/spf13/cobra"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 
 	sourcev1 "github.com/fluxcd/source-controller/api/v1beta2"
@@ -81,7 +82,12 @@ func (a *helmRepositoryListAdapter) summariseItem(i int, includeNamespace bool,
 	if item.GetArtifact() != nil {
 		revision = item.GetArtifact().Revision
 	}
-	status, msg := statusAndMessage(item.Status.Conditions)
+	var status, msg string
+	if item.Spec.Type == sourcev1.HelmRepositoryTypeOCI {
+		status, msg = string(metav1.ConditionTrue), "Helm repository is Ready"
+	} else {
+		status, msg = statusAndMessage(item.Status.Conditions)
+	}
 	revision = utils.TruncateHex(revision)
 	msg = utils.TruncateHex(msg)
 	return append(nameColumns(&item, includeNamespace, includeKind),

diff --git a/cmd/flux/reconcile.go b/cmd/flux/reconcile.go
@@ -60,6 +60,7 @@ type reconcilable interface {
 	GetAnnotations() map[string]string
 	SetAnnotations(map[string]string)
 
+	hasReconciler() bool                 // does the object's current configuration has a reconciler to reconcile it?
 	lastHandledReconcileRequest() string // what was the last handled reconcile request?
 	successMessage() string              // what do you want to tell people when successfully reconciled?
 }
@@ -100,6 +101,11 @@ func (reconcile reconcileCommand) run(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
+	if !reconcile.object.hasReconciler() {
+		logger.Successf("reconciliation not supported by the object")
+		return nil
+	}
+
 	if reconcile.object.isSuspended() {
 		return fmt.Errorf("resource is suspended")
 	}

diff --git a/cmd/flux/reconcile_alert.go b/cmd/flux/reconcile_alert.go
diff --git a/cmd/flux/reconcile_alertprovider.go b/cmd/flux/reconcile_alertprovider.go
diff --git a/cmd/flux/reconcile_helmrelease.go b/cmd/flux/reconcile_helmrelease.go
@@ -81,3 +81,7 @@ func (obj helmReleaseAdapter) getSource() (reconcileSource, types.NamespacedName
 		Namespace: ns,
 	}
 }
+
+func (obj helmReleaseAdapter) hasReconciler() bool {
+	return true
+}
diff --git a/cmd/flux/reconcile_image_repository.go b/cmd/flux/reconcile_image_repository.go
@@ -48,3 +48,7 @@ func (obj imageRepositoryAdapter) lastHandledReconcileRequest() string {
 func (obj imageRepositoryAdapter) successMessage() string {
 	return fmt.Sprintf("scan fetched %d tags", obj.Status.LastScanResult.TagCount)
 }
+
+func (obj imageRepositoryAdapter) hasReconciler() bool {
+	return true
+}
diff --git a/cmd/flux/reconcile_image_updateauto.go b/cmd/flux/reconcile_image_updateauto.go
@@ -56,3 +56,7 @@ func (obj imageUpdateAutomationAdapter) successMessage() string {
 	}
 	return "automation not yet run"
 }
+
+func (obj imageUpdateAutomationAdapter) hasReconciler() bool {
+	return true
+}
diff --git a/cmd/flux/reconcile_kustomization.go b/cmd/flux/reconcile_kustomization.go
@@ -88,3 +88,7 @@ func (obj kustomizationAdapter) getSource() (reconcileSource, types.NamespacedNa
 		Namespace: obj.Spec.SourceRef.Namespace,
 	}
 }
+
+func (obj kustomizationAdapter) hasReconciler() bool {
+	return true
+}
diff --git a/cmd/flux/reconcile_receiver.go b/cmd/flux/reconcile_receiver.go
@@ -42,3 +42,7 @@ func init() {
 func (obj receiverAdapter) lastHandledReconcileRequest() string {
 	return obj.Status.GetLastHandledReconcileRequest()
 }
+
+func (obj receiverAdapter) hasReconciler() bool {
+	return true
+}
diff --git a/cmd/flux/reconcile_source_bucket.go b/cmd/flux/reconcile_source_bucket.go
@@ -48,3 +48,7 @@ func (obj bucketAdapter) lastHandledReconcileRequest() string {
 func (obj bucketAdapter) successMessage() string {
 	return fmt.Sprintf("fetched revision %s", obj.Status.Artifact.Revision)
 }
+
+func (obj bucketAdapter) hasReconciler() bool {
+	return true
+}
diff --git a/cmd/flux/reconcile_source_chart.go b/cmd/flux/reconcile_source_chart.go
@@ -84,3 +84,7 @@ func (obj helmChartAdapter) getSource() (reconcileSource, types.NamespacedName)
 		Namespace: obj.Namespace,
 	}
 }
+
+func (obj helmChartAdapter) hasReconciler() bool {
+	return true
+}
diff --git a/cmd/flux/reconcile_source_git.go b/cmd/flux/reconcile_source_git.go
@@ -48,3 +48,7 @@ func (obj gitRepositoryAdapter) lastHandledReconcileRequest() string {
 func (obj gitRepositoryAdapter) successMessage() string {
 	return fmt.Sprintf("fetched revision %s", obj.Status.Artifact.Revision)
 }
+
+func (obj gitRepositoryAdapter) hasReconciler() bool {
+	return true
+}
diff --git a/cmd/flux/reconcile_source_helm.go b/cmd/flux/reconcile_source_helm.go
@@ -60,3 +60,7 @@ func (obj helmRepositoryAdapter) successMessage() string {
 	}
 	return fmt.Sprintf("fetched revision %s", obj.Status.Artifact.Revision)
 }
+
+func (obj helmRepositoryAdapter) hasReconciler() bool {
+	return obj.Spec.Type != sourcev1.HelmRepositoryTypeOCI
+}
diff --git a/cmd/flux/reconcile_source_oci.go b/cmd/flux/reconcile_source_oci.go
@@ -48,3 +48,7 @@ func (obj ociRepositoryAdapter) lastHandledReconcileRequest() string {
 func (obj ociRepositoryAdapter) successMessage() string {
 	return fmt.Sprintf("fetched revision %s", obj.Status.Artifact.Revision)
 }
+
+func (obj ociRepositoryAdapter) hasReconciler() bool {
+	return true
+}
diff --git a/cmd/flux/resume.go b/cmd/flux/resume.go
@@ -56,6 +56,7 @@ type resumable interface {
 	copyable
 	statusable
 	setUnsuspended()
+	hasReconciler() bool
 	successMessage() string
 }
 
@@ -212,8 +213,13 @@ func (resume resumeCommand) reconcile(ctx context.Context, res resumable) reconc
 
 	logger.Waitingf("waiting for %s reconciliation", resume.kind)
 
-	if err := wait.PollImmediate(rootArgs.pollInterval, rootArgs.timeout,
-		isObjectReadyConditionFunc(ctx, resume.client, namespacedName, res.asClientObject())); err != nil {
+	readyConditionFunc := isObjectReadyConditionFunc(ctx, resume.client, namespacedName, res.asClientObject())
+	if !res.hasReconciler() {
+		// Objects without reconciler are static objects.
+		readyConditionFunc = isStaticObjectReadyConditionFunc(ctx, resume.client, namespacedName, res.asClientObject())
+	}
+
+	if err := wait.PollImmediate(rootArgs.pollInterval, rootArgs.timeout, readyConditionFunc); err != nil {
 		return reconcileResponse{
 			resumable: res,
 			err:       err,

diff --git a/cmd/flux/resume_alert.go b/cmd/flux/resume_alert.go
@@ -55,6 +55,10 @@ func (obj alertAdapter) successMessage() string {
 	return "Alert reconciliation completed"
 }
 
+func (a alertAdapter) hasReconciler() bool {
+	return false
+}
+
 func (a alertListAdapter) resumeItem(i int) resumable {
 	return &alertAdapter{&a.AlertList.Items[i]}
 }
diff --git a/cmd/flux/resume_alertprovider.go b/cmd/flux/resume_alertprovider.go
@@ -55,6 +55,10 @@ func (obj alertProviderAdapter) successMessage() string {
 	return "Provider reconciliation completed"
 }
 
+func (a alertProviderAdapter) hasReconciler() bool {
+	return false
+}
+
 func (a alertProviderListAdapter) resumeItem(i int) resumable {
 	return &alertProviderAdapter{&a.ProviderList.Items[i]}
 }