auditsinkspec.json

{
  "description": "AuditSinkSpec holds the spec for the audit sink",
  "properties": {
    "policy": {
      "description": "Policy defines the configuration of how audit events are logged",
      "properties": {
        "level": {
          "description": "The Level that all requests are recorded at. available options: None, Metadata, Request, RequestResponse required",
          "type": "string"
        },
        "stages": {
          "description": "Stages is a list of stages for which events are created.",
          "items": {
            "type": [
              "string",
              "null"
            ]
          },
          "type": [
            "array",
            "null"
          ]
        }
      },
      "required": [
        "level"
      ],
      "type": [
        "object",
        "null"
      ]
    },
    "webhook": {
      "description": "Webhook holds the configuration of the webhook",
      "properties": {
        "clientConfig": {
          "description": "WebhookClientConfig contains the information to make a connection with the webhook",
          "properties": {
            "caBundle": {
              "description": "`caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used.",
              "format": "byte",
              "type": [
                "string",
                "null"
              ]
            },
            "service": {
              "description": "ServiceReference holds a reference to Service.legacy.k8s.io",
              "properties": {
                "name": {
                  "description": "`name` is the name of the service. Required",
                  "type": "string"
                },
                "namespace": {
                  "description": "`namespace` is the namespace of the service. Required",
                  "type": "string"
                },
                "path": {
                  "description": "`path` is an optional URL path which will be sent in any request to this service.",
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "port": {
                  "description": "If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive).",
                  "format": "int32",
                  "type": [
                    "integer",
                    "null"
                  ]
                }
              },
              "required": [
                "namespace",
                "name"
              ],
              "type": [
                "object",
                "null"
              ]
            },
            "url": {
              "description": "`url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified.\n\nThe `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address.\n\nPlease note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster.\n\nThe scheme must be \"https\"; the URL must begin with \"https://\".\n\nA path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier.\n\nAttempting to use a user or basic auth e.g. \"user:password@\" is not allowed. Fragments (\"#...\") and query parameters (\"?...\") are not allowed, either.",
              "type": [
                "string",
                "null"
              ]
            }
          },
          "type": "object"
        },
        "throttle": {
          "description": "WebhookThrottleConfig holds the configuration for throttling events",
          "properties": {
            "burst": {
              "description": "ThrottleBurst is the maximum number of events sent at the same moment default 15 QPS",
              "format": "int64",
              "type": [
                "integer",
                "null"
              ]
            },
            "qps": {
              "description": "ThrottleQPS maximum number of batches per second default 10 QPS",
              "format": "int64",
              "type": [
                "integer",
                "null"
              ]
            }
          },
          "type": [
            "object",
            "null"
          ]
        }
      },
      "required": [
        "clientConfig"
      ],
      "type": [
        "object",
        "null"
      ]
    }
  },
  "required": [
    "policy",
    "webhook"
  ],
  "type": "object",
  "$schema": "http://json-schema.org/schema#"
}