v1

Documentation

Index

• Constants
• type ConcurrencyPolicy
• type Phase
• type ScheduledSpec
  • func (in *ScheduledSpec) DeepCopy() *ScheduledSpec
  • func (in *ScheduledSpec) DeepCopyInto(out *ScheduledSpec)
• type ScheduledStatus
  • func (in *ScheduledStatus) DeepCopy() *ScheduledStatus
  • func (in *ScheduledStatus) DeepCopyInto(out *ScheduledStatus)

Constants

const ScheduledAnnotation = "skpr.io/scheduled-at"

ScheduledAnnotation is used to detect the time when an object was scheduled.

Types

type ConcurrencyPolicy

type ConcurrencyPolicy string

ConcurrencyPolicy describes how the scheduled task will be handled. Only one of the following concurrent policies may be specified. If none of the following policies is specified, the default one is ForbidConcurrent.

const (
	// AllowConcurrent allows CronJobs to run concurrently.
	AllowConcurrent ConcurrencyPolicy = "Allow"

	// ForbidConcurrent forbids concurrent runs, skipping next run if previous
	// hasn't finished yet.
	ForbidConcurrent ConcurrencyPolicy = "Forbid"

	// ReplaceConcurrent cancels currently running job and replaces it with a new one.
	ReplaceConcurrent ConcurrencyPolicy = "Replace"
)

type Phase

type Phase string

Phase which indicates the status of an operation.

const (
	// PhaseFailed to be assigned when an operation fails.
	PhaseFailed Phase = "Failed"
	// PhaseReady to be assigned when an operation is ready to be progressed.
	PhaseReady Phase = "Ready"
	// PhaseInProgress to be assigned when an operation is in progress.
	PhaseInProgress Phase = "InProgress"
	// PhaseCompleted to be assigned when an operation has been completed.
	PhaseCompleted Phase = "Completed"
	// PhaseUnknown to be assigned when the above phases cannot be determined.
	PhaseUnknown Phase = "Unknown"
)

type ScheduledSpec

type ScheduledSpec struct {
	// The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
	CronTab string `json:"cronTab"`

	// Optional deadline in seconds for starting the job if it misses scheduled
	// time for any reason.  Missed jobs executions will be counted as failed ones.
	StartingDeadlineSeconds *int64 `json:"startingDeadlineSeconds,omitempty"`

	// Specifies how to treat concurrent executions of a Job.
	// Valid values are:
	// - "Allow" (default): allows CronJobs to run concurrently;
	// - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet;
	// - "Replace": cancels currently running job and replaces it with a new one
	ConcurrencyPolicy ConcurrencyPolicy `json:"concurrencyPolicy,omitempty"`

	// This flag tells the controller to suspend subsequent executions, it does
	// not apply to already started executions.  Defaults to false.
	Suspend *bool `json:"suspend,omitempty"`

	// The number of successful finished jobs to retain.
	// This is a pointer to distinguish between explicit zero and not specified.
	SuccessfulHistoryLimit *int32 `json:"successfulJobsHistoryLimit,omitempty"`

	// The number of failed finished jobs to retain.
	// This is a pointer to distinguish between explicit zero and not specified.
	FailedHistoryLimit *int32 `json:"failedJobsHistoryLimit,omitempty"`
}

ScheduledSpec defines the desired state of a scheduled task.

func (*ScheduledSpec) DeepCopy

func (in *ScheduledSpec) DeepCopy() *ScheduledSpec

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

func (*ScheduledSpec) DeepCopyInto

func (in *ScheduledSpec) DeepCopyInto(out *ScheduledSpec)

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

type ScheduledStatus

type ScheduledStatus struct {
	// A list of pointers to currently running jobs.
	// +optional
	Active []corev1.ObjectReference `json:"active,omitempty"`

	// Information when was the last time the job was successfully scheduled.
	// +optional
	LastScheduleTime *metav1.Time `json:"lastScheduleTime,omitempty"`
}

ScheduledStatus defines the observed state of a scheduled object.

func (*ScheduledStatus) DeepCopy

func (in *ScheduledStatus) DeepCopy() *ScheduledStatus

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

func (*ScheduledStatus) DeepCopyInto

func (in *ScheduledStatus) DeepCopyInto(out *ScheduledStatus)

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