Skip to content
Snippets Groups Projects
0alertmanagerConfigCustomResourceDefinition.yaml 283 KiB
Newer Older
                                description: OAuth2 client credentials used to fetch a token for the targets.
                                    description: The secret or configmap containing the OAuth2 client id
                                        description: ConfigMap containing data to use for the targets.
                                        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?'
                                            description: Specify whether the ConfigMap or its key must be defined
                                            type: boolean
                                        required:
                                        - key
                                        type: object
                                        x-kubernetes-map-type: atomic
                                        description: Secret containing data to use for the targets.
                                            description: The key of the secret to select from.  Must be a valid secret key.
                                            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?'
                                            description: Specify whether the Secret or its key must be defined
                                            type: boolean
                                        required:
                                        - key
                                        type: object
                                        x-kubernetes-map-type: atomic
                                    type: object
                                  clientSecret:
                                    description: The secret containing the OAuth2 client secret
                                        description: The key of the secret to select from.  Must be a valid secret key.
                                        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?'
                                        description: Specify whether the Secret or its key must be defined
                                        type: boolean
                                    required:
                                    - key
                                    type: object
                                    x-kubernetes-map-type: atomic
                                  endpointParams:
                                    additionalProperties:
                                      type: string
                                    description: Parameters to append to the token URL
                                    description: OAuth2 scopes used for the token request
                                    items:
                                      type: string
                                    type: array
                                  tokenUrl:
                                    description: The URL to fetch the token from
                                    minLength: 1
                                    type: string
                                required:
                                - clientId
                                - clientSecret
                                - tokenUrl
                                type: object
Lili Cosic's avatar
Lili Cosic committed
                              proxyURL:
                                description: Optional proxy URL.
                                type: string
                              tlsConfig:
                                description: TLS configuration for the client.
                                properties:
                                  ca:
                                    description: Certificate authority used when verifying server certificates.
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
                                        x-kubernetes-map-type: atomic
Lili Cosic's avatar
Lili Cosic committed
                                      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
                                        x-kubernetes-map-type: atomic
Lili Cosic's avatar
Lili Cosic committed
                                    type: object
                                  cert:
                                    description: Client certificate to present when doing client-authentication.
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
                                        x-kubernetes-map-type: atomic
Lili Cosic's avatar
Lili Cosic committed
                                      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
                                        x-kubernetes-map-type: atomic
Lili Cosic's avatar
Lili Cosic committed
                                    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
                                    x-kubernetes-map-type: atomic
Lili Cosic's avatar
Lili Cosic committed
                                  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:
                    description: ActiveTimeIntervals is a list of MuteTimeInterval names when this route should be active.
Lili Cosic's avatar
Lili Cosic committed
                  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. Labels must not be repeated (unique list). Special label "..." (aggregate by all possible labels), if provided, must be the only element in the list.
Lili Cosic's avatar
Lili Cosic committed
                    items:
                      type: string
                    type: array
                  groupInterval:
                    description: 'How long to wait before sending an updated notification. Must match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$` Example: "5m"'
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]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$` Example: "30s"'
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:
                          description: Match operation available with AlertManager >= v0.22.0 and takes precedence over Regex (deprecated) if non-empty.
Lili Cosic's avatar
Lili Cosic committed
                        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). Deprecated as of AlertManager >= v0.22.0 where a user should use MatchType instead.
Lili Cosic's avatar
Lili Cosic committed
                          type: boolean
                        value:
                          description: Label value to match.
                          type: string
                      required:
                      - name
                      type: object
                    type: array
                    description: 'Note: this comment applies to the field definition above but appears below otherwise it gets included in the generated manifest. CRD schema doesn''t support self-referential types for now (see https://github.com/kubernetes/kubernetes/issues/62872). We have to use an alternative type to circumvent the limitation. The downside is that the Kube API can''t validate the data beyond the fact that it is a valid JSON representation. MuteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched,'
Lili Cosic's avatar
Lili Cosic committed
                  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]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$` Example: "4h"'
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