v1

Documentation

Overview

Package v1 contains API Schema definitions for the batch v1 API group +kubebuilder:object:generate=true +groupName=batch.ankursoni.github.io

Index

• Variables
• type Workflow
  • func (in *Workflow) DeepCopy() *Workflow
  • func (in *Workflow) DeepCopyInto(out *Workflow)
  • func (in *Workflow) DeepCopyObject() runtime.Object
• type WorkflowList
  • func (in *WorkflowList) DeepCopy() *WorkflowList
  • func (in *WorkflowList) DeepCopyInto(out *WorkflowList)
  • func (in *WorkflowList) DeepCopyObject() runtime.Object
• type WorkflowSpec
  • func (in *WorkflowSpec) DeepCopy() *WorkflowSpec
  • func (in *WorkflowSpec) DeepCopyInto(out *WorkflowSpec)
• type WorkflowStatus
  • func (in *WorkflowStatus) DeepCopy() *WorkflowStatus
  • func (in *WorkflowStatus) DeepCopyInto(out *WorkflowStatus)
• type WorkflowYAMLSpec
  • func (in *WorkflowYAMLSpec) DeepCopy() *WorkflowYAMLSpec
  • func (in *WorkflowYAMLSpec) DeepCopyInto(out *WorkflowYAMLSpec)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "batch.ankursoni.github.io", Version: "v1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Types

type Workflow

type Workflow struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   WorkflowSpec   `json:"spec"`
	Status WorkflowStatus `json:"status,omitempty"`
}

Workflow is the Schema for the workflows API

func (*Workflow) DeepCopy

func (in *Workflow) DeepCopy() *Workflow

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Workflow.

func (*Workflow) DeepCopyInto

func (in *Workflow) DeepCopyInto(out *Workflow)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Workflow) DeepCopyObject

func (in *Workflow) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type WorkflowList

type WorkflowList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Workflow `json:"items"`
}

WorkflowList contains a list of Workflow

func (*WorkflowList) DeepCopy

func (in *WorkflowList) DeepCopy() *WorkflowList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkflowList.

func (*WorkflowList) DeepCopyInto

func (in *WorkflowList) DeepCopyInto(out *WorkflowList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*WorkflowList) DeepCopyObject

func (in *WorkflowList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type WorkflowSpec

type WorkflowSpec struct {

	// Specifies the workflow yaml file that will orchestrate execution
	WorkflowYAML WorkflowYAMLSpec `json:"workflowYAML"`

	// Specifies the job that will be created when executing a Workflow.
	JobTemplate batchv1beta1.JobTemplateSpec `json:"jobTemplate"`
}

WorkflowSpec defines the desired state of Workflow

func (*WorkflowSpec) DeepCopy

func (in *WorkflowSpec) DeepCopy() *WorkflowSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkflowSpec.

func (*WorkflowSpec) DeepCopyInto

func (in *WorkflowSpec) DeepCopyInto(out *WorkflowSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type WorkflowStatus

type WorkflowStatus struct {

	// A pointer to currently active jobs and completed jobs.
	// +optional
	ActiveJobs     []corev1.ObjectReference `json:"activeJobs,omitempty"`
	SuccessfulJobs []corev1.ObjectReference `json:"successfulJobs,omitempty"`
	FailedJobs     []corev1.ObjectReference `json:"failedJobs,omitempty"`
}

WorkflowStatus defines the observed state of Workflow

func (*WorkflowStatus) DeepCopy

func (in *WorkflowStatus) DeepCopy() *WorkflowStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkflowStatus.

func (*WorkflowStatus) DeepCopyInto

func (in *WorkflowStatus) DeepCopyInto(out *WorkflowStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type WorkflowYAMLSpec

type WorkflowYAMLSpec struct {
	// Name of the yaml file without .yaml extension
	Name string `json:"name"`

	// Content of the yaml file
	YAML string `json:"yaml"`
}

WorkflowYAMLSpec defines the workflow orchestration

func (*WorkflowYAMLSpec) DeepCopy

func (in *WorkflowYAMLSpec) DeepCopy() *WorkflowYAMLSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkflowYAMLSpec.

func (*WorkflowYAMLSpec) DeepCopyInto

func (in *WorkflowYAMLSpec) DeepCopyInto(out *WorkflowYAMLSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.