v1alpha1

package
Version: v3.3.8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 23, 2022 License: Apache-2.0 Imports: 38 Imported by: 225

Documentation

Overview

Package v1alpha1 is the v1alpha1 version of the API. +groupName=argoproj.io +k8s:deepcopy-gen=package,register +k8s:openapi-gen=true

Index

Constants

View Source
const (
	ProgressUndefined = Progress("")
	ProgressZero      = Progress("0/0") // zero value (not the same as "no progress)
	ProgressDefault   = Progress("0/1")
)
View Source
const (
	ExitLifecycleEvent = "exit"
)
View Source
const MainLogsArtifactName = "main-logs"

Variables

View Source
var (
	ErrInvalidLengthGenerated        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowGenerated          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupGenerated = fmt.Errorf("proto: unexpected end of group")
)
View Source
var (
	SchemeGroupVersion             = schema.GroupVersion{Group: workflow.Group, Version: "v1alpha1"}
	WorkflowSchemaGroupVersionKind = schema.GroupVersionKind{Group: workflow.Group, Version: "v1alpha1", Kind: workflow.WorkflowKind}
)

SchemeGroupVersion is group version used to register these objects

View Source
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source
var (
	WorkflowCreatedAfter = func(t time.Time) WorkflowPredicate {
		return func(wf Workflow) bool {
			return wf.ObjectMeta.CreationTimestamp.After(t)
		}
	}
	WorkflowFinishedBefore = func(t time.Time) WorkflowPredicate {
		return func(wf Workflow) bool {
			return !wf.Status.FinishedAt.IsZero() && wf.Status.FinishedAt.Time.Before(t)
		}
	}
	WorkflowRanBetween = func(startTime time.Time, endTime time.Time) WorkflowPredicate {
		return func(wf Workflow) bool {
			return wf.ObjectMeta.CreationTimestamp.After(startTime) && !wf.Status.FinishedAt.IsZero() && wf.Status.FinishedAt.Time.Before(endTime)
		}
	}
)
View Source
var (
	// DefaultArchivePattern is the default pattern when storing artifacts in an archive repository
	DefaultArchivePattern = "{{workflow.name}}/{{pod.name}}"
)

Functions

func FailedPodNode

func FailedPodNode(n NodeStatus) bool

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func MustMarshallJSON added in v3.1.0

func MustMarshallJSON(v interface{}) string

func MustUnmarshal added in v3.1.0

func MustUnmarshal(text, v interface{})

MustUnmarshal is a utility function to unmarshall either a file, byte array, or string of JSON or YAMl into a object. text - a byte array or string, if starts with "@" it assumed to be a file and read from disk, is starts with "{" assumed to be JSON, otherwise assumed to be YAML v - a pointer to an object

func NodeWithDisplayName

func NodeWithDisplayName(name string) func(n NodeStatus) bool

func ParseStringToDuration added in v3.3.0

func ParseStringToDuration(durationString string) (time.Duration, error)

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group-qualified GroupResource.

func ResourceQuantityDenominator

func ResourceQuantityDenominator(r apiv1.ResourceName) *resource.Quantity

func SucceededPodNode

func SucceededPodNode(n NodeStatus) bool

Types

type Amount

type Amount struct {
	Value json.Number `json:"-" protobuf:"bytes,1,opt,name=value,casttype=encoding/json.Number"`
}

Amount represent a numeric amount. +kubebuilder:validation:Type=number

func (*Amount) DeepCopy

func (in *Amount) DeepCopy() *Amount

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

func (*Amount) DeepCopyInto

func (in *Amount) DeepCopyInto(out *Amount)

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

func (*Amount) Descriptor

func (*Amount) Descriptor() ([]byte, []int)

func (*Amount) Float64

func (a *Amount) Float64() (float64, error)

func (*Amount) Marshal

func (m *Amount) Marshal() (dAtA []byte, err error)

func (Amount) MarshalJSON

func (a Amount) MarshalJSON() ([]byte, error)

func (*Amount) MarshalTo

func (m *Amount) MarshalTo(dAtA []byte) (int, error)

func (*Amount) MarshalToSizedBuffer

func (m *Amount) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (Amount) OpenAPISchemaFormat

func (a Amount) OpenAPISchemaFormat() string

func (Amount) OpenAPISchemaType

func (a Amount) OpenAPISchemaType() []string

