Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: NotificationPolicy LoopDetected condition and route.receiver validation #1843

Merged
merged 4 commits into from
Feb 4, 2025
+70 −45
Merged

Fix: NotificationPolicy LoopDetected condition and route.receiver validation #1843

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
33863dc
fix: reciever is a required field
Baarsgaard Jan 30, 2025
e656569
fix: loopDetected condition never applied
Baarsgaard Feb 2, 2025
502168b
refactor: Simplify if condition
Baarsgaard Feb 3, 2025
74fb3af
fix: sort notification policy status.discoveredRoutes
Baarsgaard Feb 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion api/v1beta1/grafananotificationpolicy_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@ type Route struct {
Provenance models.Provenance `json:"provenance,omitempty"`

// receiver
Receiver string `json:"receiver,omitempty"`
// +kubebuilder:validation:MinLength=1
Receiver string `json:"receiver"`

// repeat interval
RepeatInterval string `json:"repeat_interval,omitempty"`
Expand Down
1 change: 1 addition & 0 deletions api/v1beta1/grafananotificationpolicy_types_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ func newNotificationPolicy(name string, editable *bool) *GrafanaNotificationPoli
},
Route: &Route{
Continue: false,
Receiver: "grafana-default-email",
GroupBy: []string{"group_name", "alert_name"},
MuteTimeIntervals: []string{},
Routes: []*Route{},
Expand Down
1 change: 1 addition & 0 deletions api/v1beta1/grafananotificationpolicyroute_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ type GrafanaNotificationPolicyRouteSpec struct {
//+kubebuilder:subresource:status

// GrafanaNotificationPolicyRoute is the Schema for the grafananotificationpolicyroutes API
// +kubebuilder:resource:categories={grafana-operator}
type GrafanaNotificationPolicyRoute struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Expand Down
3 changes: 3 additions & 0 deletions config/crd/bases/grafana.integreatly.org_grafananotificationpolicies.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@ spec:
type: string
receiver:
description: receiver
minLength: 1
type: string
repeat_interval:
description: repeat interval
Expand Down Expand Up @@ -238,6 +239,8 @@ spec:
routes:
description: routes, mutually exclusive with RouteSelector
x-kubernetes-preserve-unknown-fields: true
required:
- receiver
type: object
required:
- instanceSelector
Expand Down
5 changes: 5 additions & 0 deletions config/crd/bases/grafana.integreatly.org_grafananotificationpolicyroutes.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ metadata:
spec:
group: grafana.integreatly.org
names:
categories:
- grafana-operator
kind: GrafanaNotificationPolicyRoute
listKind: GrafanaNotificationPolicyRouteList
plural: grafananotificationpolicyroutes
Expand Down Expand Up @@ -102,6 +104,7 @@ spec:
type: string
receiver:
description: receiver
minLength: 1
type: string
repeat_interval:
description: repeat interval
Expand Down Expand Up @@ -157,6 +160,8 @@ spec:
routes:
description: routes, mutually exclusive with RouteSelector
x-kubernetes-preserve-unknown-fields: true
required:
- receiver
type: object
status:
description: The most recent observed state of a Grafana resource
Expand Down
55 changes: 25 additions & 30 deletions controllers/notificationpolicy_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,31 @@ func (r *GrafanaNotificationPolicyReconciler) Reconcile(ctx context.Context, req
}
removeInvalidSpec(&notificationPolicy.Status.Conditions)

// Assemble routes and check for loops
var mergedRoutes []*v1beta1.GrafanaNotificationPolicyRoute
if notificationPolicy.Spec.Route.RouteSelector != nil || notificationPolicy.Spec.Route.HasRouteSelector() {
Baarsgaard marked this conversation as resolved.
Show resolved Hide resolved
mergedRoutes, err = assembleNotificationPolicyRoutes(ctx, r.Client, notificationPolicy)

if errors.Is(err, ErrLoopDetected) {
meta.SetStatusCondition(&notificationPolicy.Status.Conditions, metav1.Condition{
Type: conditionNotificationPolicyLoopDetected,
Status: metav1.ConditionTrue,
ObservedGeneration: notificationPolicy.Generation,
Reason: "LoopDetected",
Message: fmt.Sprintf("Loop detected in notification policy routes: %s", err.Error()),
})
meta.RemoveStatusCondition(&notificationPolicy.Status.Conditions, conditionNotificationPolicySynchronized)
return ctrl.Result{}, fmt.Errorf("failed to assemble notification policy routes: %w", err)
}

if err != nil {
r.Recorder.Event(notificationPolicy, corev1.EventTypeWarning, "AssemblyFailed", fmt.Sprintf("Failed to assemble GrafanaNotificationPolicy using routeSelectors: %v", err))
return ctrl.Result{}, fmt.Errorf("failed to assemble GrafanaNotificationPolicy using routeSelectors: %w", err)
}
}

meta.RemoveStatusCondition(&notificationPolicy.Status.Conditions, conditionNotificationPolicyLoopDetected)

instances, err := GetScopedMatchingInstances(ctx, r.Client, notificationPolicy)
if err != nil {
setNoMatchingInstancesCondition(&notificationPolicy.Status.Conditions, notificationPolicy.Generation, err)
Expand All @@ -132,16 +157,6 @@ func (r *GrafanaNotificationPolicyReconciler) Reconcile(ctx context.Context, req
removeNoMatchingInstance(&notificationPolicy.Status.Conditions)
log.Info("found matching Grafana instances for notificationPolicy", "count", len(instances))

var mergedRoutes []*v1beta1.GrafanaNotificationPolicyRoute

if notificationPolicy.Spec.Route.RouteSelector != nil || notificationPolicy.Spec.Route.HasRouteSelector() {
mergedRoutes, err = assembleNotificationPolicyRoutes(ctx, r.Client, notificationPolicy)
if err := r.handleAssembleError(err, notificationPolicy); err != nil {
return ctrl.Result{}, err
}
}
meta.RemoveStatusCondition(&notificationPolicy.Status.Conditions, conditionNotificationPolicyLoopDetected)

applyErrors := make(map[string]string)
for _, grafana := range instances {
// can be removed in go 1.22+
Expand Down Expand Up @@ -450,23 +465,3 @@ func statusDiscoveredRoutes(routes []*v1beta1.GrafanaNotificationPolicyRoute) []
func setInvalidSpecMutuallyExclusive(conditions *[]metav1.Condition, generation int64) {
setInvalidSpec(conditions, generation, "FieldsMutuallyExclusive", "RouteSelector and Routes are mutually exclusive")
}

// handleAssembleError handles errors during notification policy assembly
func (r *GrafanaNotificationPolicyReconciler) handleAssembleError(err error, notificationPolicy *grafanav1beta1.GrafanaNotificationPolicy) error {
if err == nil {
return nil
}

if errors.Is(err, ErrLoopDetected) {
meta.SetStatusCondition(&notificationPolicy.Status.Conditions, metav1.Condition{
Type: conditionNotificationPolicyLoopDetected,
Status: metav1.ConditionTrue,
ObservedGeneration: notificationPolicy.Generation,
Reason: "LoopDetected",
Message: fmt.Sprintf("Loop detected in notification policy routes: %s", err.Error()),
})
return nil
}
r.Recorder.Event(notificationPolicy, corev1.EventTypeWarning, "AssemblyFailed", fmt.Sprintf("Failed to assemble GrafanaNotificationPolicy using routeSelectors: %v", err))
return fmt.Errorf("failed to assemble GrafanaNotificationPolicy using routeSelectors: %w", err)
}
3 changes: 3 additions & 0 deletions deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafananotificationpolicies.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@ spec:
type: string
receiver:
description: receiver
minLength: 1
type: string
repeat_interval:
description: repeat interval
Expand Down Expand Up @@ -238,6 +239,8 @@ spec:
routes:
description: routes, mutually exclusive with RouteSelector
x-kubernetes-preserve-unknown-fields: true
required:
- receiver
type: object
required:
- instanceSelector
Expand Down
5 changes: 5 additions & 0 deletions ...y/helm/grafana-operator/crds/grafana.integreatly.org_grafananotificationpolicyroutes.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ metadata:
spec:
group: grafana.integreatly.org
names:
categories:
- grafana-operator
kind: GrafanaNotificationPolicyRoute
listKind: GrafanaNotificationPolicyRouteList
plural: grafananotificationpolicyroutes
Expand Down Expand Up @@ -102,6 +104,7 @@ spec:
type: string
receiver:
description: receiver
minLength: 1
type: string
repeat_interval:
description: repeat interval
Expand Down Expand Up @@ -157,6 +160,8 @@ spec:
routes:
description: routes, mutually exclusive with RouteSelector
x-kubernetes-preserve-unknown-fields: true
required:
- receiver
type: object
status:
description: The most recent observed state of a Grafana resource
Expand Down
8 changes: 8 additions & 0 deletions deploy/kustomize/base/crds.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2157,6 +2157,7 @@ spec:
type: string
receiver:
description: receiver
minLength: 1
type: string
repeat_interval:
description: repeat interval
Expand Down Expand Up @@ -2212,6 +2213,8 @@ spec:
routes:
description: routes, mutually exclusive with RouteSelector
x-kubernetes-preserve-unknown-fields: true
required:
- receiver
type: object
required:
- instanceSelector
Expand Down Expand Up @@ -2311,6 +2314,8 @@ metadata:
spec:
group: grafana.integreatly.org
names:
categories:
- grafana-operator
kind: GrafanaNotificationPolicyRoute
listKind: GrafanaNotificationPolicyRouteList
plural: grafananotificationpolicyroutes
Expand Down Expand Up @@ -2405,6 +2410,7 @@ spec:
type: string
receiver:
description: receiver
minLength: 1
type: string
repeat_interval:
description: repeat interval
Expand Down Expand Up @@ -2460,6 +2466,8 @@ spec:
routes:
description: routes, mutually exclusive with RouteSelector
x-kubernetes-preserve-unknown-fields: true
required:
- receiver
type: object
status:
description: The most recent observed state of a Grafana resource
Expand Down
28 changes: 14 additions & 14 deletions docs/docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3925,6 +3925,13 @@ Routes for alerts to match against
</tr>
</thead>
<tbody><tr>
<td><b>receiver</b></td>
<td>string</td>
<td>
receiver<br/>
</td>
<td>true</td>
</tr><tr>
<td><b>continue</b></td>
<td>boolean</td>
<td>
Expand Down Expand Up @@ -3987,13 +3994,6 @@ Routes for alerts to match against
provenance<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>receiver</b></td>
<td>string</td>
<td>
receiver<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>repeat_interval</b></td>
<td>string</td>
Expand Down Expand Up @@ -4341,6 +4341,13 @@ GrafanaNotificationPolicyRouteSpec defines the desired state of GrafanaNotificat
</tr>
</thead>
<tbody><tr>
<td><b>receiver</b></td>
<td>string</td>
<td>
receiver<br/>
</td>
<td>true</td>
</tr><tr>
<td><b>continue</b></td>
<td>boolean</td>
<td>
Expand Down Expand Up @@ -4403,13 +4410,6 @@ GrafanaNotificationPolicyRouteSpec defines the desired state of GrafanaNotificat
provenance<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>receiver</b></td>
<td>string</td>
<td>
receiver<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>repeat_interval</b></td>
<td>string</td>
Expand Down