# Functions
No description provided by the author
No description provided by the author
Kind takes an unqualified kind and returns back a Group qualified GroupKind.
No description provided by the author
MustUnmarshal is a utility function to unmarshall either a file, byte array, or string of JSON or YAMl into a object.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Resource takes an unqualified resource and returns a Group-qualified GroupResource.
No description provided by the author
No description provided by the author
# Constants
No description provided by the author
No description provided by the author
ConditionTypeCompleted is a signifies the workflow has completed.
ConditionTypeMetricsError is an error during metric emission.
ConditionTypePodRunning any workflow pods are currently running.
ConditionTypeSpecWarning is an error on the current application spec.
ConditionTypeSpecWarning is a warning on the current application spec.
ConditionTypeSubmissionError signifies that there was an error when submitting the CronWorkflow as a Workflow.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Node had an error other than a non 0 exit code.
Node or child of node exited with non-0 code.
Node was omitted because its `depends` condition was not met (only relevant in DAGs).
Node is waiting to run.
Node is running.
Node was skipped.
Node finished with no errors.
Node types.
Node types.
Node types.
Node types.
Node types.
Node types.
Node types.
Node types.
Node types.
Node types.
No description provided by the author
PodGCStrategy.
PodGCStrategy.
PodGCStrategy.
PodGCStrategy.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Possible template types.
Possible template types.
Possible template types.
Possible template types.
Possible template types.
Possible template types.
Possible template types.
Possible template types.
Possible template types.
Possible template types.
No description provided by the author
No description provided by the author
No description provided by the author
it maybe that the the workflow was terminated.
pending some set-up - rarely used.
any node has started; pods might not be running yet, the workflow maybe suspended too.
No description provided by the author
No description provided by the author
# Variables
No description provided by the author
DefaultArchivePattern is the default pattern when storing artifacts in an archive repository.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SchemeGroupVersion is group version used to register these objects.
No description provided by the author
No description provided by the author
No description provided by the author
SchemeGroupVersion is group version used to register these objects.
# Structs
Amount represent a numeric amount.
ArchiveStrategy describes how to archive files/directory when saving artifacts.
Arguments to a template.
Artifact indicates an artifact to place at a specified path.
ArtifactLocation describes a location for a single or multiple artifacts.
ArtifactoryArtifact is the location of an artifactory artifact.
ArtifactoryArtifactRepository defines the controller configuration for an artifactory artifact repository.
ArtifactoryAuth describes the secret selectors required for authenticating to artifactory.
ArtifactPaths expands a step from a collection of artifacts.
ArtifactRepository represents an artifact repository in which a controller will store its artifacts.
+protobuf.options.(gogoproto.goproto_stringer)=false.
+protobuf.options.(gogoproto.goproto_stringer)=false.
Backoff is a backoff strategy to use within retryStrategy.
Cache is the configuration for the type of cache to be used.
ClusterWorkflowTemplate is the definition of a workflow template resource in cluster scope +genclient +genclient:noStatus +genclient:nonNamespaced +kubebuilder:resource:scope=Cluster,shortName=clusterwftmpl;cwft +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object.
ClusterWorkflowTemplateList is list of ClusterWorkflowTemplate resources +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object.
No description provided by the author
No description provided by the author
No description provided by the author
ContinueOn defines if a workflow should continue even if a task or step fails/errors.
Counter is a Counter prometheus metric.
CreateS3BucketOptions options used to determine automatic automatic bucket-creation process.
CronWorkflow is the definition of a scheduled workflow resource +genclient +genclient:noStatus +kubebuilder:resource:shortName=cwf;cronwf +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object.
CronWorkflowList is list of CronWorkflow resources +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object.
CronWorkflowSpec is the specification of a CronWorkflow.
CronWorkflowStatus is the status of a CronWorkflow.
DAGTask represents a node in the graph during DAG execution.
DAGTemplate is a template subtype for directed acyclic graph templates.
Data is a data template.
DataSource sources external data into a data template.
No description provided by the author
ExecutorConfig holds configurations of an executor container.
Gauge is a Gauge prometheus metric.
GCSArtifact is the location of a GCS artifact.
GCSArtifactRepository defines the controller configuration for a GCS artifact repository.
GCSBucket contains the access information for interfacring with a GCS bucket.
GitArtifact is the location of an git artifact.
HDFSArtifact is the location of an HDFS artifact.
HDFSArtifactRepository defines the controller configuration for an HDFS artifact repository.
HDFSConfig is configurations for HDFS.
HDFSKrbConfig is auth configurations for Kerberos.
Header indicate a key-value request header to be used when fetching artifacts over HTTP.
Histogram is a Histogram prometheus metric.
No description provided by the author
HTTPArtifact allows an file served on HTTP to be placed as an input artifact in a container.
No description provided by the author
No description provided by the author
Inputs are the mechanism for passing parameters, artifacts, volumes from one template to another.
Item expands a single workflow step into multiple parallel steps The value of Item can be a map, string, bool, or number
+protobuf.options.(gogoproto.goproto_stringer)=false +kubebuilder:validation:Type=object.
LabelKeys is list of keys.
Labels is list of workflow labels.
No description provided by the author
A link to another app.
MemoizationStatus is the status of this memoized node.
Memoization enables caching for the Outputs of the template.
Pod metdata.
MetricLabel is a single label for a prometheus metric.
Metrics are a list of metrics emitted from a Workflow/Template.
Mutex holds Mutex configuration.
MutexHolding describes the mutex and the object which is holding it.
MutexStatus contains which objects hold mutex locks, and which objects this workflow is waiting on to release locks.
No description provided by the author
NodeStatus contains status information about an individual node in the workflow.
NodeSynchronizationStatus stores the status of a node.
NoneStrategy indicates to skip tar process and upload the files or directory tree as independent files.
OSSArtifact is the location of an Alibaba Cloud OSS artifact.
OSSArtifactRepository defines the controller configuration for an OSS artifact repository.
OSSBucket contains the access information required for interfacing with an Alibaba Cloud OSS bucket.
OSSLifecycleRule specifies how to manage bucket's lifecycle.
Outputs hold parameters, artifacts, and results from a step.
+kubebuilder:validation:Type=array.
Parameter indicate a passed string parameter to a service template with an optional default value.
PodGC describes how to delete completed pods as they complete.
Prometheus is a prometheus metric to be emitted.
RawArtifact allows raw string content to be placed as an artifact in a container.
ResourceTemplate is a template subtype to manipulate kubernetes resources.
RetryAffinity prevents running steps on the same host.
RetryNodeAntiAffinity is a placeholder for future expansion, only empty nodeAntiAffinity is allowed.
RetryStrategy provides controls on how to retry a workflow step.
S3Artifact is the location of an S3 artifact.
S3ArtifactRepository defines the controller configuration for an S3 artifact repository.
S3Bucket contains the access information required for interfacing with an S3 bucket.
S3EncryptionOptions used to determine encryption options during s3 operations.
ScriptTemplate is a template subtype to enable scripting through code steps.
No description provided by the author
SemaphoreRef is a reference of Semaphore.
No description provided by the author
Sequence expands a workflow step into numeric range.
No description provided by the author
SubmitOpts are workflow submission options.
SuppliedValueFrom is a placeholder for a value to be filled in directly, either through the CLI, API, etc.
SuspendTemplate is a template subtype to suspend a workflow at a predetermined point in time.
Synchronization holds synchronization lock configuration.
SynchronizationStatus stores the status of semaphore and mutex.
TarStrategy will tar and gzip the file or directory when saving.
Template is a reusable and composable unit of execution in a workflow.
TemplateRef is a reference of template resource.
No description provided by the author
TTLStrategy is the strategy for the time to live depending on if the workflow succeeded or failed.
UserContainer is a container specified by a user.
ValueFrom describes a location in which to obtain the value to a parameter.
No description provided by the author
VolumeClaimGC describes how to delete volumes from completed Workflows.
Workflow is the definition of a workflow resource +genclient +genclient:noStatus +kubebuilder:resource:shortName=wf +kubebuilder:printcolumn:name="Status",type="string",JSONPath=".status.phase",description="Status of the workflow" +kubebuilder:printcolumn:name="Age",type="date",format="date-time",JSONPath=".status.startedAt",description="When the workflow was started" +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object.
WorkflowEventBinding is the definition of an event resource +genclient +genclient:noStatus +kubebuilder:resource:shortName=wfeb +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object.
WorkflowEventBindingList is list of event resources +kubebuilder:resource:shortName=wfebs +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object.
No description provided by the author
WorkflowList is list of Workflow resources +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object.
WorkflowSpec is the specification of a Workflow.
WorkflowStatus contains overall status information about a workflow.
WorkflowStep is a reference to a template to execute in a series of step.
+genclient +kubebuilder:resource:shortName=wfts +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object.
+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object.
No description provided by the author
No description provided by the author
WorkflowTemplate is the definition of a workflow template resource +genclient +genclient:noStatus +kubebuilder:resource:shortName=wftmpl +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object.
WorkflowTemplateList is list of WorkflowTemplate resources +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object.
WorkflowTemplateRef is a reference to a WorkflowTemplate resource.
WorkflowTemplateSpec is a spec of WorkflowTemplate.
ZipStrategy will unzip zipped input artifacts.
# Interfaces
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TemplateHolder is an object that holds templates; e.g.
TemplateReferenceHolder is an object that holds a reference to other templates; e.g.
WorkflowSpecHolder is an object that holds a WorkflowSpec; e.g., WorkflowTemplate, and ClusterWorkflowTemplate.
# Type aliases
* It's JSON type is just string.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
EstimatedDuration is in seconds.
No description provided by the author
No description provided by the author
No description provided by the author
NodePhase is a label for the condition of a node at the current time.
No description provided by the author
NodeType is the type of a node.
PodGCStrategy is the strategy when to delete completed pods for GC.
Progress in N/M format.
The amount of requested resource * the duration that request was used.
No description provided by the author
This contains each duration by request requested.
No description provided by the author
No description provided by the author
No description provided by the author
TemplateType is the type of a template.
No description provided by the author
Type represents the stored type of Item.
VolumeClaimGCStrategy is the strategy to use when deleting volumes from completed workflows.
the workflow's phase.
No description provided by the author
Workflows is a sort interface which sorts running jobs earlier before considering FinishedAt.
No description provided by the author