Argo Workflows · JSON Structure

Argo Workflows Io Argoproj Workflow V1Alpha1 Cron Workflow Spec Structure

CronWorkflowSpec is the specification of a CronWorkflow

Type: object Properties: 11 Required: 2
CNCFContainersData ProcessingKubernetesMachine LearningOpen SourceWorkflow Engine

io.argoproj.workflow.v1alpha1.CronWorkflowSpec is a JSON Structure definition published by Argo Workflows, describing 11 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

concurrencyPolicy failedJobsHistoryLimit schedules startingDeadlineSeconds stopStrategy successfulJobsHistoryLimit suspend timezone when workflowMetadata workflowSpec

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-argoproj-workflow-v1alpha1-cron-workflow-spec-structure.json",
  "name": "io.argoproj.workflow.v1alpha1.CronWorkflowSpec",
  "description": "CronWorkflowSpec is the specification of a CronWorkflow",
  "type": "object",
  "properties": {
    "concurrencyPolicy": {
      "description": "ConcurrencyPolicy is the K8s-style concurrency policy that will be used",
      "type": "string"
    },
    "failedJobsHistoryLimit": {
      "description": "FailedJobsHistoryLimit is the number of failed jobs to be kept at a time",
      "type": "int32"
    },
    "schedules": {
      "description": "v3.6 and after: Schedules is a list of schedules to run the Workflow in Cron format",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "startingDeadlineSeconds": {
      "description": "StartingDeadlineSeconds is the K8s-style deadline that will limit the time a CronWorkflow will be run after its original scheduled time if it is missed.",
      "type": "int32"
    },
    "stopStrategy": {
      "description": "v3.6 and after: StopStrategy defines if the CronWorkflow should stop scheduling based on a condition",
      "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.StopStrategy"
    },
    "successfulJobsHistoryLimit": {
      "description": "SuccessfulJobsHistoryLimit is the number of successful jobs to be kept at a time",
      "type": "int32"
    },
    "suspend": {
      "description": "Suspend is a flag that will stop new CronWorkflows from running if set to true",
      "type": "boolean"
    },
    "timezone": {
      "description": "Timezone is the timezone against which the cron schedule will be calculated, e.g. \"Asia/Tokyo\". Default is machine's local time.",
      "type": "string"
    },
    "when": {
      "description": "v3.6 and after: When is an expression that determines if a run should be scheduled.",
      "type": "string"
    },
    "workflowMetadata": {
      "description": "WorkflowMetadata contains some metadata of the workflow to be run",
      "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
    },
    "workflowSpec": {
      "description": "WorkflowSpec is the spec of the workflow to be run",
      "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.WorkflowSpec"
    }
  },
  "required": [
    "workflowSpec",
    "schedules"
  ]
}