Skip to content
Snippets Groups Projects
prometheus-operator-0alertmanagerConfigCustomResourceDefinition.yaml 156 KiB
Newer Older
                                    description: Used to verify the hostname for the
                                      targets.
Lili Cosic's avatar
Lili Cosic committed
                                    type: string
                                type: object
                            type: object
                          messageType:
                            description: Describes the behavior of the alert (CRITICAL,
                              WARNING, INFO).
Lili Cosic's avatar
Lili Cosic committed
                            type: string
                          monitoringTool:
                            description: The monitoring tool the state message is
                              from.
Lili Cosic's avatar
Lili Cosic committed
                            type: string
                          routingKey:
                            description: A key used to map the alert to a team.
                            type: string
                          sendResolved:
                            description: Whether or not to notify about resolved alerts.
                            type: boolean
                          stateMessage:
                            description: Contains long explanation of the alerted
                              problem.
Lili Cosic's avatar
Lili Cosic committed
                            type: string
                        type: object
                      type: array
                    webhookConfigs:
                      description: List of webhook configurations.
                      items:
                        description: WebhookConfig configures notifications via a
                          generic receiver supporting the webhook payload. See https://prometheus.io/docs/alerting/latest/configuration/#webhook_config
Lili Cosic's avatar
Lili Cosic committed
                        properties:
                          httpConfig:
                            description: HTTP client configuration.
                            properties:
                              authorization:
                                description: Authorization header configuration for
                                  the client. This is mutually exclusive with BasicAuth
                                  and is only available starting from Alertmanager
                                  v0.22+.
                                properties:
                                  credentials:
                                    description: The secret's key that contains the
                                      credentials of the request
                                    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
                                  type:
                                    description: Set the authentication type. Defaults
                                      to Bearer, Basic will cause an error
                                    type: string
                                type: object
Lili Cosic's avatar
Lili Cosic committed
                              basicAuth:
                                description: BasicAuth for the client. This is mutually
                                  exclusive with Authorization. If both are defined,
                                  BasicAuth takes precedence.
Lili Cosic's avatar
Lili Cosic committed
                                properties:
                                  password:
                                    description: The secret in the service monitor
                                      namespace that contains the password for authentication.
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
                                  username:
                                    description: The secret in the service monitor
                                      namespace that contains the username for authentication.
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
                                type: object
                              bearerTokenSecret:
                                description: The secret's key that contains the bearer
                                  token to be used by the client 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
                              proxyURL:
                                description: Optional proxy URL.
                                type: string
                              tlsConfig:
                                description: TLS configuration for the client.
                                properties:
                                  ca:
                                    description: Struct containing the CA cert to
                                      use for the targets.
Lili Cosic's avatar
Lili Cosic committed
                                    properties:
                                      configMap:
                                        description: ConfigMap containing data to
                                          use for the targets.
Lili Cosic's avatar
Lili Cosic committed
                                        properties:
                                          key:
                                            description: The key to select.
                                            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 ConfigMap
                                              or its key must be defined
Lili Cosic's avatar
Lili Cosic committed
                                            type: boolean
                                        required:
                                        - key
                                        type: object
                                      secret:
                                        description: Secret containing data to use
                                          for the targets.
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
                                    type: object
                                  cert:
                                    description: Struct containing the client cert
                                      file for the targets.
Lili Cosic's avatar
Lili Cosic committed
                                    properties:
                                      configMap:
                                        description: ConfigMap containing data to
                                          use for the targets.
Lili Cosic's avatar
Lili Cosic committed
                                        properties:
                                          key:
                                            description: The key to select.
                                            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 ConfigMap
                                              or its key must be defined
Lili Cosic's avatar
Lili Cosic committed
                                            type: boolean
                                        required:
                                        - key
                                        type: object
                                      secret:
                                        description: Secret containing data to use
                                          for the targets.
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
                                    type: object
                                  insecureSkipVerify:
                                    description: Disable target certificate validation.
                                    type: boolean
                                  keySecret:
                                    description: Secret containing the client key
                                      file for the targets.
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
                                  serverName:
                                    description: Used to verify the hostname for the
                                      targets.
