Alerting: support the Grafana operator as export format provider #87954
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
theSuess
commented
May 16, 2024
| @@ -271,7 +271,7 @@ type AlertRuleExport struct { | |||
| ForString *string `json:"-" yaml:"-" hcl:"for"` | |||
| Annotations *map[string]string `json:"annotations,omitempty" yaml:"annotations,omitempty" hcl:"annotations"` | |||
| Labels *map[string]string `json:"labels,omitempty" yaml:"labels,omitempty" hcl:"labels"` | |||
| IsPaused bool `json:"isPaused" yaml:"isPaused" hcl:"is_paused"` | |||
| IsPaused bool `json:"isPaused,omitempty" yaml:"isPaused,omitempty" hcl:"is_paused"` | |||
There was a problem hiding this comment.
The OpenAPI Spec has this as not required (= the generated go client has it as omitempty) so I'm reflecting the change here
| @@ -287,7 +287,7 @@ type AlertQueryExport struct { | |||
|
|
|||
| type RelativeTimeRangeExport struct { | |||
| FromSeconds int64 `json:"from" yaml:"from" hcl:"from"` | |||
| ToSeconds int64 `json:"to" yaml:"to" hcl:"to"` | |||
| ToSeconds int64 `json:"to,omitempty" yaml:"to,omitempty" hcl:"to"` | |||
There was a problem hiding this comment.
The OpenAPI Spec has this as not required (= the generated go client has it as omitempty) so I'm reflecting the change here
| ...r.spec, | ||
| rules: r.spec.rules.map(({ notification_settings, ...rule }: any) => ({ | ||
| ...rule, | ||
| for: rule.for.endsWith('m') ? rule.for + '0s' : rule.for, |
There was a problem hiding this comment.
This prevents the change noticed in grafana/grafana-operator#1492
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is this feature?
This PR adds a new export provider for the grafana-operator to the alerting export drawer.
Why do we need this feature?
Configuring alerting rules as-code is very complex. To alleviate this, many users utilize the
Modify Exportfunctionality. The YAML export is mostly compatible but requires further modification to be imported as an operator resource. Due to differences in serialization, it also causes CD solutions to trigger changes when there are none.Who is this feature for?
Users wishing to export their alerting resources as code and use them with the Operator
Which issue(s) does this PR fix?:
Implements grafana/grafana-operator#1492
Special notes for your reviewer:
Since the operator does not (yet) support Notification Policies & Mute Timings, I've added a way to filter for supported export providers.
Please check that: