Argo Workflows · JSON Structure

Argo Workflows Io K8S Api Core V1 Lifecycle Structure

Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.

Type: object Properties: 3
CNCFContainersData ProcessingKubernetesMachine LearningOpen SourceWorkflow Engine

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

Properties

postStart preStop stopSignal

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-lifecycle-structure.json",
  "name": "io.k8s.api.core.v1.Lifecycle",
  "description": "Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.",
  "type": "object",
  "properties": {
    "postStart": {
      "description": "PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks",
      "$ref": "#/definitions/io.k8s.api.core.v1.LifecycleHandler"
    },
    "preStop": {
      "description": "PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks",
      "$ref": "#/definitions/io.k8s.api.core.v1.LifecycleHandler"
    },
    "stopSignal": {
      "description": "StopSignal defines which signal will be sent to a container when it is being stopped. If not specified, the default is defined by the container runtime in use. StopSignal can only be set for Pods with a non-empty .spec.os.name",
      "type": "string"
    }
  }
}