func (*Amount) ProtoMessage

func (*Amount) ProtoMessage()

func (*Amount) Reset

func (m *Amount) Reset()

func (*Amount) Size

func (m *Amount) Size() (n int)

func (*Amount) String

func (this *Amount) String() string

func (*Amount) Unmarshal

func (m *Amount) Unmarshal(dAtA []byte) error

func (*Amount) UnmarshalJSON

func (a *Amount) UnmarshalJSON(data []byte) error

func (*Amount) XXX_DiscardUnknown

func (m *Amount) XXX_DiscardUnknown()

func (*Amount) XXX_Marshal

func (m *Amount) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Amount) XXX_Merge

func (m *Amount) XXX_Merge(src proto.Message)

func (*Amount) XXX_Size

func (m *Amount) XXX_Size() int

func (*Amount) XXX_Unmarshal

func (m *Amount) XXX_Unmarshal(b []byte) error

type AnyString

type AnyString string

* It's JSON type is just string. * It will unmarshall int64, int32, float64, float32, boolean, a plain string and represents it as string. * It will marshall back to string - marshalling is not symmetric.

func AnyStringPtr

func AnyStringPtr(val interface{}) *AnyString

func ParseAnyString

func ParseAnyString(val interface{}) AnyString

func (AnyString) MarshalJSON

func (i AnyString) MarshalJSON() ([]byte, error)

func (AnyString) String

func (i AnyString) String() string

func (*AnyString) UnmarshalJSON

func (i *AnyString) UnmarshalJSON(value []byte) error

type ArchiveStrategy

type ArchiveStrategy struct {
	Tar  *TarStrategy  `json:"tar,omitempty" protobuf:"bytes,1,opt,name=tar"`
	None *NoneStrategy `json:"none,omitempty" protobuf:"bytes,2,opt,name=none"`
	Zip  *ZipStrategy  `json:"zip,omitempty" protobuf:"bytes,3,opt,name=zip"`
}

ArchiveStrategy describes how to archive files/directory when saving artifacts

func (*ArchiveStrategy) DeepCopy

func (in *ArchiveStrategy) DeepCopy() *ArchiveStrategy

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

func (*ArchiveStrategy) DeepCopyInto

func (in *ArchiveStrategy) DeepCopyInto(out *ArchiveStrategy)

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

func (*ArchiveStrategy) Descriptor

func (*ArchiveStrategy) Descriptor() ([]byte, []int)

func (*ArchiveStrategy) Marshal

func (m *ArchiveStrategy) Marshal() (dAtA []byte, err error)

func (*ArchiveStrategy) MarshalTo

func (m *ArchiveStrategy) MarshalTo(dAtA []byte) (int, error)

func (*ArchiveStrategy) MarshalToSizedBuffer

func (m *ArchiveStrategy) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ArchiveStrategy) ProtoMessage

func (*ArchiveStrategy) ProtoMessage()

func (*ArchiveStrategy) Reset

func (m *ArchiveStrategy) Reset()

func (*ArchiveStrategy) Size

func (m *ArchiveStrategy) Size() (n int)

func (*ArchiveStrategy) String

func (this *ArchiveStrategy) String() string

func (*ArchiveStrategy) Unmarshal

func (m *ArchiveStrategy) Unmarshal(dAtA []byte) error

func (*ArchiveStrategy) XXX_DiscardUnknown

func (m *ArchiveStrategy) XXX_DiscardUnknown()

func (*ArchiveStrategy) XXX_Marshal

func (m *ArchiveStrategy) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ArchiveStrategy) XXX_Merge

func (m *ArchiveStrategy) XXX_Merge(src proto.Message)

func (*ArchiveStrategy) XXX_Size

func (m *ArchiveStrategy) XXX_Size() int

func (*ArchiveStrategy) XXX_Unmarshal

func (m *ArchiveStrategy) XXX_Unmarshal(b []byte) error

type Arguments

type Arguments struct {
	// Parameters is the list of parameters to pass to the template or workflow
	// +patchStrategy=merge
	// +patchMergeKey=name
	Parameters []Parameter `json:"parameters,omitempty" patchStrategy:"merge" patchMergeKey:"name" protobuf:"bytes,1,rep,name=parameters"`

	// Artifacts is the list of artifacts to pass to the template or workflow
	// +patchStrategy=merge
	// +patchMergeKey=name
	Artifacts Artifacts `json:"artifacts,omitempty" patchStrategy:"merge" patchMergeKey:"name" protobuf:"bytes,2,rep,name=artifacts"`
}

