mirror of https://github.com/grafana/grafana
Alerting: Consume k8s API for notification policies tree (#96147)
* Add basic usage of K8s API for notification policies * Add permissions checks for navtree for routes * Add and update permissions for routing tree logic * Add capability to skip calling contact points hook * Conditionally show list of mute timings depending on permissions * Conditionally link to mute timings if user can see at least one * Add work in progress k8s handlers for routing tree * Update notification policy hooks * Wire up policies to permissions better (conditionally calling APIs) * Add additional checks for whether to show grafana AM * Add permission checks to access control * Remove accidental permissions after rebase * Update types and const for k8s routes * Improve statefulness and reset routing tree in tests * Update notif policy tests to check k8s and config API * Fix type assertion * Move non-grafana test out of .each * Make failure case safer * Override tag invalidation for notification policies API * Pass in error and add new error alert component * Add basic mock server conflict check * Add test to check user can save after a conflict * Add logic to allow reloading policies if changed by another user * Fix test * Update translations in Modals * Add ViewAlertGroups ability * Tweak provisioning logic and memoize AM config response * Update snapshots for useAbilities * Update result destructure * Use enums for provenance in routingtrees * Use consistent memoisation * Fix _metadata for vanilla AM * useAsync for error / update state * move k8s api error handling to separate file * use cause for error codes * Use `supported` bools from Alertmanager abilities and clarify default policy --------- Co-authored-by: Konrad Lalik <konrad.lalik@grafana.com> Co-authored-by: Gilles De Mey <gilles.de.mey@gmail.com>pull/96655/head^2
Tom Ratcliffe
7 months ago
committed by
GitHub
parent
06d0d41183
commit
e4a1243948
@ -0,0 +1,11 @@ |
||||
import { generatedRoutesApi } from 'app/features/alerting/unified/openapi/routesApi.gen'; |
||||
|
||||
export const routingTreeApi = generatedRoutesApi.enhanceEndpoints({ |
||||
endpoints: { |
||||
replaceNamespacedRoutingTree: { |
||||
// Stop a failed mutation from invalidating the cache, as otherwise the notification policies
|
||||
// components will re-attach IDs to the routes, and then the user can't update the route anyway
|
||||
invalidatesTags: (_, error) => (error ? [] : ['RoutingTree']), |
||||
}, |
||||
}, |
||||
}); |
||||
@ -0,0 +1,28 @@ |
||||
import { Alert } from '@grafana/ui'; |
||||
import { t, Trans } from 'app/core/internationalization'; |
||||
|
||||
import { stringifyErrorLike } from '../../utils/misc'; |
||||
|
||||
export const NotificationPoliciesErrorAlert = ({ error }: { error: unknown }) => { |
||||
const title = t('alerting.policies.update-errors.title', 'Error saving notification policy'); |
||||
|
||||
const errMessage = stringifyErrorLike(error); |
||||
return ( |
||||
<Alert title={title} severity="error"> |
||||
<div> |
||||
<Trans i18nKey="alerting.policies.update-errors.fallback"> |
||||
Something went wrong when updating your notification policies. |
||||
</Trans> |
||||
</div> |
||||
<div> |
||||
{errMessage || ( |
||||
<Trans i18nKey="alerting.policies.update-errors.error-code" values={{ error }}> |
||||
Error message: "{{ error }}" |
||||
</Trans> |
||||
)} |
||||
</div> |
||||
|
||||
<Trans i18nKey="alerting.policies.update-errors.suffix">Please refresh the page and try again.</Trans> |
||||
</Alert> |
||||
); |
||||
}; |
||||
@ -0,0 +1,16 @@ |
||||
import { AccessControlAction } from 'app/types'; |
||||
|
||||
/** |
||||
* List of granular permissions that allow viewing notification policies |
||||
*/ |
||||
export const PERMISSIONS_NOTIFICATION_POLICIES_READ = [AccessControlAction.AlertingRoutesRead]; |
||||
|
||||
/** |
||||
* List of granular permissions that allow modifying notification policies |
||||
*/ |
||||
export const PERMISSIONS_NOTIFICATION_POLICIES_MODIFY = [AccessControlAction.AlertingRoutesWrite]; |
||||
|
||||
export const PERMISSIONS_NOTIFICATION_POLICIES = [ |
||||
...PERMISSIONS_NOTIFICATION_POLICIES_READ, |
||||
...PERMISSIONS_NOTIFICATION_POLICIES_MODIFY, |
||||
]; |
||||
@ -0,0 +1,178 @@ |
||||
import memoize from 'micro-memoize'; |
||||
|
||||
import { routingTreeApi } from 'app/features/alerting/unified/api/notificationPoliciesApi'; |
||||
import { BaseAlertmanagerArgs, Skippable } from 'app/features/alerting/unified/types/hooks'; |
||||
import { MatcherOperator, Route } from 'app/plugins/datasource/alertmanager/types'; |
||||
|
||||
import { alertmanagerApi } from '../../api/alertmanagerApi'; |
||||
import { |
||||
ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1Route, |
||||
ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RoutingTree, |
||||
ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RoutingTreeSpec, |
||||
} from '../../openapi/routesApi.gen'; |
||||
import { PROVENANCE_NONE, ROOT_ROUTE_NAME } from '../../utils/k8s/constants'; |
||||
import { ERROR_NEWER_CONFIGURATION } from '../../utils/k8s/errors'; |
||||
import { getK8sNamespace, isK8sEntityProvisioned, shouldUseK8sApi } from '../../utils/k8s/utils'; |
||||
const k8sRoutesToRoutesMemoized = memoize(k8sRoutesToRoutes, { maxSize: 1 }); |
||||
|
||||
const { useListNamespacedRoutingTreeQuery, useReplaceNamespacedRoutingTreeMutation } = routingTreeApi; |
||||
|
||||
const { |
||||
useUpdateAlertmanagerConfigurationMutation, |
||||
useLazyGetAlertmanagerConfigurationQuery, |
||||
useGetAlertmanagerConfigurationQuery, |
||||
} = alertmanagerApi; |
||||
|
||||
export const useNotificationPolicyRoute = ({ alertmanager }: BaseAlertmanagerArgs, { skip }: Skippable = {}) => { |
||||
const k8sApiSupported = shouldUseK8sApi(alertmanager); |
||||
|
||||
const k8sRouteQuery = useListNamespacedRoutingTreeQuery( |
||||
{ namespace: getK8sNamespace() }, |
||||
{ |
||||
skip: skip || !k8sApiSupported, |
||||
selectFromResult: (result) => { |
||||
return { |
||||
...result, |
||||
currentData: result.currentData ? k8sRoutesToRoutesMemoized(result.currentData.items) : undefined, |
||||
data: result.data ? k8sRoutesToRoutesMemoized(result.data.items) : undefined, |
||||
}; |
||||
}, |
||||
} |
||||
); |
||||
|
||||
const amConfigQuery = useGetAlertmanagerConfigurationQuery(alertmanager, { |
||||
skip: skip || k8sApiSupported, |
||||
selectFromResult: (result) => { |
||||
return { |
||||
...result, |
||||
currentData: result.currentData?.alertmanager_config?.route |
||||
? [parseAmConfigRoute(result.currentData.alertmanager_config.route)] |
||||
: undefined, |
||||
data: result.data?.alertmanager_config?.route |
||||
? [parseAmConfigRoute(result.data.alertmanager_config.route)] |
||||
: undefined, |
||||
}; |
||||
}, |
||||
}); |
||||
|
||||
return k8sApiSupported ? k8sRouteQuery : amConfigQuery; |
||||
}; |
||||
|
||||
const parseAmConfigRoute = memoize((route: Route): Route => { |
||||
return { |
||||
...route, |
||||
_metadata: { provisioned: Boolean(route.provenance && route.provenance !== PROVENANCE_NONE) }, |
||||
}; |
||||
}); |
||||
|
||||
export function useUpdateNotificationPolicyRoute(selectedAlertmanager: string) { |
||||
const [getAlertmanagerConfiguration] = useLazyGetAlertmanagerConfigurationQuery(); |
||||
const [updateAlertmanagerConfiguration] = useUpdateAlertmanagerConfigurationMutation(); |
||||
|
||||
const [updatedNamespacedRoute] = useReplaceNamespacedRoutingTreeMutation(); |
||||
|
||||
const k8sApiSupported = shouldUseK8sApi(selectedAlertmanager); |
||||
|
||||
async function updateUsingK8sApi({ newRoute }: { newRoute: Route }) { |
||||
const namespace = getK8sNamespace(); |
||||
const { routes, _metadata, ...defaults } = newRoute; |
||||
// Remove provenance so we don't send it to API
|
||||
// Convert Route to K8s compatible format
|
||||
const k8sRoute: ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RoutingTreeSpec = { |
||||
defaults: { |
||||
...defaults, |
||||
// TODO: Fix types in k8s API? Fix our types to not allow empty receiver? TBC
|
||||
receiver: defaults.receiver || '', |
||||
}, |
||||
routes: newRoute.routes?.map(routeToK8sSubRoute) || [], |
||||
}; |
||||
|
||||
// Create the K8s route object
|
||||
const routeObject: ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RoutingTree = { |
||||
spec: k8sRoute, |
||||
metadata: { name: ROOT_ROUTE_NAME, resourceVersion: _metadata?.resourceVersion }, |
||||
}; |
||||
|
||||
return updatedNamespacedRoute({ |
||||
name: ROOT_ROUTE_NAME, |
||||
namespace, |
||||
comGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RoutingTree: routeObject, |
||||
}).unwrap(); |
||||
} |
||||
|
||||
async function updateUsingConfigFileApi({ newRoute, oldRoute }: { newRoute: Route; oldRoute: Route }) { |
||||
const { _metadata, ...oldRouteStripped } = oldRoute; |
||||
const { _metadata: newMetadata, ...newRouteStripped } = newRoute; |
||||
const lastConfig = await getAlertmanagerConfiguration(selectedAlertmanager).unwrap(); |
||||
const latestRouteFromConfig = lastConfig.alertmanager_config.route; |
||||
|
||||
const configChangedInMeantime = JSON.stringify(oldRouteStripped) !== JSON.stringify(latestRouteFromConfig); |
||||
|
||||
if (configChangedInMeantime) { |
||||
throw new Error('configuration modification conflict', { cause: ERROR_NEWER_CONFIGURATION }); |
||||
} |
||||
|
||||
const newConfig = { |
||||
...lastConfig, |
||||
alertmanager_config: { |
||||
...lastConfig.alertmanager_config, |
||||
route: newRouteStripped, |
||||
}, |
||||
}; |
||||
|
||||
// TODO This needs to properly handle lazy AM initialization
|
||||
return updateAlertmanagerConfiguration({ |
||||
selectedAlertmanager, |
||||
config: newConfig, |
||||
}).unwrap(); |
||||
} |
||||
|
||||
return k8sApiSupported ? updateUsingK8sApi : updateUsingConfigFileApi; |
||||
} |
||||
|
||||
function k8sRoutesToRoutes(routes: ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RoutingTree[]): Route[] { |
||||
return routes?.map((route) => { |
||||
return { |
||||
...route.spec.defaults, |
||||
routes: route.spec.routes?.map(k8sSubRouteToRoute), |
||||
_metadata: { |
||||
provisioned: isK8sEntityProvisioned(route), |
||||
resourceVersion: route.metadata.resourceVersion, |
||||
name: route.metadata.name, |
||||
}, |
||||
}; |
||||
}); |
||||
} |
||||
|
||||
/** Helper to provide type safety for matcher operators from API */ |
||||
function isValidMatcherOperator(type: string): type is MatcherOperator { |
||||
return Object.values<string>(MatcherOperator).includes(type); |
||||
} |
||||
|
||||
function k8sSubRouteToRoute(route: ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1Route): Route { |
||||
return { |
||||
...route, |
||||
routes: route.routes?.map(k8sSubRouteToRoute), |
||||
matchers: undefined, |
||||
object_matchers: route.matchers?.map(({ label, type, value }) => { |
||||
if (!isValidMatcherOperator(type)) { |
||||
throw new Error(`Invalid matcher operator from API: ${type}`); |
||||
} |
||||
return [label, type, value]; |
||||
}), |
||||
}; |
||||
} |
||||
|
||||
function routeToK8sSubRoute(route: Route): ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1Route { |
||||
const { object_matchers, ...rest } = route; |
||||
return { |
||||
...rest, |
||||
receiver: route.receiver ?? undefined, |
||||
matchers: object_matchers?.map(([label, type, value]) => ({ |
||||
label, |
||||
type, |
||||
value, |
||||
})), |
||||
routes: route.routes?.map(routeToK8sSubRoute), |
||||
}; |
||||
} |
||||
@ -0,0 +1,98 @@ |
||||
import grafanaAlertmanagerConfig from 'app/features/alerting/unified/mocks/server/entities/alertmanager-config/grafana-alertmanager-config'; |
||||
import { |
||||
ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1Matcher, |
||||
ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1Route, |
||||
ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RoutingTree, |
||||
} from 'app/features/alerting/unified/openapi/routesApi.gen'; |
||||
import { K8sAnnotations, PROVENANCE_NONE, ROOT_ROUTE_NAME } from 'app/features/alerting/unified/utils/k8s/constants'; |
||||
import { AlertManagerCortexConfig, MatcherOperator, Route } from 'app/plugins/datasource/alertmanager/types'; |
||||
|
||||
/** |
||||
* Normalise matchers from config Route object -> what the k8s API expects to be returning |
||||
*/ |
||||
const normalizeMatchers = (route: Route) => { |
||||
const routeMatchers: ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1Matcher[] = []; |
||||
|
||||
if (route.object_matchers) { |
||||
// todo foreach
|
||||
route.object_matchers.map(([label, type, value]) => { |
||||
return { label, type, value }; |
||||
}); |
||||
} |
||||
|
||||
if (route.match_re) { |
||||
Object.entries(route.match_re).forEach(([label, value]) => { |
||||
routeMatchers.push({ label, type: MatcherOperator.regex, value }); |
||||
}); |
||||
} |
||||
|
||||
if (route.match) { |
||||
Object.entries(route.match).forEach(([label, value]) => { |
||||
routeMatchers.push({ label, type: MatcherOperator.equal, value }); |
||||
}); |
||||
} |
||||
|
||||
return routeMatchers; |
||||
}; |
||||
|
||||
const mapRoute = (route: Route): ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1Route => { |
||||
const normalisedMatchers = normalizeMatchers(route); |
||||
const { match, match_re, object_matchers, routes, receiver, ...rest } = route; |
||||
return { |
||||
...rest, |
||||
// TODO: Fix types in k8s API? Fix our types to not allow empty receiver? TBC
|
||||
receiver: receiver || '', |
||||
matchers: normalisedMatchers, |
||||
routes: routes ? routes.map(mapRoute) : undefined, |
||||
}; |
||||
}; |
||||
|
||||
export const getUserDefinedRoutingTree: ( |
||||
config: AlertManagerCortexConfig |
||||
) => ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RoutingTree = (config) => { |
||||
const route = config.alertmanager_config?.route || {}; |
||||
|
||||
const { routes, ...defaults } = route; |
||||
|
||||
const spec = { |
||||
defaults: { ...defaults, group_by: defaults.group_by || [], receiver: defaults.receiver || '' }, |
||||
routes: |
||||
routes?.map((route) => { |
||||
return mapRoute(route); |
||||
}) || [], |
||||
}; |
||||
|
||||
return { |
||||
metadata: { |
||||
name: ROOT_ROUTE_NAME, |
||||
namespace: 'default', |
||||
annotations: { |
||||
[K8sAnnotations.Provenance]: PROVENANCE_NONE, |
||||
}, |
||||
// Resource versions are much shorter than this in reality, but this is an easy way
|
||||
// for us to mock the concurrency logic and check if the policies have updated since the last fetch
|
||||
resourceVersion: btoa(JSON.stringify(spec)), |
||||
}, |
||||
spec, |
||||
}; |
||||
}; |
||||
|
||||
const getDefaultRoutingTreeMap = () => |
||||
new Map([[ROOT_ROUTE_NAME, getUserDefinedRoutingTree(grafanaAlertmanagerConfig)]]); |
||||
|
||||
let ROUTING_TREE_MAP = getDefaultRoutingTreeMap(); |
||||
|
||||
export const getRoutingTree = (treeName: string) => { |
||||
return ROUTING_TREE_MAP.get(treeName); |
||||
}; |
||||
|
||||
export const setRoutingTree = ( |
||||
treeName: string, |
||||
updatedRoutingTree: ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RoutingTree |
||||
) => { |
||||
return ROUTING_TREE_MAP.set(treeName, updatedRoutingTree); |
||||
}; |
||||
|
||||
export const resetRoutingTreeMap = () => { |
||||
ROUTING_TREE_MAP = getDefaultRoutingTreeMap(); |
||||
}; |
||||
@ -0,0 +1,55 @@ |
||||
import { HttpResponse, http } from 'msw'; |
||||
|
||||
import { getRoutingTree, setRoutingTree } from 'app/features/alerting/unified/mocks/server/entities/k8s/routingtrees'; |
||||
import { ALERTING_API_SERVER_BASE_URL } from 'app/features/alerting/unified/mocks/server/utils'; |
||||
import { |
||||
ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RoutingTree, |
||||
ListNamespacedRoutingTreeApiResponse, |
||||
} from 'app/features/alerting/unified/openapi/routesApi.gen'; |
||||
import { ROOT_ROUTE_NAME } from 'app/features/alerting/unified/utils/k8s/constants'; |
||||
import { ApiMachineryError } from 'app/features/alerting/unified/utils/k8s/errors'; |
||||
|
||||
const wrapRoutingTreeResponse: ( |
||||
route: ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RoutingTree |
||||
) => ListNamespacedRoutingTreeApiResponse = (route) => ({ |
||||
kind: 'RoutingTree', |
||||
metadata: {}, |
||||
items: [route], |
||||
}); |
||||
|
||||
const listNamespacedRoutingTreesHandler = () => |
||||
http.get<{ namespace: string }>(`${ALERTING_API_SERVER_BASE_URL}/namespaces/:namespace/routingtrees`, () => { |
||||
const userDefinedTree = getRoutingTree(ROOT_ROUTE_NAME)!; |
||||
return HttpResponse.json(wrapRoutingTreeResponse(userDefinedTree)); |
||||
}); |
||||
|
||||
const HTTP_RESPONSE_CONFLICT: ApiMachineryError = { |
||||
kind: 'Status', |
||||
apiVersion: 'v1', |
||||
metadata: {}, |
||||
status: 'Failure', |
||||
message: 'Conflict', |
||||
reason: 'Conflict', |
||||
details: { |
||||
uid: 'alerting.notifications.conflict', |
||||
}, |
||||
code: 409, |
||||
}; |
||||
|
||||
const updateNamespacedRoutingTreeHandler = () => |
||||
http.put<{ namespace: string; name: string }, ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RoutingTree>( |
||||
`${ALERTING_API_SERVER_BASE_URL}/namespaces/:namespace/routingtrees/:name`, |
||||
async ({ params: { name }, request }) => { |
||||
const updatedRoutingTree = await request.json(); |
||||
const existingResourceVersion = getRoutingTree(name)?.metadata.resourceVersion; |
||||
if (updatedRoutingTree.metadata.resourceVersion !== existingResourceVersion) { |
||||
return HttpResponse.json(HTTP_RESPONSE_CONFLICT, { status: 409 }); |
||||
} |
||||
setRoutingTree(name, updatedRoutingTree); |
||||
return HttpResponse.json(updatedRoutingTree); |
||||
} |
||||
); |
||||
|
||||
const handlers = [listNamespacedRoutingTreesHandler(), updateNamespacedRoutingTreeHandler()]; |
||||
|
||||
export default handlers; |
||||
@ -0,0 +1,249 @@ |
||||
import { alertingApi as api } from '../api/alertingApi'; |
||||
export const addTagTypes = ['RoutingTree'] as const; |
||||
const injectedRtkApi = api |
||||
.enhanceEndpoints({ |
||||
addTagTypes, |
||||
}) |
||||
.injectEndpoints({ |
||||
endpoints: (build) => ({ |
||||
listNamespacedRoutingTree: build.query<ListNamespacedRoutingTreeApiResponse, ListNamespacedRoutingTreeApiArg>({ |
||||
query: (queryArg) => ({ |
||||
url: `/apis/notifications.alerting.grafana.app/v0alpha1/namespaces/${queryArg['namespace']}/routingtrees`, |
||||
params: { |
||||
pretty: queryArg.pretty, |
||||
allowWatchBookmarks: queryArg.allowWatchBookmarks, |
||||
continue: queryArg['continue'], |
||||
fieldSelector: queryArg.fieldSelector, |
||||
labelSelector: queryArg.labelSelector, |
||||
limit: queryArg.limit, |
||||
resourceVersion: queryArg.resourceVersion, |
||||
resourceVersionMatch: queryArg.resourceVersionMatch, |
||||
sendInitialEvents: queryArg.sendInitialEvents, |
||||
timeoutSeconds: queryArg.timeoutSeconds, |
||||
watch: queryArg.watch, |
||||
}, |
||||
}), |
||||
providesTags: ['RoutingTree'], |
||||
}), |
||||
replaceNamespacedRoutingTree: build.mutation< |
||||
ReplaceNamespacedRoutingTreeApiResponse, |
||||
ReplaceNamespacedRoutingTreeApiArg |
||||
>({ |
||||
query: (queryArg) => ({ |
||||
url: `/apis/notifications.alerting.grafana.app/v0alpha1/namespaces/${queryArg['namespace']}/routingtrees/${queryArg.name}`, |
||||
method: 'PUT', |
||||
body: queryArg.comGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RoutingTree, |
||||
params: { |
||||
pretty: queryArg.pretty, |
||||
dryRun: queryArg.dryRun, |
||||
fieldManager: queryArg.fieldManager, |
||||
fieldValidation: queryArg.fieldValidation, |
||||
}, |
||||
}), |
||||
invalidatesTags: ['RoutingTree'], |
||||
}), |
||||
}), |
||||
overrideExisting: false, |
||||
}); |
||||
export { injectedRtkApi as generatedRoutesApi }; |
||||
export type ListNamespacedRoutingTreeApiResponse = |
||||
/** status 200 OK */ ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RoutingTreeList; |
||||
export type ListNamespacedRoutingTreeApiArg = { |
||||
/** object name and auth scope, such as for teams and projects */ |
||||
namespace: string; |
||||
/** If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). */ |
||||
pretty?: string; |
||||
/** allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. */ |
||||
allowWatchBookmarks?: boolean; |
||||
/** The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". |
||||
|
||||
This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. */ |
||||
continue?: string; |
||||
/** A selector to restrict the list of returned objects by their fields. Defaults to everything. */ |
||||
fieldSelector?: string; |
||||
/** A selector to restrict the list of returned objects by their labels. Defaults to everything. */ |
||||
labelSelector?: string; |
||||
/** limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. |
||||
|
||||
The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. */ |
||||
limit?: number; |
||||
/** resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. |
||||
|
||||
Defaults to unset */ |
||||
resourceVersion?: string; |
||||
/** resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. |
||||
|
||||
Defaults to unset */ |
||||
resourceVersionMatch?: string; |
||||
/** `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic "Bookmark" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `"k8s.io/initial-events-end": "true"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. |
||||
|
||||
When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan |
||||
is interpreted as "data at least as new as the provided `resourceVersion`" |
||||
and the bookmark event is send when the state is synced |
||||
to a `resourceVersion` at least as fresh as the one provided by the ListOptions. |
||||
If `resourceVersion` is unset, this is interpreted as "consistent read" and the |
||||
bookmark event is send when the state is synced at least to the moment |
||||
when request started being processed. |
||||
- `resourceVersionMatch` set to any other value or unset |
||||
Invalid error is returned. |
||||
|
||||
Defaults to true if `resourceVersion=""` or `resourceVersion="0"` (for backward compatibility reasons) and to false otherwise. */ |
||||
sendInitialEvents?: boolean; |
||||
/** Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. */ |
||||
timeoutSeconds?: number; |
||||
/** Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. */ |
||||
watch?: boolean; |
||||
}; |
||||
export type ReplaceNamespacedRoutingTreeApiResponse = /** status 200 OK */ |
||||
| ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RoutingTree |
||||
| /** status 201 Created */ ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RoutingTree; |
||||
export type ReplaceNamespacedRoutingTreeApiArg = { |
||||
/** name of the RoutingTree */ |
||||
name: string; |
||||
/** object name and auth scope, such as for teams and projects */ |
||||
namespace: string; |
||||
/** If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). */ |
||||
pretty?: string; |
||||
/** When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed */ |
||||
dryRun?: string; |
||||
/** fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. */ |
||||
fieldManager?: string; |
||||
/** fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. */ |
||||
fieldValidation?: string; |
||||
comGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RoutingTree: ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RoutingTree; |
||||
}; |
||||
export type IoK8SApimachineryPkgApisMetaV1Time = string; |
||||
export type IoK8SApimachineryPkgApisMetaV1FieldsV1 = object; |
||||
export type IoK8SApimachineryPkgApisMetaV1ManagedFieldsEntry = { |
||||
/** APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted. */ |
||||
apiVersion?: string; |
||||
/** FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" */ |
||||
fieldsType?: string; |
||||
/** FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. */ |
||||
fieldsV1?: IoK8SApimachineryPkgApisMetaV1FieldsV1; |
||||
/** Manager is an identifier of the workflow managing these fields. */ |
||||
manager?: string; |
||||
/** Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. */ |
||||
operation?: string; |
||||
/** Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. */ |
||||
subresource?: string; |
||||
/** Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over. */ |
||||
time?: IoK8SApimachineryPkgApisMetaV1Time; |
||||
}; |
||||
export type IoK8SApimachineryPkgApisMetaV1OwnerReference = { |
||||
/** API version of the referent. */ |
||||
apiVersion: string; |
||||
/** If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. */ |
||||
blockOwnerDeletion?: boolean; |
||||
/** If true, this reference points to the managing controller. */ |
||||
controller?: boolean; |
||||
/** Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ |
||||
kind: string; |
||||
/** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names */ |
||||
name: string; |
||||
/** UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids */ |
||||
uid: string; |
||||
}; |
||||
export type IoK8SApimachineryPkgApisMetaV1ObjectMeta = { |
||||
/** Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations */ |
||||
annotations?: { |
||||
[key: string]: string; |
||||
}; |
||||
/** CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. |
||||
|
||||
Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */
|
||||
creationTimestamp?: IoK8SApimachineryPkgApisMetaV1Time; |
||||
/** Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. */ |
||||
deletionGracePeriodSeconds?: number; |
||||
/** DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. |
||||
|
||||
Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */
|
||||
deletionTimestamp?: IoK8SApimachineryPkgApisMetaV1Time; |
||||
/** Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. */ |
||||
finalizers?: string[]; |
||||
/** GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. |
||||
|
||||
If this field is specified and the generated name exists, the server will return a 409. |
||||
|
||||
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency */
|
||||
generateName?: string; |
||||
/** A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. */ |
||||
generation?: number; |
||||
/** Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels */ |
||||
labels?: { |
||||
[key: string]: string; |
||||
}; |
||||
/** ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. */ |
||||
managedFields?: IoK8SApimachineryPkgApisMetaV1ManagedFieldsEntry[]; |
||||
/** Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names */ |
||||
name?: string; |
||||
/** Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. |
||||
|
||||
Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces */
|
||||
namespace?: string; |
||||
/** List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. */ |
||||
ownerReferences?: IoK8SApimachineryPkgApisMetaV1OwnerReference[]; |
||||
/** An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. |
||||
|
||||
Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency */
|
||||
resourceVersion?: string; |
||||
/** Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. */ |
||||
selfLink?: string; |
||||
/** UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. |
||||
|
||||
Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids */
|
||||
uid?: string; |
||||
}; |
||||
export type ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RouteDefaults = { |
||||
group_by?: string[]; |
||||
group_interval?: string; |
||||
group_wait?: string; |
||||
receiver: string; |
||||
repeat_interval?: string; |
||||
}; |
||||
export type ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1Matcher = { |
||||
label: string; |
||||
type: string; |
||||
value: string; |
||||
}; |
||||
export type ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1Route = { |
||||
continue?: boolean; |
||||
group_by?: string[]; |
||||
group_interval?: string; |
||||
group_wait?: string; |
||||
matchers?: ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1Matcher[]; |
||||
mute_time_intervals?: string[]; |
||||
receiver?: string; |
||||
repeat_interval?: string; |
||||
routes?: ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1Route[]; |
||||
}; |
||||
export type ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RoutingTreeSpec = { |
||||
defaults: ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RouteDefaults; |
||||
routes: ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1Route[]; |
||||
}; |
||||
export type ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RoutingTree = { |
||||
/** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ |
||||
apiVersion?: string; |
||||
/** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ |
||||
kind?: string; |
||||
metadata: IoK8SApimachineryPkgApisMetaV1ObjectMeta; |
||||
spec: ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RoutingTreeSpec; |
||||
}; |
||||
export type IoK8SApimachineryPkgApisMetaV1ListMeta = { |
||||
/** continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. */ |
||||
continue?: string; |
||||
/** remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. */ |
||||
remainingItemCount?: number; |
||||
/** String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency */ |
||||
resourceVersion?: string; |
||||
/** Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. */ |
||||
selfLink?: string; |
||||
}; |
||||
export type ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RoutingTreeList = { |
||||
/** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ |
||||
apiVersion?: string; |
||||
items: ComGithubGrafanaGrafanaPkgApisAlertingNotificationsV0Alpha1RoutingTree[]; |
||||
/** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ |
||||
kind?: string; |
||||
metadata: IoK8SApimachineryPkgApisMetaV1ListMeta; |
||||
}; |
||||
@ -0,0 +1,46 @@ |
||||
import { get } from 'lodash'; |
||||
|
||||
import { FetchError, isFetchError } from '@grafana/runtime'; |
||||
import { t } from 'app/core/internationalization'; |
||||
|
||||
export type SupportedErrors = 'alerting.notifications.conflict' | string; |
||||
|
||||
export const ERROR_NEWER_CONFIGURATION = 'alerting.notifications.conflict'; |
||||
|
||||
/** This function gives us the opportunity to translate or transform error codes that are returned from the Kubernetes APIs */ |
||||
export function getErrorMessageFromCode(code: string): string | undefined { |
||||
const errorMessageMap: Record<SupportedErrors, string> = { |
||||
[ERROR_NEWER_CONFIGURATION]: t( |
||||
'alerting.policies.update-errors.conflict', |
||||
'The notification policy tree has been updated by another user.' |
||||
), |
||||
}; |
||||
|
||||
return errorMessageMap[code]; |
||||
} |
||||
|
||||
export type ApiMachineryError = { |
||||
kind: 'Status'; |
||||
apiVersion: string; |
||||
code: number; |
||||
details: { |
||||
uid: string; |
||||
name?: string; |
||||
group?: string; |
||||
kind?: string; |
||||
retryAfterSeconds?: number; |
||||
causes?: []; // @TODO type this, see apimachinery@v0.31.1/pkg/apis/meta/v1/types.go
|
||||
}; |
||||
status: 'Failure'; |
||||
metadata?: Record<string, unknown>; |
||||
message: string; |
||||
reason: string; |
||||
}; |
||||
|
||||
export function isApiMachineryError(error: unknown): error is FetchError<ApiMachineryError> { |
||||
return isFetchError(error) && get(error.data, 'kind') === 'Status' && get(error.data, 'status') === 'Failure'; |
||||
} |
||||
|
||||
export function matchesApiMachineryError(error: unknown, uid: string) { |
||||
return isApiMachineryError(error) && error.data.details.uid === uid; |
||||
} |
||||
Loading…
Reference in new issue