Add event metadata field to HelmRelease spec

Signed-off-by: Matheus Pimenta <[email protected]>
fluxcd · May 1, 2023 · d72d562 · d72d562
1 parent d1cc2fe
commit d72d562
Show file tree

Hide file tree

Showing 6 changed files with 64 additions and 0 deletions.
diff --git a/api/v2beta1/helmrelease_types.go b/api/v2beta1/helmrelease_types.go
@@ -184,6 +184,12 @@ type HelmReleaseSpec struct {
 	// of their definition.
 	// +optional
 	PostRenderers []PostRenderer `json:"postRenderers,omitempty"`
+
+	// EventMetadata is an optional field for adding metadata to events emitted by the
+	// controller. Metadata fields added by the controller have priority over the fields
+	// added here.
+	// +optional
+	EventMetadata map[string]string `json:"eventMetadata,omitempty"`
 }
 
 // GetInstall returns the configuration for Helm install actions for the

diff --git a/api/v2beta1/zz_generated.deepcopy.go b/api/v2beta1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/helm.toolkit.fluxcd.io_helmreleases.yaml b/config/crd/bases/helm.toolkit.fluxcd.io_helmreleases.yaml
@@ -198,6 +198,13 @@ spec:
                   - name
                   type: object
                 type: array
+              eventMetadata:
+                additionalProperties:
+                  type: string
+                description: EventMetadata is an optional field for adding metadata
+                  to events emitted by the controller. Metadata fields added by the
+                  controller have priority over the fields added here.
+                type: object
               install:
                 description: Install holds the configuration for Helm install actions
                   for this HelmRelease.

diff --git a/docs/api/helmrelease.md b/docs/api/helmrelease.md
@@ -357,6 +357,20 @@ Kubernetes pkg/apis/apiextensions/v1.JSON
 of their definition.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>eventMetadata</code><br>
+<em>
+map[string]string
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>EventMetadata is an optional field for adding metadata to events emitted by the
+controller. Metadata fields added by the controller have priority over the fields
+added here.</p>
+</td>
+</tr>
 </table>
 </td>
 </tr>
@@ -1166,6 +1180,20 @@ Kubernetes pkg/apis/apiextensions/v1.JSON
 of their definition.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>eventMetadata</code><br>
+<em>
+map[string]string
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>EventMetadata is an optional field for adding metadata to events emitted by the
+controller. Metadata fields added by the controller have priority over the fields
+added here.</p>
+</td>
+</tr>
 </tbody>
 </table>
 </div>

diff --git a/docs/spec/v2beta1/helmreleases.md b/docs/spec/v2beta1/helmreleases.md
@@ -128,6 +128,12 @@ type HelmReleaseSpec struct {
 	// of their definition.
 	// +optional
 	PostRenderers []PostRenderer `json:"postRenderers,omitempty"`
+
+	// EventMetadata is an optional field for adding metadata to events emitted by the
+	// controller. Metadata fields added by the controller have priority over the fields
+	// added here.
+	// +optional
+	EventMetadata map[string]string `json:"eventMetadata,omitempty"`
 }
 
 // KubeConfig references a Kubernetes secret that contains a kubeconfig file.

diff --git a/internal/controllers/helmrelease_controller.go b/internal/controllers/helmrelease_controller.go
@@ -794,8 +794,18 @@ func (r *HelmReleaseReconciler) requestsForHelmChartChange(o client.Object) []re
 // event emits a Kubernetes event and forwards the event to notification controller if configured.
 func (r *HelmReleaseReconciler) event(_ context.Context, hr v2.HelmRelease, revision, severity, msg string) {
 	var meta map[string]string
+	addMetadata := func(key, value string) {
+		if meta == nil {
+			meta = make(map[string]string)
+		}
+		meta[v2.GroupVersion.Group+"/"+key] = value
+	}
+	for key, value := range hr.Spec.EventMetadata {
+		addMetadata(key, value)
+	}
 	if revision != "" {
 		meta = map[string]string{v2.GroupVersion.Group + "/revision": revision}
+		addMetadata("revision", revision)
 	}
 	eventtype := "Normal"
 	if severity == eventv1.EventSeverityError {