{ "swagger": "2.0", "info": { "title": "Argo", "version": "v2.4.3" }, "paths": {}, "definitions": { "io.argoproj.workflow.v1alpha1.ArchiveStrategy": { "description": "ArchiveStrategy describes how to archive files/directory when saving artifacts", "type": "object", "properties": { "none": { "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.NoneStrategy" }, "tar": { "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.TarStrategy" } } }, "io.argoproj.workflow.v1alpha1.Arguments": { "description": "Arguments to a template", "type": "object", "properties": { "artifacts": { "description": "Artifacts is the list of artifacts to pass to the template or workflow", "type": "array", "items": { "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Artifact" }, "x-kubernetes-patch-merge-key": "name", "x-kubernetes-patch-strategy": "merge" }, "parameters": { "description": "Parameters is the list of parameters to pass to the template or workflow", "type": "array", "items": { "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Parameter" }, "x-kubernetes-patch-merge-key": "name", "x-kubernetes-patch-strategy": "merge" } } }, "io.argoproj.workflow.v1alpha1.Artifact": { "description": "Artifact indicates an artifact to place at a specified path", "type": "object", "required": [ "name" ], "properties": { "archive": { "description": "Archive controls how the artifact will be saved to the artifact repository.", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.ArchiveStrategy" }, "archiveLogs": { "description": "ArchiveLogs indicates if the container logs should be archived", "type": "boolean" }, "artifactory": { "description": "Artifactory contains artifactory artifact location details", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.ArtifactoryArtifact" }, "from": { "description": "From allows an artifact to reference an artifact from a previous step", "type": "string" }, "git": { "description": "Git contains git artifact location details", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.GitArtifact" }, "globalName": { "description": "GlobalName exports an output artifact to the global scope, making it available as '{{workflow.outputs.artifacts.XXXX}} and in workflow.status.outputs.artifacts", "type": "string" }, "hdfs": { "description": "HDFS contains HDFS artifact location details", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.HDFSArtifact" }, "http": { "description": "HTTP contains HTTP artifact location details", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.HTTPArtifact" }, "mode": { "description": "mode bits to use on this file, must be a value between 0 and 0777 set when loading input artifacts.", "type": "integer", "format": "int32" }, "name": { "description": "name of the artifact. must be unique within a template's inputs/outputs.", "type": "string" }, "optional": { "description": "Make Artifacts optional, if Artifacts doesn't generate or exist", "type": "boolean" }, "path": { "description": "Path is the container path to the artifact", "type": "string" }, "raw": { "description": "Raw contains raw artifact location details", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.RawArtifact" }, "s3": { "description": "S3 contains S3 artifact location details", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.S3Artifact" } } }, "io.argoproj.workflow.v1alpha1.ArtifactLocation": { "description": "ArtifactLocation describes a location for a single or multiple artifacts. It is used as single artifact in the context of inputs/outputs (e.g. outputs.artifacts.artname). It is also used to describe the location of multiple artifacts such as the archive location of a single workflow step, which the executor will use as a default location to store its files.", "type": "object", "properties": { "archiveLogs": { "description": "ArchiveLogs indicates if the container logs should be archived", "type": "boolean" }, "artifactory": { "description": "Artifactory contains artifactory artifact location details", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.ArtifactoryArtifact" }, "git": { "description": "Git contains git artifact location details", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.GitArtifact" }, "hdfs": { "description": "HDFS contains HDFS artifact location details", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.HDFSArtifact" }, "http": { "description": "HTTP contains HTTP artifact location details", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.HTTPArtifact" }, "raw": { "description": "Raw contains raw artifact location details", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.RawArtifact" }, "s3": { "description": "S3 contains S3 artifact location details", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.S3Artifact" } } }, "io.argoproj.workflow.v1alpha1.ArtifactRepositoryRef": { "type": "object", "properties": { "configMap": { "type": "string" }, "key": { "type": "string" } } }, "io.argoproj.workflow.v1alpha1.ArtifactoryArtifact": { "description": "ArtifactoryArtifact is the location of an artifactory artifact", "type": "object", "required": [ "url" ], "properties": { "passwordSecret": { "description": "PasswordSecret is the secret selector to the repository password", "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector" }, "url": { "description": "URL of the artifact", "type": "string" }, "usernameSecret": { "description": "UsernameSecret is the secret selector to the repository username", "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector" } } }, "io.argoproj.workflow.v1alpha1.ArtifactoryAuth": { "description": "ArtifactoryAuth describes the secret selectors required for authenticating to artifactory", "type": "object", "properties": { "passwordSecret": { "description": "PasswordSecret is the secret selector to the repository password", "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector" }, "usernameSecret": { "description": "UsernameSecret is the secret selector to the repository username", "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector" } } }, "io.argoproj.workflow.v1alpha1.ContinueOn": { "description": "ContinueOn defines if a workflow should continue even if a task or step fails/errors. It can be specified if the workflow should continue when the pod errors, fails or both.", "type": "object", "properties": { "error": { "type": "boolean" }, "failed": { "type": "boolean" } } }, "io.argoproj.workflow.v1alpha1.DAGTask": { "description": "DAGTask represents a node in the graph during DAG execution", "type": "object", "required": [ "name", "template" ], "properties": { "arguments": { "description": "Arguments are the parameter and artifact arguments to the template", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Arguments" }, "continueOn": { "description": "ContinueOn makes argo to proceed with the following step even if this step fails. Errors and Failed states can be specified", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.ContinueOn" }, "dependencies": { "description": "Dependencies are name of other targets which this depends on", "type": "array", "items": { "type": "string" } }, "name": { "description": "Name is the name of the target", "type": "string" }, "template": { "description": "Name of template to execute", "type": "string" }, "templateRef": { "description": "TemplateRef is the reference to the template resource to execute.", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.TemplateRef" }, "when": { "description": "When is an expression in which the task should conditionally execute", "type": "string" }, "withItems": { "description": "WithItems expands a task into multiple parallel tasks from the items in the list", "type": "array", "items": { "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Item" } }, "withParam": { "description": "WithParam expands a task into multiple parallel tasks from the value in the parameter, which is expected to be a JSON list.", "type": "string" }, "withSequence": { "description": "WithSequence expands a task into a numeric sequence", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Sequence" } } }, "io.argoproj.workflow.v1alpha1.DAGTemplate": { "description": "DAGTemplate is a template subtype for directed acyclic graph templates", "type": "object", "required": [ "tasks" ], "properties": { "failFast": { "description": "This flag is for DAG logic. The DAG logic has a built-in \"fail fast\" feature to stop scheduling new steps, as soon as it detects that one of the DAG nodes is failed. Then it waits until all DAG nodes are completed before failing the DAG itself. The FailFast flag default is true, if set to false, it will allow a DAG to run all branches of the DAG to completion (either success or failure), regardless of the failed outcomes of branches in the DAG. More info and example about this feature at https://github.com/argoproj/argo/issues/1442", "type": "boolean" }, "target": { "description": "Target are one or more names of targets to execute in a DAG", "type": "string" }, "tasks": { "description": "Tasks are a list of DAG tasks", "type": "array", "items": { "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.DAGTask" }, "x-kubernetes-patch-merge-key": "name", "x-kubernetes-patch-strategy": "merge" } } }, "io.argoproj.workflow.v1alpha1.ExecutorConfig": { "description": "ExecutorConfig holds configurations of an executor container.", "type": "object", "properties": { "serviceAccountName": { "description": "ServiceAccountName specifies the service account name of the executor container.", "type": "string" } } }, "io.argoproj.workflow.v1alpha1.GitArtifact": { "description": "GitArtifact is the location of an git artifact", "type": "object", "required": [ "repo" ], "properties": { "depth": { "description": "Depth specifies clones/fetches should be shallow and include the given number of commits from the branch tip", "type": "integer", "format": "int32" }, "fetch": { "description": "Fetch specifies a number of refs that should be fetched before checkout", "type": "array", "items": { "type": "string" } }, "insecureIgnoreHostKey": { "description": "InsecureIgnoreHostKey disables SSH strict host key checking during git clone", "type": "boolean" }, "passwordSecret": { "description": "PasswordSecret is the secret selector to the repository password", "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector" }, "repo": { "description": "Repo is the git repository", "type": "string" }, "revision": { "description": "Revision is the git commit, tag, branch to checkout", "type": "string" }, "sshPrivateKeySecret": { "description": "SSHPrivateKeySecret is the secret selector to the repository ssh private key", "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector" }, "usernameSecret": { "description": "UsernameSecret is the secret selector to the repository username", "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector" } } }, "io.argoproj.workflow.v1alpha1.HDFSArtifact": { "description": "HDFSArtifact is the location of an HDFS artifact", "type": "object", "required": [ "addresses", "path" ], "properties": { "addresses": { "description": "Addresses is accessible addresses of HDFS name nodes", "type": "array", "items": { "type": "string" } }, "force": { "description": "Force copies a file forcibly even if it exists (default: false)", "type": "boolean" }, "hdfsUser": { "description": "HDFSUser is the user to access HDFS file system. It is ignored if either ccache or keytab is used.", "type": "string" }, "krbCCacheSecret": { "description": "KrbCCacheSecret is the secret selector for Kerberos ccache Either ccache or keytab can be set to use Kerberos.", "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector" }, "krbConfigConfigMap": { "description": "KrbConfig is the configmap selector for Kerberos config as string It must be set if either ccache or keytab is used.", "$ref": "#/definitions/io.k8s.api.core.v1.ConfigMapKeySelector" }, "krbKeytabSecret": { "description": "KrbKeytabSecret is the secret selector for Kerberos keytab Either ccache or keytab can be set to use Kerberos.", "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector" }, "krbRealm": { "description": "KrbRealm is the Kerberos realm used with Kerberos keytab It must be set if keytab is used.", "type": "string" }, "krbServicePrincipalName": { "description": "KrbServicePrincipalName is the principal name of Kerberos service It must be set if either ccache or keytab is used.", "type": "string" }, "krbUsername": { "description": "KrbUsername is the Kerberos username used with Kerberos keytab It must be set if keytab is used.", "type": "string" }, "path": { "description": "Path is a file path in HDFS", "type": "string" } } }, "io.argoproj.workflow.v1alpha1.HDFSConfig": { "description": "HDFSConfig is configurations for HDFS", "type": "object", "required": [ "addresses" ], "properties": { "addresses": { "description": "Addresses is accessible addresses of HDFS name nodes", "type": "array", "items": { "type": "string" } }, "hdfsUser": { "description": "HDFSUser is the user to access HDFS file system. It is ignored if either ccache or keytab is used.", "type": "string" }, "krbCCacheSecret": { "description": "KrbCCacheSecret is the secret selector for Kerberos ccache Either ccache or keytab can be set to use Kerberos.", "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector" }, "krbConfigConfigMap": { "description": "KrbConfig is the configmap selector for Kerberos config as string It must be set if either ccache or keytab is used.", "$ref": "#/definitions/io.k8s.api.core.v1.ConfigMapKeySelector" }, "krbKeytabSecret": { "description": "KrbKeytabSecret is the secret selector for Kerberos keytab Either ccache or keytab can be set to use Kerberos.", "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector" }, "krbRealm": { "description": "KrbRealm is the Kerberos realm used with Kerberos keytab It must be set if keytab is used.", "type": "string" }, "krbServicePrincipalName": { "description": "KrbServicePrincipalName is the principal name of Kerberos service It must be set if either ccache or keytab is used.", "type": "string" }, "krbUsername": { "description": "KrbUsername is the Kerberos username used with Kerberos keytab It must be set if keytab is used.", "type": "string" } } }, "io.argoproj.workflow.v1alpha1.HDFSKrbConfig": { "description": "HDFSKrbConfig is auth configurations for Kerberos", "type": "object", "properties": { "krbCCacheSecret": { "description": "KrbCCacheSecret is the secret selector for Kerberos ccache Either ccache or keytab can be set to use Kerberos.", "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector" }, "krbConfigConfigMap": { "description": "KrbConfig is the configmap selector for Kerberos config as string It must be set if either ccache or keytab is used.", "$ref": "#/definitions/io.k8s.api.core.v1.ConfigMapKeySelector" }, "krbKeytabSecret": { "description": "KrbKeytabSecret is the secret selector for Kerberos keytab Either ccache or keytab can be set to use Kerberos.", "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector" }, "krbRealm": { "description": "KrbRealm is the Kerberos realm used with Kerberos keytab It must be set if keytab is used.", "type": "string" }, "krbServicePrincipalName": { "description": "KrbServicePrincipalName is the principal name of Kerberos service It must be set if either ccache or keytab is used.", "type": "string" }, "krbUsername": { "description": "KrbUsername is the Kerberos username used with Kerberos keytab It must be set if keytab is used.", "type": "string" } } }, "io.argoproj.workflow.v1alpha1.HTTPArtifact": { "description": "HTTPArtifact allows an file served on HTTP to be placed as an input artifact in a container", "type": "object", "required": [ "url" ], "properties": { "url": { "description": "URL of the artifact", "type": "string" } } }, "io.argoproj.workflow.v1alpha1.Inputs": { "description": "Inputs are the mechanism for passing parameters, artifacts, volumes from one template to another", "type": "object", "properties": { "artifacts": { "description": "Artifact are a list of artifacts passed as inputs", "type": "array", "items": { "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Artifact" }, "x-kubernetes-patch-merge-key": "name", "x-kubernetes-patch-strategy": "merge" }, "parameters": { "description": "Parameters are a list of parameters passed as inputs", "type": "array", "items": { "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Parameter" }, "x-kubernetes-patch-merge-key": "name", "x-kubernetes-patch-strategy": "merge" } } }, "io.argoproj.workflow.v1alpha1.Item": { "description": "Item expands a single workflow step into multiple parallel steps The value of Item can be a map, string, bool, or number", "type": "string", "format": "item" }, "io.argoproj.workflow.v1alpha1.Metadata": { "description": "Pod metdata", "type": "object", "properties": { "annotations": { "type": "object", "additionalProperties": { "type": "string" } }, "labels": { "type": "object", "additionalProperties": { "type": "string" } } } }, "io.argoproj.workflow.v1alpha1.NodeStatus": { "description": "NodeStatus contains status information about an individual node in the workflow", "type": "object", "required": [ "id", "name", "displayName", "type" ], "properties": { "boundaryID": { "description": "BoundaryID indicates the node ID of the associated template root node in which this node belongs to", "type": "string" }, "children": { "description": "Children is a list of child node IDs", "type": "array", "items": { "type": "string" } }, "daemoned": { "description": "Daemoned tracks whether or not this node was daemoned and need to be terminated", "type": "boolean" }, "displayName": { "description": "DisplayName is a human readable representation of the node. Unique within a template boundary", "type": "string" }, "finishedAt": { "description": "Time at which this node completed", "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time" }, "id": { "description": "ID is a unique identifier of a node within the worklow It is implemented as a hash of the node name, which makes the ID deterministic", "type": "string" }, "inputs": { "description": "Inputs captures input parameter values and artifact locations supplied to this template invocation", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Inputs" }, "message": { "description": "A human readable message indicating details about why the node is in this condition.", "type": "string" }, "name": { "description": "Name is unique name in the node tree used to generate the node ID", "type": "string" }, "outboundNodes": { "description": "OutboundNodes tracks the node IDs which are considered \"outbound\" nodes to a template invocation. For every invocation of a template, there are nodes which we considered as \"outbound\". Essentially, these are last nodes in the execution sequence to run, before the template is considered completed. These nodes are then connected as parents to a following step.\n\nIn the case of single pod steps (i.e. container, script, resource templates), this list will be nil since the pod itself is already considered the \"outbound\" node. In the case of DAGs, outbound nodes are the \"target\" tasks (tasks with no children). In the case of steps, outbound nodes are all the containers involved in the last step group. NOTE: since templates are composable, the list of outbound nodes are carried upwards when a DAG/steps template invokes another DAG/steps template. In other words, the outbound nodes of a template, will be a superset of the outbound nodes of its last children.", "type": "array", "items": { "type": "string" } }, "outputs": { "description": "Outputs captures output parameter values and artifact locations produced by this template invocation", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Outputs" }, "phase": { "description": "Phase a simple, high-level summary of where the node is in its lifecycle. Can be used as a state machine.", "type": "string" }, "podIP": { "description": "PodIP captures the IP of the pod for daemoned steps", "type": "string" }, "startedAt": { "description": "Time at which this node started", "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time" }, "storedTemplateID": { "description": "StoredTemplateID is the ID of stored template. DEPRECATED: This value is not used anymore.", "type": "string" }, "templateName": { "description": "TemplateName is the template name which this node corresponds to. Not applicable to virtual nodes (e.g. Retry, StepGroup)", "type": "string" }, "templateRef": { "description": "TemplateRef is the reference to the template resource which this node corresponds to. Not applicable to virtual nodes (e.g. Retry, StepGroup)", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.TemplateRef" }, "templateScope": { "description": "TemplateScope is the template scope in which the template of this node was retrieved.", "type": "string" }, "type": { "description": "Type indicates type of node", "type": "string" }, "workflowTemplateName": { "description": "WorkflowTemplateName is the WorkflowTemplate resource name on which the resolved template of this node is retrieved. DEPRECATED: This value is not used anymore.", "type": "string" } } }, "io.argoproj.workflow.v1alpha1.NoneStrategy": { "description": "NoneStrategy indicates to skip tar process and upload the files or directory tree as independent files. Note that if the artifact is a directory, the artifact driver must support the ability to save/load the directory appropriately.", "type": "object" }, "io.argoproj.workflow.v1alpha1.Outputs": { "description": "Outputs hold parameters, artifacts, and results from a step", "type": "object", "properties": { "artifacts": { "description": "Artifacts holds the list of output artifacts produced by a step", "type": "array", "items": { "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Artifact" }, "x-kubernetes-patch-merge-key": "name", "x-kubernetes-patch-strategy": "merge" }, "parameters": { "description": "Parameters holds the list of output parameters produced by a step", "type": "array", "items": { "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Parameter" }, "x-kubernetes-patch-merge-key": "name", "x-kubernetes-patch-strategy": "merge" }, "result": { "description": "Result holds the result (stdout) of a script template", "type": "string" } } }, "io.argoproj.workflow.v1alpha1.Parameter": { "description": "Parameter indicate a passed string parameter to a service template with an optional default value", "type": "object", "required": [ "name" ], "properties": { "default": { "description": "Default is the default value to use for an input parameter if a value was not supplied", "type": "string" }, "globalName": { "description": "GlobalName exports an output parameter to the global scope, making it available as '{{workflow.outputs.parameters.XXXX}} and in workflow.status.outputs.parameters", "type": "string" }, "name": { "description": "Name is the parameter name", "type": "string" }, "value": { "description": "Value is the literal value to use for the parameter. If specified in the context of an input parameter, the value takes precedence over any passed values", "type": "string" }, "valueFrom": { "description": "ValueFrom is the source for the output parameter's value", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.ValueFrom" } } }, "io.argoproj.workflow.v1alpha1.PodGC": { "description": "PodGC describes how to delete completed pods as they complete", "type": "object", "properties": { "strategy": { "type": "string" } } }, "io.argoproj.workflow.v1alpha1.RawArtifact": { "description": "RawArtifact allows raw string content to be placed as an artifact in a container", "type": "object", "required": [ "data" ], "properties": { "data": { "description": "Data is the string contents of the artifact", "type": "string" } } }, "io.argoproj.workflow.v1alpha1.ResourceTemplate": { "description": "ResourceTemplate is a template subtype to manipulate kubernetes resources", "type": "object", "required": [ "action", "manifest" ], "properties": { "action": { "description": "Action is the action to perform to the resource. Must be one of: get, create, apply, delete, replace, patch", "type": "string" }, "failureCondition": { "description": "FailureCondition is a label selector expression which describes the conditions of the k8s resource in which the step was considered failed", "type": "string" }, "manifest": { "description": "Manifest contains the kubernetes manifest", "type": "string" }, "mergeStrategy": { "description": "MergeStrategy is the strategy used to merge a patch. It defaults to \"strategic\" Must be one of: strategic, merge, json", "type": "string" }, "setOwnerReference": { "description": "SetOwnerReference sets the reference to the workflow on the OwnerReference of generated resource.", "type": "boolean" }, "successCondition": { "description": "SuccessCondition is a label selector expression which describes the conditions of the k8s resource in which it is acceptable to proceed to the following step", "type": "string" } } }, "io.argoproj.workflow.v1alpha1.RetryStrategy": { "description": "RetryStrategy provides controls on how to retry a workflow step", "type": "object", "properties": { "limit": { "description": "Limit is the maximum number of attempts when retrying a container", "type": "integer", "format": "int32" } } }, "io.argoproj.workflow.v1alpha1.S3Artifact": { "description": "S3Artifact is the location of an S3 artifact", "type": "object", "required": [ "endpoint", "bucket", "accessKeySecret", "secretKeySecret", "key" ], "properties": { "accessKeySecret": { "description": "AccessKeySecret is the secret selector to the bucket's access key", "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector" }, "bucket": { "description": "Bucket is the name of the bucket", "type": "string" }, "endpoint": { "description": "Endpoint is the hostname of the bucket endpoint", "type": "string" }, "insecure": { "description": "Insecure will connect to the service with TLS", "type": "boolean" }, "key": { "description": "Key is the key in the bucket where the artifact resides", "type": "string" }, "region": { "description": "Region contains the optional bucket region", "type": "string" }, "roleARN": { "description": "RoleARN is the Amazon Resource Name (ARN) of the role to assume.", "type": "string" }, "secretKeySecret": { "description": "SecretKeySecret is the secret selector to the bucket's secret key", "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector" } } }, "io.argoproj.workflow.v1alpha1.S3Bucket": { "description": "S3Bucket contains the access information required for interfacing with an S3 bucket", "type": "object", "required": [ "endpoint", "bucket", "accessKeySecret", "secretKeySecret" ], "properties": { "accessKeySecret": { "description": "AccessKeySecret is the secret selector to the bucket's access key", "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector" }, "bucket": { "description": "Bucket is the name of the bucket", "type": "string" }, "endpoint": { "description": "Endpoint is the hostname of the bucket endpoint", "type": "string" }, "insecure": { "description": "Insecure will connect to the service with TLS", "type": "boolean" }, "region": { "description": "Region contains the optional bucket region", "type": "string" }, "roleARN": { "description": "RoleARN is the Amazon Resource Name (ARN) of the role to assume.", "type": "string" }, "secretKeySecret": { "description": "SecretKeySecret is the secret selector to the bucket's secret key", "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector" } } }, "io.argoproj.workflow.v1alpha1.ScriptTemplate": { "description": "ScriptTemplate is a template subtype to enable scripting through code steps", "type": "object", "required": [ "name", "source" ], "properties": { "args": { "description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell", "type": "array", "items": { "type": "string" } }, "command": { "description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell", "type": "array", "items": { "type": "string" } }, "env": { "description": "List of environment variables to set in the container. Cannot be updated.", "type": "array", "items": { "$ref": "#/definitions/io.k8s.api.core.v1.EnvVar" }, "x-kubernetes-patch-merge-key": "name", "x-kubernetes-patch-strategy": "merge" }, "envFrom": { "description": "List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.", "type": "array", "items": { "$ref": "#/definitions/io.k8s.api.core.v1.EnvFromSource" } }, "image": { "description": "Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.", "type": "string" }, "imagePullPolicy": { "description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images", "type": "string" }, "lifecycle": { "description": "Actions that the management system should take in response to container lifecycle events. Cannot be updated.", "$ref": "#/definitions/io.k8s.api.core.v1.Lifecycle" }, "livenessProbe": { "description": "Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "$ref": "#/definitions/io.k8s.api.core.v1.Probe" }, "name": { "description": "Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.", "type": "string" }, "ports": { "description": "List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated.", "type": "array", "items": { "$ref": "#/definitions/io.k8s.api.core.v1.ContainerPort" }, "x-kubernetes-list-map-keys": [ "containerPort", "protocol" ], "x-kubernetes-list-type": "map", "x-kubernetes-patch-merge-key": "containerPort", "x-kubernetes-patch-strategy": "merge" }, "readinessProbe": { "description": "Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "$ref": "#/definitions/io.k8s.api.core.v1.Probe" }, "resources": { "description": "Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", "$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements" }, "securityContext": { "description": "Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/", "$ref": "#/definitions/io.k8s.api.core.v1.SecurityContext" }, "source": { "description": "Source contains the source code of the script to execute", "type": "string" }, "stdin": { "description": "Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.", "type": "boolean" }, "stdinOnce": { "description": "Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false", "type": "boolean" }, "terminationMessagePath": { "description": "Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.", "type": "string" }, "terminationMessagePolicy": { "description": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.", "type": "string" }, "tty": { "description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.", "type": "boolean" }, "volumeDevices": { "description": "volumeDevices is the list of block devices to be used by the container. This is a beta feature.", "type": "array", "items": { "$ref": "#/definitions/io.k8s.api.core.v1.VolumeDevice" }, "x-kubernetes-patch-merge-key": "devicePath", "x-kubernetes-patch-strategy": "merge" }, "volumeMounts": { "description": "Pod volumes to mount into the container's filesystem. Cannot be updated.", "type": "array", "items": { "$ref": "#/definitions/io.k8s.api.core.v1.VolumeMount" }, "x-kubernetes-patch-merge-key": "mountPath", "x-kubernetes-patch-strategy": "merge" }, "workingDir": { "description": "Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.", "type": "string" } } }, "io.argoproj.workflow.v1alpha1.Sequence": { "description": "Sequence expands a workflow step into numeric range", "type": "object", "properties": { "count": { "description": "Count is number of elements in the sequence (default: 0). Not to be used with end", "type": "string" }, "end": { "description": "Number at which to end the sequence (default: 0). Not to be used with Count", "type": "string" }, "format": { "description": "Format is a printf format string to format the value in the sequence", "type": "string" }, "start": { "description": "Number at which to start the sequence (default: 0)", "type": "string" } } }, "io.argoproj.workflow.v1alpha1.SuspendTemplate": { "description": "SuspendTemplate is a template subtype to suspend a workflow at a predetermined point in time", "type": "object", "properties": { "duration": { "description": "Duration is the seconds to wait before automatically resuming a template", "type": "integer", "format": "int32" } } }, "io.argoproj.workflow.v1alpha1.TarStrategy": { "description": "TarStrategy will tar and gzip the file or directory when saving", "type": "object" }, "io.argoproj.workflow.v1alpha1.Template": { "description": "Template is a reusable and composable unit of execution in a workflow", "type": "object", "required": [ "name" ], "properties": { "activeDeadlineSeconds": { "description": "Optional duration in seconds relative to the StartTime that the pod may be active on a node before the system actively tries to terminate the pod; value must be positive integer This field is only applicable to container and script templates.", "type": "integer", "format": "int64" }, "affinity": { "description": "Affinity sets the pod's scheduling constraints Overrides the affinity set at the workflow level (if any)", "$ref": "#/definitions/io.k8s.api.core.v1.Affinity" }, "archiveLocation": { "description": "Location in which all files related to the step will be stored (logs, artifacts, etc...). Can be overridden by individual items in Outputs. If omitted, will use the default artifact repository location configured in the controller, appended with the \u003cworkflowname\u003e/\u003cnodename\u003e in the key.", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.ArtifactLocation" }, "arguments": { "description": "Arguments hold arguments to the template.", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Arguments" }, "automountServiceAccountToken": { "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in pods. ServiceAccountName of ExecutorConfig must be specified if this value is false.", "type": "boolean" }, "container": { "description": "Container is the main container image to run in the pod", "$ref": "#/definitions/io.k8s.api.core.v1.Container" }, "daemon": { "description": "Deamon will allow a workflow to proceed to the next step so long as the container reaches readiness", "type": "boolean" }, "dag": { "description": "DAG template subtype which runs a DAG", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.DAGTemplate" }, "executor": { "description": "Executor holds configurations of the executor container.", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.ExecutorConfig" }, "hostAliases": { "description": "HostAliases is an optional list of hosts and IPs that will be injected into the pod spec", "type": "array", "items": { "$ref": "#/definitions/io.k8s.api.core.v1.HostAlias" }, "x-kubernetes-patch-merge-key": "ip", "x-kubernetes-patch-strategy": "merge" }, "initContainers": { "description": "InitContainers is a list of containers which run before the main container.", "type": "array", "items": { "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.UserContainer" }, "x-kubernetes-patch-merge-key": "name", "x-kubernetes-patch-strategy": "merge" }, "inputs": { "description": "Inputs describe what inputs parameters and artifacts are supplied to this template", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Inputs" }, "metadata": { "description": "Metdata sets the pods's metadata, i.e. annotations and labels", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Metadata" }, "name": { "description": "Name is the name of the template", "type": "string" }, "nodeSelector": { "description": "NodeSelector is a selector to schedule this step of the workflow to be run on the selected node(s). Overrides the selector set at the workflow level.", "type": "object", "additionalProperties": { "type": "string" } }, "outputs": { "description": "Outputs describe the parameters and artifacts that this template produces", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Outputs" }, "parallelism": { "description": "Parallelism limits the max total parallel pods that can execute at the same time within the boundaries of this template invocation. If additional steps/dag templates are invoked, the pods created by those templates will not be counted towards this total.", "type": "integer", "format": "int64" }, "podSpecPatch": { "description": "PodSpecPatch holds strategic merge patch to apply against the pod spec. Allows parameterization of container fields which are not strings (e.g. resource limits).", "type": "string" }, "priority": { "description": "Priority to apply to workflow pods.", "type": "integer", "format": "int32" }, "priorityClassName": { "description": "PriorityClassName to apply to workflow pods.", "type": "string" }, "resource": { "description": "Resource template subtype which can run k8s resources", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.ResourceTemplate" }, "retryStrategy": { "description": "RetryStrategy describes how to retry a template when it fails", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.RetryStrategy" }, "schedulerName": { "description": "If specified, the pod will be dispatched by specified scheduler. Or it will be dispatched by workflow scope scheduler if specified. If neither specified, the pod will be dispatched by default scheduler.", "type": "string" }, "script": { "description": "Script runs a portion of code against an interpreter", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.ScriptTemplate" }, "securityContext": { "description": "SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.", "$ref": "#/definitions/io.k8s.api.core.v1.PodSecurityContext" }, "serviceAccountName": { "description": "ServiceAccountName to apply to workflow pods", "type": "string" }, "sidecars": { "description": "Sidecars is a list of containers which run alongside the main container Sidecars are automatically killed when the main container completes", "type": "array", "items": { "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.UserContainer" }, "x-kubernetes-patch-merge-key": "name", "x-kubernetes-patch-strategy": "merge" }, "steps": { "description": "Steps define a series of sequential/parallel workflow steps", "type": "array", "items": { "type": "array", "items": { "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.WorkflowStep" } } }, "suspend": { "description": "Suspend template subtype which can suspend a workflow when reaching the step", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.SuspendTemplate" }, "template": { "description": "Template is the name of the template which is used as the base of this template.", "type": "string" }, "templateRef": { "description": "TemplateRef is the reference to the template resource which is used as the base of this template.", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.TemplateRef" }, "tolerations": { "description": "Tolerations to apply to workflow pods.", "type": "array", "items": { "$ref": "#/definitions/io.k8s.api.core.v1.Toleration" }, "x-kubernetes-patch-merge-key": "key", "x-kubernetes-patch-strategy": "merge" }, "volumes": { "description": "Volumes is a list of volumes that can be mounted by containers in a template.", "type": "array", "items": { "$ref": "#/definitions/io.k8s.api.core.v1.Volume" }, "x-kubernetes-patch-merge-key": "name", "x-kubernetes-patch-strategy": "merge" } } }, "io.argoproj.workflow.v1alpha1.TemplateRef": { "description": "TemplateRef is a reference of template resource.", "type": "object", "properties": { "name": { "description": "Name is the resource name of the template.", "type": "string" }, "runtimeResolution": { "description": "RuntimeResolution skips validation at creation time. By enabling this option, you can create the referred workflow template before the actual runtime.", "type": "boolean" }, "template": { "description": "Template is the name of referred template in the resource.", "type": "string" } } }, "io.argoproj.workflow.v1alpha1.UserContainer": { "description": "UserContainer is a container specified by a user.", "type": "object", "required": [ "name" ], "properties": { "args": { "description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell", "type": "array", "items": { "type": "string" } }, "command": { "description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell", "type": "array", "items": { "type": "string" } }, "env": { "description": "List of environment variables to set in the container. Cannot be updated.", "type": "array", "items": { "$ref": "#/definitions/io.k8s.api.core.v1.EnvVar" }, "x-kubernetes-patch-merge-key": "name", "x-kubernetes-patch-strategy": "merge" }, "envFrom": { "description": "List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.", "type": "array", "items": { "$ref": "#/definitions/io.k8s.api.core.v1.EnvFromSource" } }, "image": { "description": "Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.", "type": "string" }, "imagePullPolicy": { "description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images", "type": "string" }, "lifecycle": { "description": "Actions that the management system should take in response to container lifecycle events. Cannot be updated.", "$ref": "#/definitions/io.k8s.api.core.v1.Lifecycle" }, "livenessProbe": { "description": "Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "$ref": "#/definitions/io.k8s.api.core.v1.Probe" }, "mirrorVolumeMounts": { "description": "MirrorVolumeMounts will mount the same volumes specified in the main container to the container (including artifacts), at the same mountPaths. This enables dind daemon to partially see the same filesystem as the main container in order to use features such as docker volume binding", "type": "boolean" }, "name": { "description": "Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.", "type": "string" }, "ports": { "description": "List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated.", "type": "array", "items": { "$ref": "#/definitions/io.k8s.api.core.v1.ContainerPort" }, "x-kubernetes-list-map-keys": [ "containerPort", "protocol" ], "x-kubernetes-list-type": "map", "x-kubernetes-patch-merge-key": "containerPort", "x-kubernetes-patch-strategy": "merge" }, "readinessProbe": { "description": "Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "$ref": "#/definitions/io.k8s.api.core.v1.Probe" }, "resources": { "description": "Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", "$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements" }, "securityContext": { "description": "Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/", "$ref": "#/definitions/io.k8s.api.core.v1.SecurityContext" }, "stdin": { "description": "Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.", "type": "boolean" }, "stdinOnce": { "description": "Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false", "type": "boolean" }, "terminationMessagePath": { "description": "Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.", "type": "string" }, "terminationMessagePolicy": { "description": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.", "type": "string" }, "tty": { "description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.", "type": "boolean" }, "volumeDevices": { "description": "volumeDevices is the list of block devices to be used by the container. This is a beta feature.", "type": "array", "items": { "$ref": "#/definitions/io.k8s.api.core.v1.VolumeDevice" }, "x-kubernetes-patch-merge-key": "devicePath", "x-kubernetes-patch-strategy": "merge" }, "volumeMounts": { "description": "Pod volumes to mount into the container's filesystem. Cannot be updated.", "type": "array", "items": { "$ref": "#/definitions/io.k8s.api.core.v1.VolumeMount" }, "x-kubernetes-patch-merge-key": "mountPath", "x-kubernetes-patch-strategy": "merge" }, "workingDir": { "description": "Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.", "type": "string" } } }, "io.argoproj.workflow.v1alpha1.ValueFrom": { "description": "ValueFrom describes a location in which to obtain the value to a parameter", "type": "object", "properties": { "jqFilter": { "description": "JQFilter expression against the resource object in resource templates", "type": "string" }, "jsonPath": { "description": "JSONPath of a resource to retrieve an output parameter value from in resource templates", "type": "string" }, "parameter": { "description": "Parameter reference to a step or dag task in which to retrieve an output parameter value from (e.g. '{{steps.mystep.outputs.myparam}}')", "type": "string" }, "path": { "description": "Path in the container to retrieve an output parameter value from in container templates", "type": "string" } } }, "io.argoproj.workflow.v1alpha1.Workflow": { "description": "Workflow is the definition of a workflow resource", "type": "object", "required": [ "metadata", "spec", "status" ], "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds", "type": "string" }, "metadata": { "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "spec": { "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.WorkflowSpec" }, "status": { "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.WorkflowStatus" } } }, "io.argoproj.workflow.v1alpha1.WorkflowList": { "description": "WorkflowList is list of Workflow resources", "type": "object", "required": [ "metadata", "items" ], "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources", "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Workflow" } }, "kind": { "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds", "type": "string" }, "metadata": { "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta" } } }, "io.argoproj.workflow.v1alpha1.WorkflowSpec": { "description": "WorkflowSpec is the specification of a Workflow.", "type": "object", "required": [ "templates", "entrypoint" ], "properties": { "activeDeadlineSeconds": { "description": "Optional duration in seconds relative to the workflow start time which the workflow is allowed to run before the controller terminates the workflow. A value of zero is used to terminate a Running workflow", "type": "integer", "format": "int64" }, "affinity": { "description": "Affinity sets the scheduling constraints for all pods in the workflow. Can be overridden by an affinity specified in the template", "$ref": "#/definitions/io.k8s.api.core.v1.Affinity" }, "arguments": { "description": "Arguments contain the parameters and artifacts sent to the workflow entrypoint Parameters are referencable globally using the 'workflow' variable prefix. e.g. {{workflow.parameters.myparam}}", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Arguments" }, "artifactRepositoryRef": { "description": "ArtifactRepositoryRef specifies the configMap name and key containing the artifact repository config.", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.ArtifactRepositoryRef" }, "automountServiceAccountToken": { "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in pods. ServiceAccountName of ExecutorConfig must be specified if this value is false.", "type": "boolean" }, "dnsConfig": { "description": "PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.", "$ref": "#/definitions/io.k8s.api.core.v1.PodDNSConfig" }, "dnsPolicy": { "description": "Set DNS policy for the pod. Defaults to \"ClusterFirst\". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.", "type": "string" }, "entrypoint": { "description": "Entrypoint is a template reference to the starting point of the workflow", "type": "string" }, "executor": { "description": "Executor holds configurations of executor containers of the workflow.", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.ExecutorConfig" }, "hostAliases": { "description": "HostAliases is an optional list of hosts and IPs that will be injected into the pod spec", "type": "array", "items": { "$ref": "#/definitions/io.k8s.api.core.v1.HostAlias" }, "x-kubernetes-patch-merge-key": "ip", "x-kubernetes-patch-strategy": "merge" }, "hostNetwork": { "description": "Host networking requested for this workflow pod. Default to false.", "type": "boolean" }, "imagePullSecrets": { "description": "ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod", "type": "array", "items": { "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference" }, "x-kubernetes-patch-merge-key": "name", "x-kubernetes-patch-strategy": "merge" }, "nodeSelector": { "description": "NodeSelector is a selector which will result in all pods of the workflow to be scheduled on the selected node(s). This is able to be overridden by a nodeSelector specified in the template.", "type": "object", "additionalProperties": { "type": "string" } }, "onExit": { "description": "OnExit is a template reference which is invoked at the end of the workflow, irrespective of the success, failure, or error of the primary workflow.", "type": "string" }, "parallelism": { "description": "Parallelism limits the max total parallel pods that can execute at the same time in a workflow", "type": "integer", "format": "int64" }, "podGC": { "description": "PodGC describes the strategy to use when to deleting completed pods", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.PodGC" }, "podPriority": { "description": "Priority to apply to workflow pods.", "type": "integer", "format": "int32" }, "podPriorityClassName": { "description": "PriorityClassName to apply to workflow pods.", "type": "string" }, "podSpecPatch": { "description": "PodSpecPatch holds strategic merge patch to apply against the pod spec. Allows parameterization of container fields which are not strings (e.g. resource limits).", "type": "string" }, "priority": { "description": "Priority is used if controller is configured to process limited number of workflows in parallel. Workflows with higher priority are processed first.", "type": "integer", "format": "int32" }, "schedulerName": { "description": "Set scheduler name for all pods. Will be overridden if container/script template's scheduler name is set. Default scheduler will be used if neither specified.", "type": "string" }, "securityContext": { "description": "SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.", "$ref": "#/definitions/io.k8s.api.core.v1.PodSecurityContext" }, "serviceAccountName": { "description": "ServiceAccountName is the name of the ServiceAccount to run all pods of the workflow as.", "type": "string" }, "suspend": { "description": "Suspend will suspend the workflow and prevent execution of any future steps in the workflow", "type": "boolean" }, "templates": { "description": "Templates is a list of workflow templates used in a workflow", "type": "array", "items": { "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Template" }, "x-kubernetes-patch-merge-key": "name", "x-kubernetes-patch-strategy": "merge" }, "tolerations": { "description": "Tolerations to apply to workflow pods.", "type": "array", "items": { "$ref": "#/definitions/io.k8s.api.core.v1.Toleration" }, "x-kubernetes-patch-merge-key": "key", "x-kubernetes-patch-strategy": "merge" }, "ttlSecondsAfterFinished": { "description": "TTLSecondsAfterFinished limits the lifetime of a Workflow that has finished execution (Succeeded, Failed, Error). If this field is set, once the Workflow finishes, it will be deleted after ttlSecondsAfterFinished expires. If this field is unset, ttlSecondsAfterFinished will not expire. If this field is set to zero, ttlSecondsAfterFinished expires immediately after the Workflow finishes.", "type": "integer", "format": "int32" }, "volumeClaimTemplates": { "description": "VolumeClaimTemplates is a list of claims that containers are allowed to reference. The Workflow controller will create the claims at the beginning of the workflow and delete the claims upon completion of the workflow", "type": "array", "items": { "$ref": "#/definitions/io.k8s.api.core.v1.PersistentVolumeClaim" }, "x-kubernetes-patch-merge-key": "name", "x-kubernetes-patch-strategy": "merge" }, "volumes": { "description": "Volumes is a list of volumes that can be mounted by containers in a workflow.", "type": "array", "items": { "$ref": "#/definitions/io.k8s.api.core.v1.Volume" }, "x-kubernetes-patch-merge-key": "name", "x-kubernetes-patch-strategy": "merge" } } }, "io.argoproj.workflow.v1alpha1.WorkflowStatus": { "description": "WorkflowStatus contains overall status information about a workflow", "type": "object", "properties": { "compressedNodes": { "description": "Compressed and base64 decoded Nodes map", "type": "string" }, "finishedAt": { "description": "Time at which this workflow completed", "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time" }, "message": { "description": "A human readable message indicating details about why the workflow is in this condition.", "type": "string" }, "nodes": { "description": "Nodes is a mapping between a node ID and the node's status.", "type": "object", "additionalProperties": { "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.NodeStatus" } }, "outputs": { "description": "Outputs captures output values and artifact locations produced by the workflow via global outputs", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Outputs" }, "persistentVolumeClaims": { "description": "PersistentVolumeClaims tracks all PVCs that were created as part of the workflow. The contents of this list are drained at the end of the workflow.", "type": "array", "items": { "$ref": "#/definitions/io.k8s.api.core.v1.Volume" } }, "phase": { "description": "Phase a simple, high-level summary of where the workflow is in its lifecycle.", "type": "string" }, "startedAt": { "description": "Time at which this workflow started", "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time" }, "storedTemplates": { "description": "StoredTemplates is a mapping between a template ref and the node's status.", "type": "object", "additionalProperties": { "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Template" } } } }, "io.argoproj.workflow.v1alpha1.WorkflowStep": { "description": "WorkflowStep is a reference to a template to execute in a series of step", "type": "object", "properties": { "arguments": { "description": "Arguments hold arguments to the template", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Arguments" }, "continueOn": { "description": "ContinueOn makes argo to proceed with the following step even if this step fails. Errors and Failed states can be specified", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.ContinueOn" }, "name": { "description": "Name of the step", "type": "string" }, "template": { "description": "Template is the name of the template to execute as the step", "type": "string" }, "templateRef": { "description": "TemplateRef is the reference to the template resource to execute as the step.", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.TemplateRef" }, "when": { "description": "When is an expression in which the step should conditionally execute", "type": "string" }, "withItems": { "description": "WithItems expands a step into multiple parallel steps from the items in the list", "type": "array", "items": { "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Item" } }, "withParam": { "description": "WithParam expands a step into multiple parallel steps from the value in the parameter, which is expected to be a JSON list.", "type": "string" }, "withSequence": { "description": "WithSequence expands a step into a numeric sequence", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Sequence" } } }, "io.argoproj.workflow.v1alpha1.WorkflowTemplate": { "description": "WorkflowTemplate is the definition of a workflow template resource", "type": "object", "required": [ "spec" ], "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds", "type": "string" }, "metadata": { "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "spec": { "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.WorkflowTemplateSpec" } } }, "io.argoproj.workflow.v1alpha1.WorkflowTemplateList": { "description": "WorkflowTemplateList is list of WorkflowTemplate resources", "type": "object", "required": [ "metadata", "items" ], "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources", "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.WorkflowTemplate" } }, "kind": { "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds", "type": "string" }, "metadata": { "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta" } } }, "io.argoproj.workflow.v1alpha1.WorkflowTemplateSpec": { "description": "WorkflowTemplateSpec is a spec of WorkflowTemplate.", "type": "object", "required": [ "templates" ], "properties": { "arguments": { "description": "Arguments hold arguments to the template.", "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Arguments" }, "templates": { "description": "Templates is a list of workflow templates.", "type": "array", "items": { "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Template" } } } } } }