Update report after instance reconciliation

Signed-off-by: Stefan Prodan <[email protected]>

Author: stefanprodan

docs/api/v1/fluxreport.md

@@ -244,6 +244,15 @@ spec:
     status: 'Applied revision: refs/heads/main@sha1:a90cd1ac35de01c175f7199315d3f4cd60195911'
 ```
 
+## Generating a FluxReport
+
+The FluxReport is automatically generated by the operator for the following conditions:
+
+- At startup, when the operator is installed or upgraded.
+- When the [FluxInstance](fluxinstance.md) is created or updated.
+- When the `reconcile.fluxcd.io/requestedAt` annotation is set on the FluxReport resource.
+- At regular intervals, controlled by the `fluxcd.controlplane.io/reconcileEvery` annotation.
+
 ### Reconciliation configuration
 
 The reconciliation behaviour can be configured using the following annotations:

internal/controller/fluxinstance_controller.go

@@ -32,6 +32,7 @@ import (
 	fluxcdv1 "github.com/controlplaneio-fluxcd/flux-operator/api/v1"
 	"github.com/controlplaneio-fluxcd/flux-operator/internal/builder"
 	"github.com/controlplaneio-fluxcd/flux-operator/internal/inventory"
+	"github.com/controlplaneio-fluxcd/flux-operator/internal/reporter"
 )
 
 // FluxInstanceReconciler reconciles a FluxInstance object
@@ -68,6 +69,12 @@ func (r *FluxInstanceReconciler) Reconcile(ctx context.Context, req ctrl.Request
 			log.Error(err, "failed to update status")
 			retErr = kerrors.NewAggregate([]error{retErr, err})
 		}
+
+		if err := reporter.RequestReportUpdate(ctx,
+			r.Client, fluxcdv1.DefaultInstanceName,
+			r.StatusManager, obj.Namespace); err != nil {
+			log.Error(err, "failed to request report update")
+		}
 	}()
 
 	// Uninstall if the object is under deletion.

internal/controller/fluxreport_controller_test.go

@@ -29,14 +29,24 @@ func TestFluxReportReconciler_Reconcile(t *testing.T) {
 	ns, err := testEnv.CreateNamespace(ctx, "test")
 	g.Expect(err).ToNot(HaveOccurred())
 
+	// Initialize the report.
+	report := &fluxcdv1.FluxReport{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      fluxcdv1.DefaultInstanceName,
+			Namespace: ns.Name,
+		},
+	}
+	err = reportRec.initReport(ctx, report.GetName(), report.GetNamespace())
+	g.Expect(err).ToNot(HaveOccurred())
+
+	// Create the Flux instance.
 	instance := &fluxcdv1.FluxInstance{
 		ObjectMeta: metav1.ObjectMeta{
 			Name:      ns.Name,
 			Namespace: ns.Name,
 		},
 		Spec: getDefaultFluxSpec(),
 	}
-
 	err = testEnv.Create(ctx, instance)
 	g.Expect(err).ToNot(HaveOccurred())
 
@@ -59,17 +69,6 @@ func TestFluxReportReconciler_Reconcile(t *testing.T) {
 	g.Expect(err).ToNot(HaveOccurred())
 	checkInstanceReadiness(g, instance)
 
-	report := &fluxcdv1.FluxReport{
-		ObjectMeta: metav1.ObjectMeta{
-			Name:      fluxcdv1.DefaultInstanceName,
-			Namespace: ns.Name,
-		},
-	}
-
-	// Initialize the report.
-	err = reportRec.initReport(ctx, report.GetName(), report.GetNamespace())
-	g.Expect(err).ToNot(HaveOccurred())
-
 	// Compute instance report.
 	r, err = reportRec.Reconcile(ctx, reconcile.Request{
 		NamespacedName: client.ObjectKeyFromObject(report),
@@ -81,6 +80,9 @@ func TestFluxReportReconciler_Reconcile(t *testing.T) {
 	g.Expect(err).ToNot(HaveOccurred())
 	logObject(t, report)
 
+	// Check annotation set by the instance reconciler.
+	g.Expect(report.GetAnnotations()).To(HaveKey(meta.ReconcileRequestAnnotation))
+
 	// Check reported components.
 	g.Expect(report.Spec.ComponentsStatus).To(HaveLen(len(instance.Status.Components)))
 	g.Expect(report.Spec.ComponentsStatus[0].Name).To(Equal("helm-controller"))
@@ -125,10 +127,11 @@ func TestFluxReportReconciler_Reconcile(t *testing.T) {
 	g.Expect(err).ToNot(HaveOccurred())
 
 	// Read the report and verify distribution.
-	err = testClient.Get(ctx, client.ObjectKeyFromObject(report), report)
+	emptyReport := &fluxcdv1.FluxReport{}
+	err = testClient.Get(ctx, client.ObjectKeyFromObject(report), emptyReport)
 	g.Expect(err).ToNot(HaveOccurred())
-	g.Expect(report.Spec.Distribution.Status).To(Equal("Not Installed"))
-	g.Expect(report.Spec.Distribution.Entitlement).To(Equal("Issued by " + entitlement.DefaultVendor))
+	g.Expect(emptyReport.Spec.Distribution.Status).To(Equal("Not Installed"))
+	g.Expect(emptyReport.Spec.Distribution.Entitlement).To(Equal("Issued by " + entitlement.DefaultVendor))
 }
 
 func getFluxReportReconciler() *FluxReportReconciler {

internal/reporter/reporter.go

@@ -6,7 +6,12 @@ package reporter
 import (
 	"context"
 	"fmt"
+	"strconv"
 
+	"github.com/fluxcd/pkg/apis/meta"
+	"k8s.io/apimachinery/pkg/api/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime/schema"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	fluxcdv1 "github.com/controlplaneio-fluxcd/flux-operator/api/v1"
@@ -65,3 +70,38 @@ func (r *FluxStatusReporter) Compute(ctx context.Context) (fluxcdv1.FluxReportSp
 
 	return report, nil
 }
+
+// RequestReportUpdate annotates the FluxReport object to trigger a reconciliation.
+func RequestReportUpdate(ctx context.Context, kubeClient client.Client, instance, manager, namespace string) error {
+	report := &metav1.PartialObjectMetadata{}
+	report.SetGroupVersionKind(schema.GroupVersionKind{
+		Group:   fluxcdv1.GroupVersion.Group,
+		Kind:    fluxcdv1.FluxReportKind,
+		Version: fluxcdv1.GroupVersion.Version,
+	})
+
+	objectKey := client.ObjectKey{
+		Namespace: namespace,
+		Name:      instance,
+	}
+
+	if err := kubeClient.Get(ctx, objectKey, report); err != nil {
+		if errors.IsNotFound(err) {
+			return nil
+		}
+		return fmt.Errorf("failed to read %s '%s' error: %w", report.Kind, instance, err)
+	}
+
+	patch := client.MergeFrom(report.DeepCopy())
+	annotations := report.GetAnnotations()
+	if annotations == nil {
+		annotations = make(map[string]string)
+	}
+	annotations[meta.ReconcileRequestAnnotation] = strconv.FormatInt(metav1.Now().Unix(), 10)
+	report.SetAnnotations(annotations)
+
+	if err := kubeClient.Patch(ctx, report, patch); err != nil {
+		return fmt.Errorf("failed to annotate %s '%s' error: %w", report.Kind, instance, err)
+	}
+	return nil
+}