Skip to content
Snippets Groups Projects
0alertmanagerConfigCustomResourceDefinition.yaml 284 KiB
Newer Older
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  annotations:
    controller-gen.kubebuilder.io/version: v0.13.0
    operator.prometheus.io/version: 0.69.1
  name: alertmanagerconfigs.monitoring.coreos.com
spec:
  group: monitoring.coreos.com
  names:
paulfantom's avatar
paulfantom committed
    categories:
    - prometheus-operator
    kind: AlertmanagerConfig
    listKind: AlertmanagerConfigList
    plural: alertmanagerconfigs
    singular: alertmanagerconfig
  scope: Namespaced
  versions:
  - name: v1alpha1
    schema:
      openAPIV3Schema:
        description: AlertmanagerConfig configures the Prometheus Alertmanager, specifying how alerts should be grouped, inhibited and notified to external systems.
        properties:
          apiVersion:
            description: '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'
            type: string
          kind:
            description: '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'
            type: string
          metadata:
            type: object
          spec:
            description: AlertmanagerConfigSpec is a specification of the desired behavior of the Alertmanager configuration. By definition, the Alertmanager configuration only applies to alerts for which the `namespace` label is equal to the namespace of the AlertmanagerConfig resource.
            properties:
              inhibitRules:
                description: List of inhibition rules. The rules will only apply to alerts matching the resource's namespace.
                  description: InhibitRule defines an inhibition rule that allows to mute alerts when other alerts are already firing. See https://prometheus.io/docs/alerting/latest/configuration/#inhibit_rule
                  properties:
                    equal:
                      description: Labels that must have an equal value in the source and target alert for the inhibition to take effect.
                      items:
                        type: string
                      type: array
                    sourceMatch:
                      description: Matchers for which one or more alerts have to exist for the inhibition to take effect. The operator enforces that the alert matches the resource's namespace.
Lili Cosic's avatar
Lili Cosic committed
                        description: Matcher defines how to match on alert's labels.
                            description: Match operation available with AlertManager >= v0.22.0 and takes precedence over Regex (deprecated) if non-empty.
                            enum:
                            - '!='
                            - =
                            - =~
                            - '!~'
                            type: string
Lili Cosic's avatar
Lili Cosic committed
                            description: Label to match.
paulfantom's avatar
paulfantom committed
                            minLength: 1
                            type: string
                          regex:
                            description: Whether to match on equality (false) or regular-expression (true). Deprecated as of AlertManager >= v0.22.0 where a user should use MatchType instead.
                            type: boolean
                          value:
Lili Cosic's avatar
Lili Cosic committed
                            description: Label value to match.
                            type: string
                        required:
                        - name
                        type: object
                      type: array
                    targetMatch:
                      description: Matchers that have to be fulfilled in the alerts to be muted. The operator enforces that the alert matches the resource's namespace.
Lili Cosic's avatar
Lili Cosic committed
                        description: Matcher defines how to match on alert's labels.
                            description: Match operation available with AlertManager >= v0.22.0 and takes precedence over Regex (deprecated) if non-empty.
                            enum:
                            - '!='
                            - =
                            - =~
                            - '!~'
                            type: string
Lili Cosic's avatar
Lili Cosic committed
                            description: Label to match.
paulfantom's avatar
paulfantom committed
                            minLength: 1
                            type: string
                          regex:
                            description: Whether to match on equality (false) or regular-expression (true). Deprecated as of AlertManager >= v0.22.0 where a user should use MatchType instead.
                            type: boolean
                          value:
Lili Cosic's avatar
Lili Cosic committed
                            description: Label value to match.
                            type: string
                        required:
                        - name
                        type: object
                      type: array
                  type: object
                type: array
                description: List of MuteTimeInterval specifying when the routes should be muted.
                  description: MuteTimeInterval specifies the periods in time when notifications will be muted
                  properties:
                    name:
                      description: Name of the time interval
                      type: string
                    timeIntervals:
                      description: TimeIntervals is a list of TimeInterval
                      items:
                        description: TimeInterval describes intervals of time
                        properties:
                          daysOfMonth:
                            description: DaysOfMonth is a list of DayOfMonthRange
                            items:
                              description: DayOfMonthRange is an inclusive range of days of the month beginning at 1
                              properties:
                                end:
                                  description: End of the inclusive range
                                  maximum: 31
                                  minimum: -31
                                  type: integer
                                start:
                                  description: Start of the inclusive range
                                  maximum: 31
                                  minimum: -31
                                  type: integer
                              type: object
                            type: array
                          months:
                            description: Months is a list of MonthRange
                            items:
                              description: MonthRange is an inclusive range of months of the year beginning in January Months can be specified by name (e.g 'January') by numerical month (e.g '1') or as an inclusive range (e.g 'January:March', '1:3', '1:March')
                              pattern: ^((?i)january|february|march|april|may|june|july|august|september|october|november|december|[1-12])(?:((:((?i)january|february|march|april|may|june|july|august|september|october|november|december|[1-12]))$)|$)
                              type: string
                            type: array
                          times:
                            description: Times is a list of TimeRange
                            items:
                              description: TimeRange defines a start and end time in 24hr format
                              properties:
                                endTime:
                                  description: EndTime is the end time in 24hr format.
                                  pattern: ^((([01][0-9])|(2[0-3])):[0-5][0-9])$|(^24:00$)
                                  type: string
                                startTime:
                                  description: StartTime is the start time in 24hr format.
                                  pattern: ^((([01][0-9])|(2[0-3])):[0-5][0-9])$|(^24:00$)
                                  type: string
                              type: object
                            type: array
                          weekdays:
                            description: Weekdays is a list of WeekdayRange
                            items:
                              description: WeekdayRange is an inclusive range of days of the week beginning on Sunday Days can be specified by name (e.g 'Sunday') or as an inclusive range (e.g 'Monday:Friday')
                              pattern: ^((?i)sun|mon|tues|wednes|thurs|fri|satur)day(?:((:(sun|mon|tues|wednes|thurs|fri|satur)day)$)|$)
                              type: string
                            type: array
                          years:
                            description: Years is a list of YearRange
                            items:
                              description: YearRange is an inclusive range of years
                              pattern: ^2\d{3}(?::2\d{3}|$)
                              type: string
                            type: array
                        type: object
                      type: array
                  type: object
                type: array
Lili Cosic's avatar
Lili Cosic committed
                description: List of receivers.
Lili Cosic's avatar
Lili Cosic committed
                  description: Receiver defines one or more notification integrations.
                    discordConfigs:
                      description: List of Discord configurations.
                      items:
                        description: DiscordConfig configures notifications via Discord. See https://prometheus.io/docs/alerting/latest/configuration/#discord_config
                        properties:
                          apiURL:
                            description: The secret's key that contains the Discord webhook URL. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
                            properties:
                              key:
                                description: The key of the secret to select from.  Must be a valid secret key.
                                type: string
                              name:
                                description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
                                type: string
                              optional:
                                description: Specify whether the Secret or its key must be defined
                                type: boolean
                            required:
                            - key
                            type: object
                            x-kubernetes-map-type: atomic
                          httpConfig:
                            description: HTTP client configuration.
Loading
Loading full blame...