io.argoproj.workflow.v1alpha1.CronWorkflowSpec

CronWorkflowSpec is the specification of a CronWorkflow

CNCFContainersData ProcessingKubernetesMachine LearningOpen SourceWorkflow Engine

Properties

Name	Type	Description
concurrencyPolicy	string	ConcurrencyPolicy is the K8s-style concurrency policy that will be used
failedJobsHistoryLimit	integer	FailedJobsHistoryLimit is the number of failed jobs to be kept at a time
schedules	array	v3.6 and after: Schedules is a list of schedules to run the Workflow in Cron format
startingDeadlineSeconds	integer	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.
stopStrategy	object	v3.6 and after: StopStrategy defines if the CronWorkflow should stop scheduling based on a condition
successfulJobsHistoryLimit	integer	SuccessfulJobsHistoryLimit is the number of successful jobs to be kept at a time
suspend	boolean	Suspend is a flag that will stop new CronWorkflows from running if set to true
timezone	string	Timezone is the timezone against which the cron schedule will be calculated, e.g. "Asia/Tokyo". Default is machine's local time.
when	string	v3.6 and after: When is an expression that determines if a run should be scheduled.
workflowMetadata	object	WorkflowMetadata contains some metadata of the workflow to be run
workflowSpec	object	WorkflowSpec is the spec of the workflow to be run

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/argo-workflows/refs/heads/main/json-schema/argo-workflows-io-argoproj-workflow-v1alpha1-cron-workflow-spec-schema.json",
  "title": "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": "integer"
    },
    "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": "integer"
    },
    "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": "integer"
    },
    "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"
  ]
}