Skip to content
Snippets Groups Projects
prometheus-operator-0alertmanagerConfigCustomResourceDefinition.yaml 157 KiB
Newer Older
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  annotations:
    controller-gen.kubebuilder.io/version: v0.6.2
  creationTimestamp: null
  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 defines a namespaced AlertmanagerConfig to
          be aggregated across multiple namespaces configuring one Alertmanager cluster.
        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.
                          matchType:
                            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.
                          matchType:
                            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
              receivers:
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.
Lili Cosic's avatar
Lili Cosic committed
                    emailConfigs:
                      description: List of Email configurations.
                      items:
                        description: EmailConfig configures notifications via Email.
                        properties:
                          authIdentity:
paulfantom's avatar
paulfantom committed
                            description: The identity to use for authentication.
Lili Cosic's avatar
Lili Cosic committed
                            type: string
                          authPassword:
                            description: The secret's key that contains the password
                              to use for authentication. The secret needs to be in
                              the same namespace as the AlertmanagerConfig object
                              and accessible by the Prometheus Operator.
Lili Cosic's avatar
Lili Cosic committed
                            properties:
                              key:
                                description: The key of the secret to select from.  Must
                                  be a valid secret key.
Lili Cosic's avatar
Lili Cosic committed
                                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?'
Lili Cosic's avatar
Lili Cosic committed
                                type: string
                              optional:
                                description: Specify whether the Secret or its key
                                  must be defined
Lili Cosic's avatar
Lili Cosic committed
                                type: boolean
                            required:
                            - key
                            type: object
                          authSecret:
                            description: The secret's key that contains the CRAM-MD5
                              secret. The secret needs to be in the same namespace
                              as the AlertmanagerConfig object and accessible by the
                              Prometheus Operator.
Lili Cosic's avatar
Lili Cosic committed
                            properties:
                              key:
                                description: The key of the secret to select from.  Must
                                  be a valid secret key.
Lili Cosic's avatar
Lili Cosic committed
                                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?'
Lili Cosic's avatar
Lili Cosic committed
                                type: string
                              optional:
                                description: Specify whether the Secret or its key
                                  must be defined
Lili Cosic's avatar
Lili Cosic committed
                                type: boolean
                            required:
                            - key
                            type: object
                          authUsername:
paulfantom's avatar
paulfantom committed
                            description: The username to use for authentication.
Lili Cosic's avatar
Lili Cosic committed
                            type: string
                          from:
                            description: The sender address.
                            type: string
                          headers:
                            description: Further headers email header key/value pairs.
                              Overrides any headers previously set by the notification
                              implementation.
Lili Cosic's avatar
Lili Cosic committed
                            items:
                              description: KeyValue defines a (key, value) tuple.
                              properties:
                                key:
                                  description: Key of the tuple.
paulfantom's avatar
paulfantom committed
                                  minLength: 1
Lili Cosic's avatar
Lili Cosic committed
                                  type: string
                                value:
                                  description: Value of the tuple.
                                  type: string
Loading
Loading full blame...