Merge pull request #1739 from chenlujjj/feat/notificationpolicy-editable

Add editable field to GrafanaNotificationPolicySpec
grafana · Nov 4, 2024 · d3f95e4 · d3f95e4
2 parents de966dd + 5578cc8
commit d3f95e4
Show file tree

Hide file tree

Showing 7 changed files with 49 additions and 2 deletions.
diff --git a/api/v1beta1/grafananotificationpolicy_types.go b/api/v1beta1/grafananotificationpolicy_types.go
@@ -38,6 +38,11 @@ type GrafanaNotificationPolicySpec struct {
 
 	// Routes for alerts to match against
 	Route *Route `json:"route"`
+
+	// Whether to enable or disable editing of the notification policy in Grafana UI
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
+	// +optional
+	Editable *bool `json:"editable,omitempty"`
 }
 
 type Route struct {

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_grafananotificationpolicies.yaml b/config/crd/bases/grafana.integreatly.org_grafananotificationpolicies.yaml
@@ -43,6 +43,13 @@ spec:
             description: GrafanaNotificationPolicySpec defines the desired state of
               GrafanaNotificationPolicy
             properties:
+              editable:
+                description: Whether to enable or disable editing of the notification
+                  policy in Grafana UI
+                type: boolean
+                x-kubernetes-validations:
+                - message: Value is immutable
+                  rule: self == oldSelf
               instanceSelector:
                 description: selects Grafanas for import
                 properties:

diff --git a/controllers/notificationpolicy_controller.go b/controllers/notificationpolicy_controller.go
@@ -160,8 +160,15 @@ func (r *GrafanaNotificationPolicyReconciler) reconcileWithInstance(ctx context.
 		return fmt.Errorf("building grafana client: %w", err)
 	}
 
-	strue := "true"
-	params := provisioning.NewPutPolicyTreeParams().WithBody(notificationPolicy.Spec.Route.ToModelRoute()).WithXDisableProvenance(&strue)
+	trueRef := "true"
+	editable := true
+	if notificationPolicy.Spec.Editable != nil && !*notificationPolicy.Spec.Editable {
+		editable = false
+	}
+	params := provisioning.NewPutPolicyTreeParams().WithBody(notificationPolicy.Spec.Route.ToModelRoute())
+	if editable {
+		params.SetXDisableProvenance(&trueRef)
+	}
 	if _, err := cl.Provisioning.PutPolicyTree(params); err != nil { //nolint:errcheck
 		return fmt.Errorf("applying notification policy: %w", err)
 	}

diff --git a/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafananotificationpolicies.yaml b/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafananotificationpolicies.yaml
@@ -43,6 +43,13 @@ spec:
             description: GrafanaNotificationPolicySpec defines the desired state of
               GrafanaNotificationPolicy
             properties:
+              editable:
+                description: Whether to enable or disable editing of the notification
+                  policy in Grafana UI
+                type: boolean
+                x-kubernetes-validations:
+                - message: Value is immutable
+                  rule: self == oldSelf
               instanceSelector:
                 description: selects Grafanas for import
                 properties:

diff --git a/deploy/kustomize/base/crds.yaml b/deploy/kustomize/base/crds.yaml
@@ -1593,6 +1593,13 @@ spec:
             description: GrafanaNotificationPolicySpec defines the desired state of
               GrafanaNotificationPolicy
             properties:
+              editable:
+                description: Whether to enable or disable editing of the notification
+                  policy in Grafana UI
+                type: boolean
+                x-kubernetes-validations:
+                - message: Value is immutable
+                  rule: self == oldSelf
               instanceSelector:
                 description: selects Grafanas for import
                 properties:

diff --git a/docs/docs/api.md b/docs/docs/api.md
@@ -3228,6 +3228,15 @@ GrafanaNotificationPolicySpec defines the desired state of GrafanaNotificationPo
           Routes for alerts to match against<br/>
         </td>
         <td>true</td>
+      </tr><tr>
+        <td><b>editable</b></td>
+        <td>boolean</td>
+        <td>
+          Whether to enable or disable editing of the notification policy in Grafana UI<br/>
+          <br/>
+            <i>Validations</i>:<li>self == oldSelf: Value is immutable</li>
+        </td>
+        <td>false</td>
       </tr><tr>
         <td><b>resyncPeriod</b></td>
         <td>string</td>