Merge pull request #1169 from JameelB/fix/ensure-folders-are-updated-…

…on-resync fix: ensure folder permisisions are updated on resync
grafana · Jul 21, 2023 · a51ee18 · a51ee18
2 parents ffd4174 + 159ab76
commit a51ee18
Show file tree

Hide file tree

Showing 8 changed files with 44 additions and 4 deletions.
diff --git a/api/v1beta1/grafanafolder_types.go b/api/v1beta1/grafanafolder_types.go
@@ -55,6 +55,8 @@ type GrafanaFolderStatus struct {
 	Hash string `json:"hash,omitempty"`
 	// The folder instanceSelector can't find matching grafana instances
 	NoMatchingInstances bool `json:"NoMatchingInstances,omitempty"`
+	// Last time the folder was resynced
+	LastResync metav1.Time `json:"lastResync,omitempty"`
 }
 
 //+kubebuilder:object:root=true
@@ -133,3 +135,8 @@ func (in *GrafanaFolder) GetResyncPeriod() time.Duration {
 
 	return duration
 }
+
+func (in *GrafanaFolder) ResyncPeriodHasElapsed() bool {
+	deadline := in.Status.LastResync.Add(in.GetResyncPeriod())
+	return time.Now().After(deadline)
+}
diff --git a/api/v1beta1/zz_generated.deepcopy.go b/api/v1beta1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/grafana.integreatly.org_grafanafolders.yaml b/config/crd/bases/grafana.integreatly.org_grafanafolders.yaml
@@ -75,6 +75,9 @@ spec:
                 type: boolean
               hash:
                 type: string
+              lastResync:
+                format: date-time
+                type: string
             type: object
         type: object
     served: true

diff --git a/config/grafana.integreatly.org_grafanafolders.yaml b/config/grafana.integreatly.org_grafanafolders.yaml
@@ -115,6 +115,10 @@ spec:
                   of cluster Important: Run "make" to regenerate code after modifying
                   this file'
                 type: string
+              lastResync:
+                description: Last time the folder was resynced
+                format: date-time
+                type: string
             type: object
         type: object
     served: true

diff --git a/controllers/grafanafolder_controller.go b/controllers/grafanafolder_controller.go
@@ -28,6 +28,7 @@ import (
 	"github.com/grafana-operator/grafana-operator/v5/controllers/metrics"
 	grapi "github.com/grafana/grafana-api-golang-client"
 	"k8s.io/apimachinery/pkg/api/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
 	"github.com/grafana-operator/grafana-operator/v5/api/v1beta1"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -202,7 +203,10 @@ func (r *GrafanaFolderReconciler) Reconcile(ctx context.Context, req ctrl.Reques
 		return ctrl.Result{RequeueAfter: RequeueDelay}, nil
 	}
 
-	return ctrl.Result{RequeueAfter: folder.GetResyncPeriod()}, nil
+	if folder.ResyncPeriodHasElapsed() {
+		folder.Status.LastResync = metav1.Time{Time: time.Now()}
+	}
+	return ctrl.Result{RequeueAfter: folder.GetResyncPeriod()}, r.UpdateStatus(ctx, folder)
 }
 
 // SetupWithManager sets up the controller with the Manager.
@@ -289,6 +293,11 @@ func (r *GrafanaFolderReconciler) onFolderCreated(ctx context.Context, grafana *
 		return err
 	}
 
+	// always update after resync period has elapsed even if cr is unchanged.
+	if exists && cr.Unchanged() && !cr.ResyncPeriodHasElapsed() {
+		return nil
+	}
+
 	if exists {
 		// Add to status to cover cases:
 		// - operator have previously failed to update status
@@ -330,7 +339,7 @@ func (r *GrafanaFolderReconciler) onFolderCreated(ctx context.Context, grafana *
 	}
 
 	// NOTE: it's up to a user to reset permissions with correct json
-	if !cr.Unchanged() && cr.Spec.Permissions != "" {
+	if cr.Spec.Permissions != "" {
 		permissions := grapi.PermissionItems{}
 		err = json.Unmarshal([]byte(cr.Spec.Permissions), &permissions)
 		if err != nil {
@@ -343,7 +352,7 @@ func (r *GrafanaFolderReconciler) onFolderCreated(ctx context.Context, grafana *
 		}
 	}
 
-	return r.UpdateStatus(ctx, cr)
+	return nil
 }
 
 func (r *GrafanaFolderReconciler) UpdateStatus(ctx context.Context, cr *v1beta1.GrafanaFolder) error {

diff --git a/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanafolders.yaml b/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanafolders.yaml
@@ -75,6 +75,9 @@ spec:
                 type: boolean
               hash:
                 type: string
+              lastResync:
+                format: date-time
+                type: string
             type: object
         type: object
     served: true

diff --git a/deploy/kustomize/base/crds.yaml b/deploy/kustomize/base/crds.yaml
@@ -639,6 +639,10 @@ spec:
                   of cluster Important: Run "make" to regenerate code after modifying
                   this file'
                 type: string
+              lastResync:
+                description: Last time the folder was resynced
+                format: date-time
+                type: string
             type: object
         type: object
     served: true

diff --git a/docs/docs/api.md b/docs/docs/api.md
@@ -1506,6 +1506,15 @@ GrafanaFolderStatus defines the observed state of GrafanaFolder
           INSERT ADDITIONAL STATUS FIELD - define observed state of cluster Important: Run "make" to regenerate code after modifying this file<br/>
         </td>
         <td>false</td>
+      </tr><tr>
+        <td><b>lastResync</b></td>
+        <td>string</td>
+        <td>
+          Last time the folder was resynced<br/>
+          <br/>
+            <i>Format</i>: date-time<br/>
+        </td>
+        <td>false</td>
       </tr></tbody>
 </table>