Files
grafana/pkg/registry/apps/alerting/rules/alertrule/legacy_storage.go
Moustafa Baiou dd0a2d4cff Alerting: Add validation to check updates on rule groups (#113669)
This moves some of the validation logic for rule groups from the legacy storage layer to the validator.
2025-11-10 14:40:35 -05:00

235 lines
6.5 KiB
Go

package alertrule
import (
"context"
"errors"
"fmt"
"slices"
k8serrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/apis/meta/internalversion"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apiserver/pkg/registry/rest"
model "github.com/grafana/grafana/apps/alerting/rules/pkg/apis/alerting/v0alpha1"
"github.com/grafana/grafana/pkg/apimachinery/identity"
grafanarest "github.com/grafana/grafana/pkg/apiserver/rest"
"github.com/grafana/grafana/pkg/services/apiserver/endpoints/request"
ngmodels "github.com/grafana/grafana/pkg/services/ngalert/models"
"github.com/grafana/grafana/pkg/services/ngalert/provisioning"
)
var (
_ grafanarest.Storage = (*legacyStorage)(nil)
)
type legacyStorage struct {
service provisioning.AlertRuleService
namespacer request.NamespaceMapper
tableConverter rest.TableConvertor
}
func (s *legacyStorage) New() runtime.Object {
return ResourceInfo.NewFunc()
}
func (s *legacyStorage) Destroy() {}
func (s *legacyStorage) NamespaceScoped() bool {
return true
}
func (s *legacyStorage) GetSingularName() string {
return ResourceInfo.GetSingularName()
}
func (s *legacyStorage) NewList() runtime.Object {
return ResourceInfo.NewListFunc()
}
func (s *legacyStorage) ConvertToTable(ctx context.Context, object runtime.Object, tableOptions runtime.Object) (*metav1.Table, error) {
return s.tableConverter.ConvertToTable(ctx, object, tableOptions)
}
func (s *legacyStorage) List(ctx context.Context, opts *internalversion.ListOptions) (runtime.Object, error) {
info, err := request.NamespaceInfoFrom(ctx, true)
if err != nil {
return nil, err
}
user, err := identity.GetRequester(ctx)
if err != nil {
return nil, err
}
rules, provenanceMap, continueToken, err := s.service.ListAlertRules(ctx, user, provisioning.ListAlertRulesOptions{
RuleType: ngmodels.RuleTypeFilterAlerting,
Limit: opts.Limit,
ContinueToken: opts.Continue,
// TODO: add field selectors for filtering
// TODO: add label selectors for filtering on group and folders
})
if err != nil {
return nil, err
}
return convertToK8sResources(info.OrgID, rules, provenanceMap, s.namespacer, continueToken)
}
func (s *legacyStorage) Get(ctx context.Context, name string, _ *metav1.GetOptions) (runtime.Object, error) {
info, err := request.NamespaceInfoFrom(ctx, true)
if err != nil {
return nil, err
}
user, err := identity.GetRequester(ctx)
if err != nil {
return nil, err
}
rule, provenance, err := s.service.GetAlertRule(ctx, user, name)
if err != nil {
if errors.Is(err, ngmodels.ErrAlertRuleNotFound) {
return nil, k8serrors.NewNotFound(ResourceInfo.GroupResource(), name)
}
return nil, err
}
obj, err := convertToK8sResource(info.OrgID, &rule, provenance, s.namespacer)
if err != nil && errors.Is(err, errInvalidRule) {
return nil, k8serrors.NewNotFound(ResourceInfo.GroupResource(), name)
}
return obj, err
}
func (s *legacyStorage) Create(ctx context.Context, obj runtime.Object, createValidation rest.ValidateObjectFunc, _ *metav1.CreateOptions) (runtime.Object, error) {
info, err := request.NamespaceInfoFrom(ctx, true)
if err != nil {
return nil, err
}
user, err := identity.GetRequester(ctx)
if err != nil {
return nil, err
}
if createValidation != nil {
if err := createValidation(ctx, obj); err != nil {
return nil, err
}
}
p, ok := obj.(*model.AlertRule)
if !ok {
return nil, k8serrors.NewBadRequest("expected valid alert rule object")
}
if p.GenerateName != "" {
return nil, fmt.Errorf("generate-name is not supported in legacy storage mode")
}
model, provenance, err := convertToDomainModel(info.OrgID, p)
if err != nil {
return nil, err
}
created, err := s.service.CreateAlertRule(ctx, user, *model, provenance)
if err != nil {
return nil, err
}
return convertToK8sResource(info.OrgID, &created, provenance, s.namespacer)
}
func (s *legacyStorage) Update(ctx context.Context, name string, objInfo rest.UpdatedObjectInfo, createValidation rest.ValidateObjectFunc, updateValidation rest.ValidateObjectUpdateFunc, forceAllowCreate bool, options *metav1.UpdateOptions) (runtime.Object, bool, error) {
info, err := request.NamespaceInfoFrom(ctx, true)
if err != nil {
return nil, false, err
}
user, err := identity.GetRequester(ctx)
if err != nil {
return nil, false, err
}
old, err := s.Get(ctx, name, nil)
if err != nil {
return old, false, err
}
obj, err := objInfo.UpdatedObject(ctx, old)
if err != nil {
return old, false, err
}
if updateValidation != nil {
if err := updateValidation(ctx, obj, old); err != nil {
return nil, false, err
}
}
new, ok := obj.(*model.AlertRule)
if !ok {
return nil, false, k8serrors.NewBadRequest("expected valid alert rule object")
}
model, provenance, err := convertToDomainModel(info.OrgID, new)
if err != nil {
return old, false, err
}
// ignore returned rule as it doesn't contain the updated version
_, err = s.service.UpdateAlertRule(ctx, user, *model, provenance)
if err != nil {
return nil, false, err
}
updated, provenance, err := s.service.GetAlertRule(ctx, user, name)
if err != nil {
return nil, false, err
}
rule, err := convertToK8sResource(info.OrgID, &updated, provenance, s.namespacer)
if err != nil {
return nil, false, err
}
return rule, false, nil
}
func (s *legacyStorage) Delete(ctx context.Context, name string, deleteValidation rest.ValidateObjectFunc, opts *metav1.DeleteOptions) (runtime.Object, bool, error) {
user, err := identity.GetRequester(ctx)
if err != nil {
return nil, false, err
}
old, err := s.Get(ctx, name, nil)
if err != nil {
return old, false, err
}
if deleteValidation != nil {
if err := deleteValidation(ctx, old); err != nil {
return nil, false, err
}
}
p, ok := old.(*model.AlertRule)
if !ok {
return nil, false, k8serrors.NewBadRequest("expected valid recording rule object")
}
sourceProv := p.GetProvenanceStatus()
if !slices.Contains(model.AcceptedProvenanceStatuses, sourceProv) {
return nil, false, fmt.Errorf("invalid provenance status: %s", sourceProv)
}
provenance := ngmodels.Provenance(sourceProv)
err = s.service.DeleteAlertRule(ctx, user, name, provenance)
if err != nil {
return old, false, err
}
return old, false, nil
}
func (s *legacyStorage) DeleteCollection(ctx context.Context, _ rest.ValidateObjectFunc, _ *metav1.DeleteOptions, _ *internalversion.ListOptions) (runtime.Object, error) {
// TODO: support this once a pattern is established for bulk delete operations
return nil, k8serrors.NewMethodNotSupported(ResourceInfo.GroupResource(), "delete")
}