Arguments to a template

func (*Arguments) DeepCopy

func (in *Arguments) DeepCopy() *Arguments

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

func (*Arguments) DeepCopyInto

func (in *Arguments) DeepCopyInto(out *Arguments)

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

func (*Arguments) Descriptor

func (*Arguments) Descriptor() ([]byte, []int)

func (*Arguments) GetArtifactByName

func (args *Arguments) GetArtifactByName(name string) *Artifact

GetArtifactByName retrieves an artifact by its name

func (*Arguments) GetParameterByName

func (args *Arguments) GetParameterByName(name string) *Parameter

GetParameterByName retrieves a parameter by its name

func (Arguments) IsEmpty

func (a Arguments) IsEmpty() bool

func (*Arguments) Marshal

func (m *Arguments) Marshal() (dAtA []byte, err error)

func (*Arguments) MarshalTo

func (m *Arguments) MarshalTo(dAtA []byte) (int, error)

func (*Arguments) MarshalToSizedBuffer

func (m *Arguments) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Arguments) ProtoMessage

func (*Arguments) ProtoMessage()

func (*Arguments) Reset

func (m *Arguments) Reset()

func (*Arguments) Size

func (m *Arguments) Size() (n int)

func (*Arguments) String

func (this *Arguments) String() string

func (*Arguments) Unmarshal

func (m *Arguments) Unmarshal(dAtA []byte) error

func (*Arguments) XXX_DiscardUnknown

func (m *Arguments) XXX_DiscardUnknown()

func (*Arguments) XXX_Marshal

func (m *Arguments) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Arguments) XXX_Merge

func (m *Arguments) XXX_Merge(src proto.Message)

func (*Arguments) XXX_Size

func (m *Arguments) XXX_Size() int

func (*Arguments) XXX_Unmarshal

func (m *Arguments) XXX_Unmarshal(b []byte) error

type ArgumentsProvider

type ArgumentsProvider interface {
	GetParameterByName(name string) *Parameter
	GetArtifactByName(name string) *Artifact
}

type Artifact

type Artifact struct {
	// name of the artifact. must be unique within a template's inputs/outputs.
	Name string `json:"name" protobuf:"bytes,1,opt,name=name"`

	// Path is the container path to the artifact
	Path string `json:"path,omitempty" protobuf:"bytes,2,opt,name=path"`

	// mode bits to use on this file, must be a value between 0 and 0777
	// set when loading input artifacts.
	Mode *int32 `json:"mode,omitempty" protobuf:"varint,3,opt,name=mode"`

	// From allows an artifact to reference an artifact from a previous step
	From string `json:"from,omitempty" protobuf:"bytes,4,opt,name=from"`

	// ArtifactLocation contains the location of the artifact
	ArtifactLocation `json:",inline" protobuf:"bytes,5,opt,name=artifactLocation"`

	// GlobalName exports an output artifact to the global scope, making it available as
	// '{{workflow.outputs.artifacts.XXXX}} and in workflow.status.outputs.artifacts
	GlobalName string `json:"globalName,omitempty" protobuf:"bytes,6,opt,name=globalName"`

	// Archive controls how the artifact will be saved to the artifact repository.
	Archive *ArchiveStrategy `json:"archive,omitempty" protobuf:"bytes,7,opt,name=archive"`

	// Make Artifacts optional, if Artifacts doesn't generate or exist
	Optional bool `json:"optional,omitempty" protobuf:"varint,8,opt,name=optional"`

	// SubPath allows an artifact to be sourced from a subpath within the specified source
	SubPath string `json:"subPath,omitempty" protobuf:"bytes,9,opt,name=subPath"`

	// If mode is set, apply the permission recursively into the artifact if it is a folder
	RecurseMode bool `json:"recurseMode,omitempty" protobuf:"varint,10,opt,name=recurseMode"`

	// FromExpression, if defined, is evaluated to specify the value for the artifact
	FromExpression string `json:"fromExpression,omitempty" protobuf:"bytes,11,opt,name=fromExpression"`
}

Artifact indicates an artifact to place at a specified path

func (*Artifact) CleanPath added in <