provider-notification-v1beta3.json

{
  "description": "Provider is the Schema for the providers API",
  "properties": {
    "apiVersion": {
      "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore 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.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "spec": {
      "description": "ProviderSpec defines the desired state of the Provider.",
      "properties": {
        "address": {
          "description": "Address specifies the endpoint, in a generic sense, to where alerts are sent.\nWhat kind of endpoint depends on the specific Provider type being used.\nFor the generic Provider, for example, this is an HTTP/S address.\nFor other Provider types this could be a project ID or a namespace.",
          "maxLength": 2048,
          "type": "string"
        },
        "certSecretRef": {
          "description": "CertSecretRef specifies the Secret containing\na PEM-encoded CA certificate (in the `ca.crt` key).\n\n\nNote: Support for the `caFile` key has\nbeen deprecated.",
          "properties": {
            "name": {
              "description": "Name of the referent.",
              "type": "string"
            }
          },
          "required": [
            "name"
          ],
          "type": "object",
          "additionalProperties": false
        },
        "channel": {
          "description": "Channel specifies the destination channel where events should be posted.",
          "maxLength": 2048,
          "type": "string"
        },
        "interval": {
          "description": "Interval at which to reconcile the Provider with its Secret references.\nDeprecated and not used in v1beta3.",
          "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
          "type": "string"
        },
        "proxy": {
          "description": "Proxy the HTTP/S address of the proxy server.",
          "maxLength": 2048,
          "pattern": "^(http|https)://.*$",
          "type": "string"
        },
        "secretRef": {
          "description": "SecretRef specifies the Secret containing the authentication\ncredentials for this Provider.",
          "properties": {
            "name": {
              "description": "Name of the referent.",
              "type": "string"
            }
          },
          "required": [
            "name"
          ],
          "type": "object",
          "additionalProperties": false
        },
        "suspend": {
          "description": "Suspend tells the controller to suspend subsequent\nevents handling for this Provider.",
          "type": "boolean"
        },
        "timeout": {
          "description": "Timeout for sending alerts to the Provider.",
          "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m))+$",
          "type": "string"
        },
        "type": {
          "description": "Type specifies which Provider implementation to use.",
          "enum": [
            "slack",
            "discord",
            "msteams",
            "rocket",
            "generic",
            "generic-hmac",
            "github",
            "gitlab",
            "gitea",
            "bitbucketserver",
            "bitbucket",
            "azuredevops",
            "googlechat",
            "googlepubsub",
            "webex",
            "sentry",
            "azureeventhub",
            "telegram",
            "lark",
            "matrix",
            "opsgenie",
            "alertmanager",
            "grafana",
            "githubdispatch",
            "pagerduty",
            "datadog",
            "nats"
          ],
          "type": "string"
        },
        "username": {
          "description": "Username specifies the name under which events are posted.",
          "maxLength": 2048,
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "type": "object",
      "additionalProperties": false
    }
  },
  "type": "object"
}