feat: Implement spec.uid for ContactPoints (#1730)

grafana · Nov 11, 2024 · 466366f · 466366f
1 parent 3b42b31
commit 466366f
Show file tree

Hide file tree

Showing 7 changed files with 62 additions and 4 deletions.
diff --git a/Makefile b/Makefile
@@ -94,7 +94,7 @@ vet: ## Run go vet against code.
 	go vet ./...
 
 .PHONY: test
-test: manifests generate code/gofumpt api-docs vet envtest ## Run tests.
+test: manifests generate code/gofumpt code/golangci-lint api-docs vet envtest ## Run tests.
 	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./... -coverprofile cover.out
 
 ##@ Build

diff --git a/api/v1beta1/grafanacontactpoint_types.go b/api/v1beta1/grafanacontactpoint_types.go
@@ -25,7 +25,13 @@ import (
 // NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
 
 // GrafanaContactPointSpec defines the desired state of GrafanaContactPoint
+// +kubebuilder:validation:XValidation:rule="((!has(oldSelf.uid) && !has(self.uid)) || (has(oldSelf.uid) && has(self.uid)))", message="spec.uid is immutable"
 type GrafanaContactPointSpec struct {
+	// Manually specify the UID the Contact Point is created with
+	// +optional
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="spec.uid is immutable"
+	CustomUID string `json:"uid,omitempty"`
+
 	// +optional
 	// +kubebuilder:validation:Type=string
 	// +kubebuilder:validation:Format=duration
@@ -84,6 +90,14 @@ type GrafanaContactPointList struct {
 	Items           []GrafanaContactPoint `json:"items"`
 }
 
+// Wrapper around CustomUID or default metadata.uid
+func (in *GrafanaContactPoint) CustomUIDOrUID() string {
+	if in.Spec.CustomUID != "" {
+		return in.Spec.CustomUID
+	}
+	return string(in.ObjectMeta.UID)
+}
+
 func init() {
 	SchemeBuilder.Register(&GrafanaContactPoint{}, &GrafanaContactPointList{})
 }
diff --git a/config/crd/bases/grafana.integreatly.org_grafanacontactpoints.yaml b/config/crd/bases/grafana.integreatly.org_grafanacontactpoints.yaml
@@ -129,6 +129,13 @@ spec:
                 - hipchat
                 - oncall
                 type: string
+              uid:
+                description: Manually specify the UID the Contact Point is created
+                  with
+                type: string
+                x-kubernetes-validations:
+                - message: spec.uid is immutable
+                  rule: self == oldSelf
               valuesFrom:
                 items:
                   properties:
@@ -199,6 +206,10 @@ spec:
             - name
             - settings
             type: object
+            x-kubernetes-validations:
+            - message: spec.uid is immutable
+              rule: ((!has(oldSelf.uid) && !has(self.uid)) || (has(oldSelf.uid) &&
+                has(self.uid)))
           status:
             description: GrafanaContactPointStatus defines the observed state of GrafanaContactPoint
             properties:

diff --git a/controllers/grafanacontactpoint_controller.go b/controllers/grafanacontactpoint_controller.go
@@ -193,7 +193,7 @@ func (r *GrafanaContactPointReconciler) reconcileWithInstance(ctx context.Contex
 			Name:                  contactPoint.Spec.Name,
 			Type:                  &contactPoint.Spec.Type,
 			Settings:              settings,
-			UID:                   string(contactPoint.UID),
+			UID:                   contactPoint.CustomUIDOrUID(),
 		}
 		_, err := cl.Provisioning.PostContactpoints(provisioning.NewPostContactpointsParams().WithBody(cp)) //nolint:errcheck
 		if err != nil {
@@ -245,7 +245,7 @@ func (r *GrafanaContactPointReconciler) getContactPointFromUID(ctx context.Conte
 		return models.EmbeddedContactPoint{}, fmt.Errorf("getting contact points: %w", err)
 	}
 	for _, cp := range remote.Payload {
-		if cp.UID == string(contactPoint.UID) {
+		if cp.UID == contactPoint.CustomUIDOrUID() {
 			return *cp, nil
 		}
 	}
@@ -279,7 +279,7 @@ func (r *GrafanaContactPointReconciler) removeFromInstance(ctx context.Context,
 	if err != nil {
 		return fmt.Errorf("getting contact point by UID: %w", err)
 	}
-	_, err = cl.Provisioning.DeleteContactpoints(string(contactPoint.UID)) //nolint:errcheck
+	_, err = cl.Provisioning.DeleteContactpoints(contactPoint.CustomUIDOrUID()) //nolint:errcheck
 	if err != nil {
 		return fmt.Errorf("deleting contact point: %w", err)
 	}

diff --git a/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanacontactpoints.yaml b/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanacontactpoints.yaml
@@ -129,6 +129,13 @@ spec:
                 - hipchat
                 - oncall
                 type: string
+              uid:
+                description: Manually specify the UID the Contact Point is created
+                  with
+                type: string
+                x-kubernetes-validations:
+                - message: spec.uid is immutable
+                  rule: self == oldSelf
               valuesFrom:
                 items:
                   properties:
@@ -199,6 +206,10 @@ spec:
             - name
             - settings
             type: object
+            x-kubernetes-validations:
+            - message: spec.uid is immutable
+              rule: ((!has(oldSelf.uid) && !has(self.uid)) || (has(oldSelf.uid) &&
+                has(self.uid)))
           status:
             description: GrafanaContactPointStatus defines the observed state of GrafanaContactPoint
             properties:

diff --git a/deploy/kustomize/base/crds.yaml b/deploy/kustomize/base/crds.yaml
@@ -437,6 +437,13 @@ spec:
                 - hipchat
                 - oncall
                 type: string
+              uid:
+                description: Manually specify the UID the Contact Point is created
+                  with
+                type: string
+                x-kubernetes-validations:
+                - message: spec.uid is immutable
+                  rule: self == oldSelf
               valuesFrom:
                 items:
                   properties:
@@ -507,6 +514,10 @@ spec:
             - name
             - settings
             type: object
+            x-kubernetes-validations:
+            - message: spec.uid is immutable
+              rule: ((!has(oldSelf.uid) && !has(self.uid)) || (has(oldSelf.uid) &&
+                has(self.uid)))
           status:
             description: GrafanaContactPointStatus defines the observed state of GrafanaContactPoint
             properties:

diff --git a/docs/docs/api.md b/docs/docs/api.md
@@ -662,6 +662,8 @@ GrafanaContactPoint is the Schema for the grafanacontactpoints API
         <td>object</td>
         <td>
           GrafanaContactPointSpec defines the desired state of GrafanaContactPoint<br/>
+          <br/>
+            <i>Validations</i>:<li>((!has(oldSelf.uid) && !has(self.uid)) || (has(oldSelf.uid) && has(self.uid))): spec.uid is immutable</li>
         </td>
         <td>false</td>
       </tr><tr>
@@ -747,6 +749,15 @@ GrafanaContactPointSpec defines the desired state of GrafanaContactPoint
             <i>Enum</i>: alertmanager, prometheus-alertmanager, dingding, discord, email, googlechat, kafka, line, opsgenie, pagerduty, pushover, sensugo, sensu, slack, teams, telegram, threema, victorops, webhook, wecom, hipchat, oncall<br/>
         </td>
         <td>false</td>
+      </tr><tr>
+        <td><b>uid</b></td>
+        <td>string</td>
+        <td>
+          Manually specify the UID the Contact Point is created with<br/>
+          <br/>
+            <i>Validations</i>:<li>self == oldSelf: spec.uid is immutable</li>
+        </td>
+        <td>false</td>
       </tr><tr>
         <td><b><a href="#grafanacontactpointspecvaluesfromindex">valuesFrom</a></b></td>
         <td>[]object</td>