Merge pull request #61 from PDOK/jd/status-subresource

Use shared status update

Author: jelledijkstra97

api/v3/atom_types.go

@@ -229,14 +229,21 @@ type SRS struct {
 // versionName=v3
 // +kubebuilder:storageversion
 // +kubebuilder:resource:categories=pdok
+// +kubebuilder:printcolumn:name="ReadyPods",type=integer,JSONPath=`.status.podSummary[0].ready`
+// +kubebuilder:printcolumn:name="DesiredPods",type=integer,JSONPath=`.status.podSummary[0].total`
+// +kubebuilder:printcolumn:name="ReconcileStatus",type=string,JSONPath=`.status.conditions[?(@.type == "Reconciled")].reason`
 
 // Atom is the Schema for the atoms API.
 type Atom struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
-	Spec   AtomSpec                            `json:"spec"`
-	Status *smoothoperatormodel.OperatorStatus `json:"status,omitempty"`
+	Spec   AtomSpec                           `json:"spec"`
+	Status smoothoperatormodel.OperatorStatus `json:"status,omitempty"`
+}
+
+func (a *Atom) OperatorStatus() *smoothoperatormodel.OperatorStatus {
+	return &a.Status
 }
 
 // +kubebuilder:object:root=true
@@ -268,8 +275,8 @@ func GetBlobEndpoint() string {
 	return blobEndpoint
 }
 