Lili Cosic's avatar
Lili Cosic committed
                                    type: string
                                type: object
                            type: object
                          maxAlerts:
                            description: Maximum number of alerts to be sent per webhook
                              message. When 0, all alerts are included.
Lili Cosic's avatar
Lili Cosic committed
                            format: int32
paulfantom's avatar
paulfantom committed
                            minimum: 0
Lili Cosic's avatar
Lili Cosic committed
                            type: integer
                          sendResolved:
                            description: Whether or not to notify about resolved alerts.
                            type: boolean
                          url:
                            description: The URL to send HTTP POST requests to. `urlSecret`
                              takes precedence over `url`. One of `urlSecret` and
                              `url` should be defined.
Lili Cosic's avatar
Lili Cosic committed
                            type: string
                          urlSecret:
                            description: The secret's key that contains the webhook
                              URL to send HTTP requests to. `urlSecret` takes precedence
                              over `url`. One of `urlSecret` and `url` should be defined.
                              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
                        type: object
                      type: array
                    wechatConfigs:
                      description: List of WeChat configurations.
                      items:
                        description: WeChatConfig configures notifications via WeChat.
                          See https://prometheus.io/docs/alerting/latest/configuration/#wechat_config
Lili Cosic's avatar
Lili Cosic committed
                        properties:
                          agentID:
                            type: string
                          apiSecret:
                            description: The secret's key that contains the WeChat
                              API key. 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
                          apiURL:
                            description: The WeChat API URL.
                            type: string
                          corpID:
                            description: The corp id for authentication.
                            type: string
                          httpConfig:
                            description: HTTP client configuration.
                            properties:
                              authorization:
                                description: Authorization header configuration for
                                  the client. This is mutually exclusive with BasicAuth
                                  and is only available starting from Alertmanager
                                  v0.22+.
                                properties:
                                  credentials:
                                    description: The secret's key that contains the
                                      credentials of the request
                                    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
                                  type:
                                    description: Set the authentication type. Defaults
                                      to Bearer, Basic will cause an error
                                    type: string
                                type: object
Lili Cosic's avatar
Lili Cosic committed
                              basicAuth:
                                description: BasicAuth for the client. This is mutually
                                  exclusive with Authorization. If both are defined,
                                  BasicAuth takes precedence.
Lili Cosic's avatar
Lili Cosic committed
                                properties:
                                  password:
                                    description: The secret in the service monitor
                                      namespace that contains the password for authentication.
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
                                  username:
                                    description: The secret in the service monitor
                                      namespace that contains the username for authentication.
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
                                type: object
                              bearerTokenSecret:
                                description: The secret's key that contains the bearer
                                  token to be used by the client 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
                              proxyURL:
                                description: Optional proxy URL.
                                type: string
                              tlsConfig:
                                description: TLS configuration for the client.
                                properties:
                                  ca:
                                    description: Struct containing the CA cert to
                                      use for the targets.
Lili Cosic's avatar
Lili Cosic committed
                                    properties:
                                      configMap:
                                        description: ConfigMap containing data to
                                          use for the targets.
Lili Cosic's avatar
Lili Cosic committed
                                        properties:
                                          key:
                                            description: The key to select.
                                            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 ConfigMap
                                              or its key must be defined
Lili Cosic's avatar
Lili Cosic committed
                                            type: boolean
                                        required:
                                        - key
                                        type: object
                                      secret:
                                        description: Secret containing data to use
                                          for the targets.
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
                                    type: object
                                  cert:
                                    description: Struct containing the client cert
                                      file for the targets.
Lili Cosic's avatar
Lili Cosic committed
                                    properties:
                                      configMap:
                                        description: ConfigMap containing data to
                                          use for the targets.
