feat: Define GrafanaCommonStatus struct, add it to resources that are…

… ready
grafana · Nov 12, 2024 · 9d89880 · 9d89880
1 parent 54abb09
commit 9d89880
Show file tree

Hide file tree

Showing 19 changed files with 113 additions and 65 deletions.
diff --git a/api/v1beta1/common.go b/api/v1beta1/common.go
@@ -5,6 +5,8 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
+// WARN Run `make` on all file changes
+
 type ValueFrom struct {
 	TargetPath string          `json:"targetPath"`
 	ValueFrom  ValueFromSource `json:"valueFrom"`
@@ -37,3 +39,14 @@ type GrafanaCommonSpec struct {
 	// +optional
 	AllowCrossNamespaceImport *bool `json:"allowCrossNamespaceImport,omitempty"`
 }
+
+// The most recent observed state of a Grafana resource
+type GrafanaCommonStatus struct {
+	// Detect resource changes
+	Hash        string `json:"hash,omitempty"`
+	LastMessage string `json:"lastMessage,omitempty"`
+	// Last time the resource was synchronized
+	LastResync metav1.Time `json:"lastResync,omitempty"`
+	// Results when synchonizing resource with Grafana instances
+	Conditions []metav1.Condition `json:"conditions,omitempty"`
+}
diff --git a/api/v1beta1/grafanaalertrulegroup_types.go b/api/v1beta1/grafanaalertrulegroup_types.go
@@ -116,8 +116,10 @@ type AlertQuery struct {
 	RelativeTimeRange *models.RelativeTimeRange `json:"relativeTimeRange,omitempty"`
 }
 
+// TODO Implement GrafanaCommonStatus
 // GrafanaAlertRuleGroupStatus defines the observed state of GrafanaAlertRuleGroup
 type GrafanaAlertRuleGroupStatus struct {
+	// Results when synchonizing resource with Grafana instances
 	Conditions []metav1.Condition `json:"conditions"`
 }
 

diff --git a/api/v1beta1/grafanacontactpoint_types.go b/api/v1beta1/grafanacontactpoint_types.go
@@ -49,10 +49,10 @@ type GrafanaContactPointSpec struct {
 	Type string `json:"type,omitempty"`
 }
 
+// TODO Implement GrafanaCommonStatus
 // GrafanaContactPointStatus defines the observed state of GrafanaContactPoint
 type GrafanaContactPointStatus struct {
-	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
-	// Important: Run "make" to regenerate code after modifying this file
+	// Results when synchonizing resource with Grafana instances
 	Conditions []metav1.Condition `json:"conditions"`
 }
 

diff --git a/api/v1beta1/grafanadashboard_types.go b/api/v1beta1/grafanadashboard_types.go
@@ -166,17 +166,15 @@ type GrafanaComDashboardReference struct {
 
 // GrafanaDashboardStatus defines the observed state of GrafanaDashboard
 type GrafanaDashboardStatus struct {
+	GrafanaCommonStatus `json:",inline"`
+
 	ContentCache     []byte      `json:"contentCache,omitempty"`
 	ContentTimestamp metav1.Time `json:"contentTimestamp,omitempty"`
 	ContentUrl       string      `json:"contentUrl,omitempty"`
-	Hash             string      `json:"hash,omitempty"`
+	// TODO(V1) Remove
 	// The dashboard instanceSelector can't find matching grafana instances
-	NoMatchingInstances bool `json:"NoMatchingInstances,omitempty"`
-	// Last time the dashboard was resynced
-	LastResync metav1.Time `json:"lastResync,omitempty"`
-	UID        string      `json:"uid,omitempty"`
-
-	Conditions []metav1.Condition `json:"conditions,omitempty"`
+	NoMatchingInstances bool   `json:"NoMatchingInstances,omitempty"`
+	UID                 string `json:"uid,omitempty"`
 }
 
 //+kubebuilder:object:root=true

diff --git a/api/v1beta1/grafanafolder_types.go b/api/v1beta1/grafanafolder_types.go
@@ -58,14 +58,11 @@ type GrafanaFolderSpec struct {
 
 // GrafanaFolderStatus defines the observed state of GrafanaFolder
 type GrafanaFolderStatus struct {
-	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
-	// Important: Run "make" to regenerate code after modifying this file
-	Hash string `json:"hash,omitempty"`
+	GrafanaCommonStatus `json:",inline"`
+
+	// TODO(V1) Remove
 	// 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"`
-	Conditions []metav1.Condition `json:"conditions,omitempty"`
 }
 
 //+kubebuilder:object:root=true

diff --git a/api/v1beta1/grafananotificationpolicy_types.go b/api/v1beta1/grafananotificationpolicy_types.go
@@ -125,8 +125,10 @@ func (r *Route) ToModelRoute() *models.Route {
 	return out
 }
 
+// TODO Implement GrafanaCommonStatus
 // GrafanaNotificationPolicyStatus defines the observed state of GrafanaNotificationPolicy
 type GrafanaNotificationPolicyStatus struct {
+	// Results when synchonizing resource with Grafana instances
 	Conditions []metav1.Condition `json:"conditions"`
 }
 

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_grafanaalertrulegroups.yaml b/config/crd/bases/grafana.integreatly.org_grafanaalertrulegroups.yaml
@@ -248,6 +248,7 @@ spec:
               GrafanaAlertRuleGroup
             properties:
               conditions:
+                description: Results when synchonizing resource with Grafana instances
                 items:
                   description: Condition contains details for one aspect of the current
                     state of this API Resource.

diff --git a/config/crd/bases/grafana.integreatly.org_grafanacontactpoints.yaml b/config/crd/bases/grafana.integreatly.org_grafanacontactpoints.yaml
@@ -218,9 +218,7 @@ spec:
             description: GrafanaContactPointStatus defines the observed state of GrafanaContactPoint
             properties:
               conditions:
-                description: |-
-                  INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
-                  Important: Run "make" to regenerate code after modifying this file
+                description: Results when synchonizing resource with Grafana instances
                 items:
                   description: Condition contains details for one aspect of the current
                     state of this API Resource.

diff --git a/config/crd/bases/grafana.integreatly.org_grafanadashboards.yaml b/config/crd/bases/grafana.integreatly.org_grafanadashboards.yaml
@@ -416,6 +416,7 @@ spec:
                   instances
                 type: boolean
               conditions:
+                description: Results when synchonizing resource with Grafana instances
                 items:
                   description: Condition contains details for one aspect of the current
                     state of this API Resource.
@@ -480,9 +481,12 @@ spec:
               contentUrl:
                 type: string
               hash:
+                description: Detect resource changes
+                type: string
+              lastMessage:
                 type: string
               lastResync:
-                description: Last time the dashboard was resynced
+                description: Last time the resource was synchronized
                 format: date-time
                 type: string
               uid:

diff --git a/config/crd/bases/grafana.integreatly.org_grafanafolders.yaml b/config/crd/bases/grafana.integreatly.org_grafanafolders.yaml
@@ -148,6 +148,7 @@ spec:
                   instances
                 type: boolean
               conditions:
+                description: Results when synchonizing resource with Grafana instances
                 items:
                   description: Condition contains details for one aspect of the current
                     state of this API Resource.
@@ -204,12 +205,12 @@ spec:
                   type: object
                 type: array
               hash:
-                description: |-
-                  INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
-                  Important: Run "make" to regenerate code after modifying this file
+                description: Detect resource changes
+                type: string
+              lastMessage:
                 type: string
               lastResync:
-                description: Last time the folder was resynced
+                description: Last time the resource was synchronized
                 format: date-time
                 type: string
             type: object

diff --git a/config/crd/bases/grafana.integreatly.org_grafananotificationpolicies.yaml b/config/crd/bases/grafana.integreatly.org_grafananotificationpolicies.yaml
@@ -191,6 +191,7 @@ spec:
               of GrafanaNotificationPolicy
             properties:
               conditions:
+                description: Results when synchonizing resource with Grafana instances
                 items:
                   description: Condition contains details for one aspect of the current
                     state of this API Resource.

diff --git a/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanaalertrulegroups.yaml b/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanaalertrulegroups.yaml
@@ -248,6 +248,7 @@ spec:
               GrafanaAlertRuleGroup
             properties:
               conditions:
+                description: Results when synchonizing resource with Grafana instances
                 items:
                   description: Condition contains details for one aspect of the current
                     state of this API Resource.

diff --git a/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanacontactpoints.yaml b/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanacontactpoints.yaml
@@ -218,9 +218,7 @@ spec:
             description: GrafanaContactPointStatus defines the observed state of GrafanaContactPoint
             properties:
               conditions:
-                description: |-
-                  INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
-                  Important: Run "make" to regenerate code after modifying this file
+                description: Results when synchonizing resource with Grafana instances
                 items:
                   description: Condition contains details for one aspect of the current
                     state of this API Resource.

diff --git a/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanadashboards.yaml b/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanadashboards.yaml
@@ -416,6 +416,7 @@ spec:
                   instances
                 type: boolean
               conditions:
+                description: Results when synchonizing resource with Grafana instances
                 items:
                   description: Condition contains details for one aspect of the current
                     state of this API Resource.
@@ -480,9 +481,12 @@ spec:
               contentUrl:
                 type: string
               hash:
+                description: Detect resource changes
+                type: string
+              lastMessage:
                 type: string
               lastResync:
-                description: Last time the dashboard was resynced
+                description: Last time the resource was synchronized
                 format: date-time
                 type: string
               uid:

diff --git a/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanafolders.yaml b/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanafolders.yaml
@@ -148,6 +148,7 @@ spec:
                   instances
                 type: boolean
               conditions:
+                description: Results when synchonizing resource with Grafana instances
                 items:
                   description: Condition contains details for one aspect of the current
                     state of this API Resource.
@@ -204,12 +205,12 @@ spec:
                   type: object
                 type: array
               hash:
-                description: |-
-                  INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
-                  Important: Run "make" to regenerate code after modifying this file
+                description: Detect resource changes
+                type: string
+              lastMessage:
                 type: string
               lastResync:
-                description: Last time the folder was resynced
+                description: Last time the resource was synchronized
                 format: date-time
                 type: string
             type: object

diff --git a/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafananotificationpolicies.yaml b/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafananotificationpolicies.yaml
@@ -191,6 +191,7 @@ spec:
               of GrafanaNotificationPolicy
             properties:
               conditions:
+                description: Results when synchonizing resource with Grafana instances
                 items:
                   description: Condition contains details for one aspect of the current
                     state of this API Resource.

diff --git a/deploy/kustomize/base/crds.yaml b/deploy/kustomize/base/crds.yaml
@@ -247,6 +247,7 @@ spec:
               GrafanaAlertRuleGroup
             properties:
               conditions:
+                description: Results when synchonizing resource with Grafana instances
                 items:
                   description: Condition contains details for one aspect of the current
                     state of this API Resource.
@@ -530,9 +531,7 @@ spec:
             description: GrafanaContactPointStatus defines the observed state of GrafanaContactPoint
             properties:
               conditions:
-                description: |-
-                  INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
-                  Important: Run "make" to regenerate code after modifying this file
+                description: Results when synchonizing resource with Grafana instances
                 items:
                   description: Condition contains details for one aspect of the current
                     state of this API Resource.
@@ -1014,6 +1013,7 @@ spec:
                   instances
                 type: boolean
               conditions:
+                description: Results when synchonizing resource with Grafana instances
                 items:
                   description: Condition contains details for one aspect of the current
                     state of this API Resource.
@@ -1078,9 +1078,12 @@ spec:
               contentUrl:
                 type: string
               hash:
+                description: Detect resource changes
+                type: string
+              lastMessage:
                 type: string
               lastResync:
-                description: Last time the dashboard was resynced
+                description: Last time the resource was synchronized
                 format: date-time
                 type: string
               uid:
@@ -1510,6 +1513,7 @@ spec:
                   instances
                 type: boolean
               conditions:
+                description: Results when synchonizing resource with Grafana instances
                 items:
                   description: Condition contains details for one aspect of the current
                     state of this API Resource.
@@ -1566,12 +1570,12 @@ spec:
                   type: object
                 type: array
               hash:
-                description: |-
-                  INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
-                  Important: Run "make" to regenerate code after modifying this file
+                description: Detect resource changes
+                type: string
+              lastMessage:
                 type: string
               lastResync:
-                description: Last time the folder was resynced
+                description: Last time the resource was synchronized
                 format: date-time
                 type: string
             type: object
@@ -1773,6 +1777,7 @@ spec:
               of GrafanaNotificationPolicy
             properties:
               conditions:
+                description: Results when synchonizing resource with Grafana instances
                 items:
                   description: Condition contains details for one aspect of the current
                     state of this API Resource.