-func (r *Atom) GetDownloadLinks() (downloadLinks []DownloadLink) {
-	for _, datasetFeed := range r.Spec.Service.DatasetFeeds {
+func (a *Atom) GetDownloadLinks() (downloadLinks []DownloadLink) {
+	for _, datasetFeed := range a.Spec.Service.DatasetFeeds {
 		for _, entry := range datasetFeed.Entries {
 			downloadLinks = append(downloadLinks, entry.DownloadLinks...)
 		}

api/v3/zz_generated.deepcopy.go

@@ -16,7 +16,17 @@ spec:
     singular: atom
   scope: Namespaced
   versions:
-  - name: v3
+  - additionalPrinterColumns:
+    - jsonPath: .status.podSummary[0].ready
+      name: ReadyPods
+      type: integer
+    - jsonPath: .status.podSummary[0].total
+      name: DesiredPods
+      type: integer
+    - jsonPath: .status.conditions[?(@.type == "Reconciled")].reason
+      name: ReconcileStatus
+      type: string
+    name: v3
     schema:
       openAPIV3Schema:
         description: Atom is the Schema for the atoms API.
@@ -487,6 +497,33 @@ spec:
                 description: The result of creating or updating of each derived resource
                   for this Atom.
                 type: object
+              podSummary:
+                description: Summary of status of pods that belong to this resource
+                items:
+                  properties:
+                    available:
+                      format: int32
+                      type: integer
+                    generation:
+                      format: int32
+                      type: integer
+                    ready:
+                      format: int32
+                      type: integer
+                    total:
+                      format: int32
+                      type: integer
+                    unavailable:
+                      format: int32
+                      type: integer
+                  required:
+                  - available
+                  - generation
+                  - ready
+                  - total
+                  - unavailable
+                  type: object
+                type: array
             type: object
         required:
         - spec

config/crd/bases/pdok.nl_atoms.yaml

@@ -27,6 +27,14 @@ rules:
   - list
   - update
   - watch
+- apiGroups:
+  - apps
+  resources:
+  - replicasets
+  verbs:
+  - get
+  - list
+  - watch
 - apiGroups:
   - pdok.nl
   resources:

config/rbac/role.yaml

@@ -11,7 +11,7 @@ require (
 	github.com/onsi/ginkgo/v2 v2.22.1
 	github.com/onsi/gomega v1.36.2
 	github.com/pdok/atom-generator v0.6.4
-	github.com/pdok/smooth-operator v1.0.0
+	github.com/pdok/smooth-operator v1.2.0
 	github.com/peterbourgon/ff v1.7.1
 	github.com/pkg/errors v0.9.1
 	github.com/stretchr/testify v1.10.0

go.mod

@@ -152,8 +152,8 @@ github.com/patrickmn/go-cache v2.1.0+incompatible h1:HRMgzkcYKYpi3C8ajMPV8OFXaaR
 github.com/patrickmn/go-cache v2.1.0+incompatible/go.mod h1:3Qf8kWWT7OJRJbdiICTKqZju1ZixQ/KpMGzzAfe6+WQ=
 github.com/pdok/atom-generator v0.6.4 h1:UpTTSKskdWLnxTAhSNOlz8dF2tBousD97V03kWzCV2k=
 github.com/pdok/atom-generator v0.6.4/go.mod h1:IlPwti5ocXDTjB4xmz0ZpHCOW/suuW5gQMfjfwPX6uM=
-github.com/pdok/smooth-operator v1.0.0 h1:Gp5DG2FQ3uujxWQX/647ZcyVk2EhNZPBD+lMxpLHotI=
-github.com/pdok/smooth-operator v1.0.0/go.mod h1:przwM7mBGmNPqabyhImKVZ15WL4zbqLqH4ExbuWKhWE=
+github.com/pdok/smooth-operator v1.2.0 h1:KFFNsFzk16IfcHPmHkgJnmbhIIY69k7crhPft3lXih8=
+github.com/pdok/smooth-operator v1.2.0/go.mod h1:tqr/CDCXZHNzQzQVlSAnCmsPlx9tWAObsj8hg9mSSEU=
 github.com/pelletier/go-toml v1.6.0/go.mod h1:5N711Q9dKgbdkxHL+MEfF31hpT7l0S0s/t2kKREewys=
 github.com/peterbourgon/ff v1.7.1 h1:xt1lxTG+Nr2+tFtysY7abFgPoH3Lug8CwYJMOmJRXhk=
 github.com/peterbourgon/ff v1.7.1/go.mod h1:fYI5YA+3RDqQRExmFbHnBjEeWzh9TrS8rnRpEq7XIg0=

go.sum

@@ -28,6 +28,7 @@ package controller
 import (
 	"context"
 	"fmt"
+	"strings"
 	"time"
 
 	"github.com/pkg/errors"
@@ -39,6 +40,7 @@ import (
 
 	pdoknlv3 "github.com/pdok/atom-operator/api/v3"
 	smoothoperatorv1 "github.com/pdok/smooth-operator/api/v1"
+	smoothoperatorstatus "github.com/pdok/smooth-operator/pkg/status"
 	smoothutil "github.com/pdok/smooth-operator/pkg/util"
 
 	traefikiov1alpha1 "github.com/traefik/traefik/v3/pkg/provider/kubernetes/crd/traefikio/v1alpha1"
@@ -51,12 +53,6 @@ import (
 	logf "sigs.k8s.io/controller-runtime/pkg/log"
 )
 
-const (
-	reconciledConditionType          = "Reconciled"
-	reconciledConditionReasonSuccess = "Success"
-	reconciledConditionReasonError   = "Error"
-)
-
 const (
 	appLabelKey       = "pdok.nl/app"
 	appName           = "atom-service"
@@ -87,6 +83,7 @@ type AtomReconciler struct {
 // +kubebuilder:rbac:groups=pdok.nl,resources=ownerinfo,verbs=get;list;watch
 // +kubebuilder:rbac:groups=pdok.nl,resources=ownerinfo/status,verbs=get
 // +kubebuilder:rbac:groups=apps,resources=deployments,verbs=get;list;watch;create;update;delete
+// +kubebuilder:rbac:groups=apps,resources=replicasets,verbs=get;list;watch;
 // +kubebuilder:rbac:groups=core,resources=configmaps;services,verbs=watch;create;get;update;list;delete
 // +kubebuilder:rbac:groups=traefik.io,resources=ingressroutes;middlewares,verbs=get;list;watch;create;update;delete
 // +kubebuilder:rbac:groups=policy,resources=poddisruptionbudgets,verbs=create;update;delete;list;watch
@@ -138,7 +135,7 @@ func (r *AtomReconciler) Reconcile(ctx context.Context, req ctrl.Request) (resul
 	defer func() {
 		if rec := recover(); rec != nil {
 			err = recoveredPanicToError(rec)
-			r.logAndUpdateStatusError(ctx, atom, err)
+			smoothoperatorstatus.LogAndUpdateStatusError(ctx, r.Client, atom, err)
 		}
 	}()
 
@@ -153,11 +150,11 @@ func (r *AtomReconciler) Reconcile(ctx context.Context, req ctrl.Request) (resul
 	operationResults, err := r.createOrUpdateAllForAtom(ctx, atom, ownerInfo)
 	if err != nil {
 		lgr.Info("failed creating resources for atom", "atom", atom)
-		r.logAndUpdateStatusError(ctx, atom, err)
+		smoothoperatorstatus.LogAndUpdateStatusError(ctx, r.Client, atom, err)
 		return result, err
 	}
 	lgr.Info("finished creating resources for atom", "atom", atom)
-	r.logAndUpdateStatusFinished(ctx, atom, operationResults)
+	smoothoperatorstatus.LogAndUpdateStatusFinished(ctx, r.Client, atom, operationResults)
 
 	return result, err
 }
@@ -186,7 +183,7 @@ func (r *AtomReconciler) createOrUpdateAllForAtom(ctx context.Context, atom *pdo
 	operationResults[smoothutil.GetObjectFullName(r.Client, deployment)], err = controllerutil.CreateOrUpdate(ctx, r.Client, deployment, func() error {
 		return r.mutateDeployment(atom, deployment, configMap.GetName())
 	})
-	if err != nil {
+	if err != nil && !strings.Contains(err.Error(), "the object has been modified; please apply your changes to the latest version and try again") {
 		return operationResults, fmt.Errorf("unable to create/update resource %s: %w", smoothutil.GetObjectFullName(c, deployment), err)
 	}
 	// endregion
@@ -267,6 +264,7 @@ func (r *AtomReconciler) SetupWithManager(mgr ctrl.Manager) error {
 		Owns(&traefikiov1alpha1.IngressRoute{}, builder.WithPredicates(predicate.GenerationChangedPredicate{})).
 		Owns(&policyv1.PodDisruptionBudget{}, builder.WithPredicates(predicate.GenerationChangedPredicate{})).
 		Owns(&smoothoperatorv1.OwnerInfo{}, builder.WithPredicates(predicate.GenerationChangedPredicate{})).
+		Watches(&appsv1.ReplicaSet{}, smoothoperatorstatus.GetReplicaSetEventHandlerForObj(mgr, "Atom")).
 		Complete(r)
 }