v1

Documentation

Overview

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

Index

• Variables
• type ConcurrencyPolicy
• type CronJob
  • func (in *CronJob) DeepCopy() *CronJob
  • func (in *CronJob) DeepCopyInto(out *CronJob)
  • func (in *CronJob) DeepCopyObject() runtime.Object
  • func (r *CronJob) Default()
  • func (r *CronJob) SetupWebhookWithManager(mgr ctrl.Manager) error
  • func (r *CronJob) ValidateCreate() error
  • func (r *CronJob) ValidateDelete() error
  • func (r *CronJob) ValidateUpdate(old runtime.Object) error
• type CronJobList
  • func (in *CronJobList) DeepCopy() *CronJobList
  • func (in *CronJobList) DeepCopyInto(out *CronJobList)
  • func (in *CronJobList) DeepCopyObject() runtime.Object
• type CronJobSpec
  • func (in *CronJobSpec) DeepCopy() *CronJobSpec
  • func (in *CronJobSpec) DeepCopyInto(out *CronJobSpec)
• type CronJobStatus
  • func (in *CronJobStatus) DeepCopy() *CronJobStatus
  • func (in *CronJobStatus) DeepCopyInto(out *CronJobStatus)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "batch.kubebuilder.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 ConcurrencyPolicy

type ConcurrencyPolicy string

If none of the following concurrent polices is specified, the default one is AllowConcurrent. +kubebuilder:validation:Enum=Allow;Forbid;Replace

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 CronJob

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

	Spec   CronJobSpec   `json:"spec,omitempty"`
	Status CronJobStatus `json:"status,omitempty"`
}

CronJob is the Schema for the cronjobs API

func (*CronJob) DeepCopy

func (in *CronJob) DeepCopy() *CronJob

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

func (*CronJob) DeepCopyInto

func (in *CronJob) DeepCopyInto(out *CronJob)

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

func (*CronJob) DeepCopyObject

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

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

func (*CronJob) Default

func (r *CronJob) Default()

Default implements webhook.Defaulter so a webhook will be registered for the type

func (*CronJob) SetupWebhookWithManager

func (r *CronJob) SetupWebhookWithManager(mgr ctrl.Manager) error

func (*CronJob) ValidateCreate

func (r *CronJob) ValidateCreate() error

ValidateCreate implements webhook.Validator so a webhook will be registered for the type

func (*CronJob) ValidateDelete

func (r *CronJob) ValidateDelete() error

ValidateDelete implements webhook.Validator so a webhook will be registered for the type

func (*CronJob) ValidateUpdate

func (r *CronJob) ValidateUpdate(old runtime.Object) error

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type

type CronJobList

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

CronJobList contains a list of CronJob

func (*CronJobList) DeepCopy

func (in *CronJobList) DeepCopy() *CronJobList

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

func (*CronJobList) DeepCopyInto

func (in *CronJobList) DeepCopyInto(out *CronJobList)

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

func (*CronJobList) DeepCopyObject

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

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

type CronJobSpec

type CronJobSpec struct {

	// The schedule in Cron format - https://en.wikipedia.org/wiki/Cron
	// +kubebuilder:validation:MinLength=0
	Schedule string `json:"schedule"`

	// 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.
	// +kubebuilder:validation:Minimum=0
	// +optional
	StartingDeadlineSeconds *int64 `json:"startingDeadlineSeconds,omitempty"`

	// Specifies how to treat concurrent executions of a Job.
	// Valid values are:
	// - "Allow" (default), "Forbid", "Replace"
	// +optional
	ConcurrencyPolicy ConcurrencyPolicy `json:"concurrencyPolicy,omitempty"`

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

	// Specifies the job that will be created when executing a CronJob.
	JobTemplate batchv1beta1.JobTemplateSpec

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

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

CronJobSpec defines the desired state of CronJob

func (*CronJobSpec) DeepCopy

func (in *CronJobSpec) DeepCopy() *CronJobSpec

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

func (*CronJobSpec) DeepCopyInto

func (in *CronJobSpec) DeepCopyInto(out *CronJobSpec)

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

type CronJobStatus

type CronJobStatus struct {

	// A list of pointers to currently running jobs.
	// +optional
	Active []v1.ObjectReference `json:"active,omitempty"`

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

CronJobStatus defines the observed state of CronJob

func (*CronJobStatus) DeepCopy

func (in *CronJobStatus) DeepCopy() *CronJobStatus

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

func (*CronJobStatus) DeepCopyInto

func (in *CronJobStatus) DeepCopyInto(out *CronJobStatus)

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