@jkcfg/kubernetes/schemas/v1.16.0-local/probe.json

jk Kubernetes library

{
  "description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
  "properties": {
    "exec": {
      "$ref": "_definitions.json#/definitions/io.k8s.api.core.v1.ExecAction",
      "description": "One and only one of the following should be specified. Exec specifies the action to take."
    },
    "failureThreshold": {
      "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "httpGet": {
      "$ref": "_definitions.json#/definitions/io.k8s.api.core.v1.HTTPGetAction",
      "description": "HTTPGet specifies the http request to perform."
    },
    "initialDelaySeconds": {
      "description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "periodSeconds": {
      "description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "successThreshold": {
      "description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "tcpSocket": {
      "$ref": "_definitions.json#/definitions/io.k8s.api.core.v1.TCPSocketAction",
      "description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported"
    },
    "timeoutSeconds": {
      "description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    }
  },
  "type": "object",
  "$schema": "http://json-schema.org/schema#"
}