Lili Cosic's avatar
Lili Cosic committed
                                        properties:
                                          key:
                                            description: The key to select.
                                            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 ConfigMap
                                              or its key must be defined
Lili Cosic's avatar
Lili Cosic committed
                                            type: boolean
                                        required:
                                        - key
                                        type: object
                                      secret:
                                        description: Secret containing data to use
                                          for the targets.
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
                                    type: object
                                  insecureSkipVerify:
                                    description: Disable target certificate validation.
                                    type: boolean
                                  keySecret:
                                    description: Secret containing the client key
                                      file for the targets.
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
                                  serverName:
                                    description: Used to verify the hostname for the
                                      targets.
Lili Cosic's avatar
Lili Cosic committed
                                    type: string
                                type: object
                            type: object
                          message:
                            description: API request data as defined by the WeChat
                              API.
Lili Cosic's avatar
Lili Cosic committed
                            type: string
                          messageType:
                            type: string
                          sendResolved:
                            description: Whether or not to notify about resolved alerts.
                            type: boolean
                          toParty:
                            type: string
                          toTag:
                            type: string
                          toUser:
                            type: string
                        type: object
                      type: array
                  required:
                  - name
                  type: object
                type: array
              route:
                description: The Alertmanager route definition for alerts matching
                  the resource’s namespace. If present, it will be added to the generated
                  Alertmanager configuration as a first-level route.
Lili Cosic's avatar
Lili Cosic committed
                properties:
                  continue:
                    description: Boolean indicating whether an alert should continue
                      matching subsequent sibling nodes. It will always be overridden
                      to true for the first-level route by the Prometheus operator.
Lili Cosic's avatar
Lili Cosic committed
                    type: boolean
                  groupBy:
                    description: List of labels to group by.
                    items:
                      type: string
                    type: array
                  groupInterval:
                    description: How long to wait before sending an updated notification.
                      Must match the regular expression `[0-9]+(ms|s|m|h)` (milliseconds
                      seconds minutes hours).
Lili Cosic's avatar
Lili Cosic committed
                    type: string
                  groupWait:
                    description: How long to wait before sending the initial notification.
                      Must match the regular expression `[0-9]+(ms|s|m|h)` (milliseconds
                      seconds minutes hours).
Lili Cosic's avatar
Lili Cosic committed
                    type: string
                  matchers:
                    description: 'List of matchers that the alert’s labels should
                      match. For the first level route, the operator removes any existing
                      equality and regexp matcher on the `namespace` label and adds
                      a `namespace: <object namespace>` matcher.'
Lili Cosic's avatar
Lili Cosic committed
                    items:
                      description: Matcher defines how to match on alert's labels.
                      properties:
                        name:
                          description: Label to match.
paulfantom's avatar
paulfantom committed
                          minLength: 1
Lili Cosic's avatar
Lili Cosic committed
                          type: string
                        regex:
                          description: Whether to match on equality (false) or regular-expression
                            (true).
Lili Cosic's avatar
Lili Cosic committed
                          type: boolean
                        value:
                          description: Label value to match.
                          type: string
                      required:
                      - name
                      type: object
                    type: array
                  receiver:
                    description: Name of the receiver for this route. If not empty,
                      it should be listed in the `receivers` field.
Lili Cosic's avatar
Lili Cosic committed
                    type: string
                  repeatInterval:
                    description: How long to wait before repeating the last notification.
                      Must match the regular expression `[0-9]+(ms|s|m|h)` (milliseconds
                      seconds minutes hours).
Lili Cosic's avatar
Lili Cosic committed
                    type: string
                  routes:
                    description: Child routes.
                    items:
                      x-kubernetes-preserve-unknown-fields: true
                    type: array
                type: object
            type: object
        required:
        - spec
        type: object
    served: true
    storage: true
status:
  acceptedNames:
    kind: ""
    plural: ""
  conditions: []
  storedVersions: []