package
0.6.0
Repository: https://github.com/kubevela/workflow.git
Documentation: pkg.go.dev

# Constants

Package type metadata.
MessageFailed is the message for failed.
MessageFailedExecute is the message for failed to execute.
MessageFailedGenerate is the message for failed to generate.
MessageSuccessfully is the message for successfully.
MessageTerminated is the message for terminated.
ReasonExecute is the reason for executing a workflow.
ReasonGenerate is the reason for generating a workflow.
Package type metadata.
WorkflowModeDAG describes the DAG mode of workflow.
WorkflowModeStep describes the step by step mode of workflow.
WorkflowRunConditionType is a valid condition type for a WorkflowRun.
WorkflowStateExecuting means the workflow run is executing.
WorkflowStateFailed means the workflow run is failed.
WorkflowStateInitializing means the workflow run is initializing.
WorkflowStateSkipped means the workflow run is skipped.
WorkflowStateSucceeded means the workflow run is succeeded.
WorkflowStateSuspending means the workflow run is suspending.
WorkflowStateTerminated means the workflow run is terminated.
WorkflowStepPhaseFailed will report error in `message`.
WorkflowStepPhasePending will make the controller wait for the step to run.
WorkflowStepPhaseRunning will make the controller continue the workflow.
WorkflowStepPhaseSkipped will make the controller skip the step.
WorkflowStepPhaseSucceeded will make the controller run the next step.
WorkflowStepPhaseSuspending will make the controller suspend the workflow.

# Variables

AddToScheme is a global function that registers this API group & version to a scheme.
SchemeBuilder is used to add go types to the GroupVersionKind scheme.
SchemeGroupVersion is group version used to register these objects.
Workflow meta.
Workflow meta.
WorkflowRun meta.
WorkflowRun meta.

# Structs

InputItem defines an input variable of WorkflowStep.
OutputItem defines an output variable of WorkflowStep.
StepStatus record the base status of workflow step, which could be workflow step or subStep.
Workflow is the Schema for the workflow API +kubebuilder:storageversion +kubebuilder:resource:categories={oam} +genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object.
WorkflowExecuteMode defines the mode of workflow execution.
WorkflowList contains a list of Workflow +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object.
WorkflowRun is the Schema for the workflowRun API +kubebuilder:storageversion +kubebuilder:resource:categories={oam},shortName={wr} +kubebuilder:subresource:status +kubebuilder:printcolumn:name="PHASE",type=string,JSONPath=`.status.status` +kubebuilder:printcolumn:name="AGE",type=date,JSONPath=".metadata.creationTimestamp" +genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object.
WorkflowRunList contains a list of WorkflowRun +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object.
WorkflowRunSpec is the spec for the WorkflowRun.
WorkflowRunStatus record the status of workflow run.
WorkflowSpec defines workflow steps and other attributes.
WorkflowStep defines how to execute a workflow step.
WorkflowStepBase defines the workflow step base.
WorkflowStepMeta contains the meta data of a workflow step.
WorkflowStepStatus record the status of a workflow step, include step status and subStep status.

# Type aliases

StepInputs defines variable input of WorkflowStep.
StepOutputs defines output variable of WorkflowStep.
WorkflowMode describes the mode of workflow.
WorkflowRunPhase is a label for the condition of a WorkflowRun at the current time.
WorkflowStepPhase describes the phase of a workflow step.