Documentation
¶
Overview ¶
Package v1 contains API Schema definitions for the batch v1 API group +kubebuilder:object:generate=true +groupName=batch.github.com
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
- type CronJobSpec
- type CronJobStatus
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "batch.github.com", 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 )
Then, we have the commonly useful variables that help us set up our Scheme. Since we need to use all the types in this package in our controller, it's helpful (and the convention) to have a convenient method to add all the types to some other `Scheme`. SchemeBuilder makes this easy for us.
Functions ¶
This section is empty.
Types ¶
type ConcurrencyPolicy ¶
type ConcurrencyPolicy string
ConcurrencyPolicy describes how the job 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 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 ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CronJob.
func (*CronJob) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CronJob) DeepCopyObject ¶
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 (*CronJob) ValidateCreate ¶
ValidateCreate implements webhook.Validator so a webhook will be registered for the type
func (*CronJob) ValidateDelete ¶
ValidateDelete 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, see https://en.wikipedia.org/wiki/Cron.
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.
// +optional
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
// +optional
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.
// +optional
Suspend *bool `json:"suspend,omitempty"`
// Specifies the job that will be created when executing a CronJob.
JobTemplate batchv1beta1.JobTemplateSpec `json:"jobTemplate"`
// 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 []corev1.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.
Source Files