Argo Workflows · JSON Structure

Argo Workflows Io K8S Api Core V1 Probe Structure

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Type: object Properties: 10
CNCFContainersData ProcessingKubernetesMachine LearningOpen SourceWorkflow Engine

io.k8s.api.core.v1.Probe is a JSON Structure definition published by Argo Workflows, describing 10 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

exec failureThreshold grpc httpGet initialDelaySeconds periodSeconds successThreshold tcpSocket terminationGracePeriodSeconds timeoutSeconds

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/argo-workflows/refs/heads/main/json-structure/argo-workflows-io-k8s-api-core-v1-probe-structure.json",
  "name": "io.k8s.api.core.v1.Probe",
  "description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
  "type": "object",
  "properties": {
    "exec": {
      "description": "Exec specifies a command to execute in the container.",
      "$ref": "#/definitions/io.k8s.api.core.v1.ExecAction"
    },
    "failureThreshold": {
      "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
      "type": "int32"
    },
    "grpc": {
      "description": "GRPC specifies a GRPC HealthCheckRequest.",
      "$ref": "#/definitions/io.k8s.api.core.v1.GRPCAction"
    },
    "httpGet": {
      "description": "HTTPGet specifies an HTTP GET request to perform.",
      "$ref": "#/definitions/io.k8s.api.core.v1.HTTPGetAction"
    },
    "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",
      "type": "int32"
    },
    "periodSeconds": {
      "description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
      "type": "int32"
    },
    "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.",
      "type": "int32"
    },
    "tcpSocket": {
      "description": "TCPSocket specifies a connection to a TCP port.",
      "$ref": "#/definitions/io.k8s.api.core.v1.TCPSocketAction"
    },
    "terminationGracePeriodSeconds": {
      "description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.",
      "type": "int32"
    },
    "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",
      "type": "int32"
    }
  }
}