v1

package
v0.24.11 Latest Latest
Warning

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

 Go to latest Published: Feb 28, 2023 License: Apache-2.0 Imports: 12 Imported by: 6,473

Documentation

Index

Constants

View Source 
const (
	JobCompletionIndexAnnotation = "batch.kubernetes.io/job-completion-index"

	// JobTrackingFinalizer is a finalizer for Job's pods. It prevents them from
	// being deleted before being accounted in the Job status.
	// The apiserver and job controller use this string as a Job annotation, to
	// mark Jobs that are being tracked using pod finalizers. Two releases after
	// the JobTrackingWithFinalizers graduates to GA, JobTrackingFinalizer will
	// no longer be used as a Job annotation.
	JobTrackingFinalizer = "batch.kubernetes.io/job-tracking"
)
View Source 
const GroupName = "batch"

GroupName is the group name use in this package

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 (
	// TODO: move SchemeBuilder with zz_generated.deepcopy.go to k8s.io/api.
	// localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)

	AddToScheme = localSchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type CompletionMode added in v0.21.0 

type CompletionMode string

CompletionMode specifies how Pod completions of a Job are tracked. +enum 

const (
	// NonIndexedCompletion is a Job completion mode. In this mode, the Job is
	// considered complete when there have been .spec.completions
	// successfully completed Pods. Pod completions are homologous to each other.
	NonIndexedCompletion CompletionMode = "NonIndexed"

	// IndexedCompletion is a Job completion mode. In this mode, the Pods of a
	// Job get an associated completion index from 0 to (.spec.completions - 1).
	// The Job is  considered complete when a Pod completes for each completion
	// index.
	IndexedCompletion CompletionMode = "Indexed"
)

type ConcurrencyPolicy added in v0.21.0 

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. +enum 

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 added in v0.21.0 

type CronJob struct {
	metav1.TypeMeta `json:",inline"`
	// Standard object's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// Specification of the desired behavior of a cron job, including the schedule.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
	// +optional
	Spec CronJobSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`

	// Current status of a cron job.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
	// +optional
	Status CronJobStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}

CronJob represents the configuration of a single cron job.

func (*CronJob) DeepCopy added in v0.21.0 

func (in *CronJob) DeepCopy() *CronJob

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

func (*CronJob) DeepCopyInto added in v0.21.0 

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 added in v0.21.0 

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

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

func (*CronJob) Descriptor added in v0.21.0 

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

func (*CronJob) Marshal added in v0.21.0 

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

func (*CronJob) MarshalTo added in v0.21.0 

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

func (*CronJob) MarshalToSizedBuffer added in v0.21.0 

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

func (*CronJob) ProtoMessage added in v0.21.0 

func (*CronJob) ProtoMessage()

func (*CronJob) Reset added in v0.21.0 

func (m *CronJob) Reset()

func (*CronJob) Size added in v0.21.0 

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

func (*CronJob) String added in v0.21.0 

func (this *CronJob) String() string

func (CronJob) SwaggerDoc added in v0.21.0 

func (CronJob) SwaggerDoc() map[string]string

func (*CronJob) Unmarshal added in v0.21.0 

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

func (*CronJob) XXX_DiscardUnknown added in v0.21.0 

func (m *CronJob) XXX_DiscardUnknown()

func (*CronJob) XXX_Marshal added in v0.21.0 

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

func (*CronJob) XXX_Merge added in v0.21.0 

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

func (*CronJob) XXX_Size added in v0.21.0 

func (m *CronJob) XXX_Size() int

func (*CronJob) XXX_Unmarshal added in v0.21.0 

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

type CronJobList added in v0.21.0 

type CronJobList struct {
	metav1.TypeMeta `json:",inline"`

	// Standard list metadata.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	// +optional
	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// items is the list of CronJobs.
	Items []CronJob `json:"items" protobuf:"bytes,2,rep,name=items"`
}

CronJobList is a collection of cron jobs.

func (*CronJobList) DeepCopy added in v0.21.0 

func (in *CronJobList) DeepCopy() *CronJobList

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

func (*CronJobList) DeepCopyInto added in v0.21.0 

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 added in v0.21.0 

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

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

func (*CronJobList) Descriptor added in v0.21.0 

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

func (*CronJobList) Marshal added in v0.21.0 

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

func (*CronJobList) MarshalTo added in v0.21.0 

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

func (*CronJobList) MarshalToSizedBuffer added in v0.21.0 

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

func (*CronJobList) ProtoMessage added in v0.21.0 

func (*CronJobList) ProtoMessage()

func (*CronJobList) Reset added in v0.21.0 

func (m *CronJobList) Reset()

func (*CronJobList) Size added in v0.21.0 

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

func (*CronJobList) String added in v0.21.0 

func (this *CronJobList) String() string

func (CronJobList) SwaggerDoc added in v0.21.0 

func (CronJobList) SwaggerDoc() map[string]string

func (*CronJobList) Unmarshal added in v0.21.0 

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

func (*CronJobList) XXX_DiscardUnknown added in v0.21.0 

func (m *CronJobList) XXX_DiscardUnknown()

func (*CronJobList) XXX_Marshal added in v0.21.0 

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

func (*CronJobList) XXX_Merge added in v0.21.0 

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

func (*CronJobList) XXX_Size added in v0.21.0 

func (m *CronJobList) XXX_Size() int

func (*CronJobList) XXX_Unmarshal added in v0.21.0 

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

type CronJobSpec added in v0.21.0 

type CronJobSpec struct {

	// The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
	Schedule string `json:"schedule" protobuf:"bytes,1,opt,name=schedule"`

	// The time zone for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
	// If not specified, this will rely on the time zone of the kube-controller-manager process.
	// ALPHA: This field is in alpha and must be enabled via the `CronJobTimeZone` feature gate.
	// +optional
	TimeZone *string `json:"timeZone,omitempty" protobuf:"bytes,8,opt,name=timeZone"`

	// 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" protobuf:"varint,2,opt,name=startingDeadlineSeconds"`

	// 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" protobuf:"bytes,3,opt,name=concurrencyPolicy,casttype=ConcurrencyPolicy"`

	// 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" protobuf:"varint,4,opt,name=suspend"`

	// Specifies the job that will be created when executing a CronJob.
	JobTemplate JobTemplateSpec `json:"jobTemplate" protobuf:"bytes,5,opt,name=jobTemplate"`

	// The number of successful finished jobs to retain. Value must be non-negative integer.
	// Defaults to 3.
	// +optional
	SuccessfulJobsHistoryLimit *int32 `json:"successfulJobsHistoryLimit,omitempty" protobuf:"varint,6,opt,name=successfulJobsHistoryLimit"`

	// The number of failed finished jobs to retain. Value must be non-negative integer.
	// Defaults to 1.
	// +optional
	FailedJobsHistoryLimit *int32 `json:"failedJobsHistoryLimit,omitempty" protobuf:"varint,7,opt,name=failedJobsHistoryLimit"`
}

CronJobSpec describes how the job execution will look like and when it will actually run.

func (*CronJobSpec) DeepCopy added in v0.21.0 

func (in *CronJobSpec) DeepCopy() *CronJobSpec

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

func (*CronJobSpec) DeepCopyInto added in v0.21.0 

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

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

func (*CronJobSpec) Descriptor added in v0.21.0 

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

func (*CronJobSpec) Marshal added in v0.21.0 

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

func (*CronJobSpec) MarshalTo added in v0.21.0 

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

func (*CronJobSpec) MarshalToSizedBuffer added in v0.21.0 

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

func (*CronJobSpec) ProtoMessage added in v0.21.0 

func (*CronJobSpec) ProtoMessage()

func (*CronJobSpec) Reset added in v0.21.0 

func (m *CronJobSpec) Reset()

func (*CronJobSpec) Size added in v0.21.0 

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

func (*CronJobSpec) String added in v0.21.0 

func (this *CronJobSpec) String() string

func (CronJobSpec) SwaggerDoc added in v0.21.0 

func (CronJobSpec) SwaggerDoc() map[string]string

func (*CronJobSpec) Unmarshal added in v0.21.0 

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

func (*CronJobSpec) XXX_DiscardUnknown added in v0.21.0 

func (m *CronJobSpec) XXX_DiscardUnknown()

func (*CronJobSpec) XXX_Marshal added in v0.21.0 

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

func (*CronJobSpec) XXX_Merge added in v0.21.0 

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

func (*CronJobSpec) XXX_Size added in v0.21.0 

func (m *CronJobSpec) XXX_Size() int

func (*CronJobSpec) XXX_Unmarshal added in v0.21.0 

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

type CronJobStatus added in v0.21.0 

type CronJobStatus struct {
	// A list of pointers to currently running jobs.
	// +optional
	// +listType=atomic
	Active []corev1.ObjectReference `json:"active,omitempty" protobuf:"bytes,1,rep,name=active"`

	// Information when was the last time the job was successfully scheduled.
	// +optional
	LastScheduleTime *metav1.Time `json:"lastScheduleTime,omitempty" protobuf:"bytes,4,opt,name=lastScheduleTime"`

	// Information when was the last time the job successfully completed.
	// +optional
	LastSuccessfulTime *metav1.Time `json:"lastSuccessfulTime,omitempty" protobuf:"bytes,5,opt,name=lastSuccessfulTime"`
}

CronJobStatus represents the current state of a cron job.

func (*CronJobStatus) DeepCopy added in v0.21.0 

func (in *CronJobStatus) DeepCopy() *CronJobStatus

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

func (*CronJobStatus) DeepCopyInto added in v0.21.0 

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

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

func (*CronJobStatus) Descriptor added in v0.21.0 

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

func (*CronJobStatus) Marshal added in v0.21.0 

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

func (*CronJobStatus) MarshalTo added in v0.21.0 

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

func (*CronJobStatus) MarshalToSizedBuffer added in v0.21.0 

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

func (*CronJobStatus) ProtoMessage added in v0.21.0 

func (*CronJobStatus) ProtoMessage()

func (*CronJobStatus) Reset added in v0.21.0 

func (m *CronJobStatus) Reset()

func (*CronJobStatus) Size added in v0.21.0 

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

func (*CronJobStatus) String added in v0.21.0 

func (this *CronJobStatus) String() string

func (CronJobStatus) SwaggerDoc added in v0.21.0 

func (CronJobStatus) SwaggerDoc() map[string]string

func (*CronJobStatus) Unmarshal added in v0.21.0 

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

func (*CronJobStatus) XXX_DiscardUnknown added in v0.21.0 

func (m *CronJobStatus) XXX_DiscardUnknown()

func (*CronJobStatus) XXX_Marshal added in v0.21.0 

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

func (*CronJobStatus) XXX_Merge added in v0.21.0 

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

func (*CronJobStatus) XXX_Size added in v0.21.0 

func (m *CronJobStatus) XXX_Size() int

func (*CronJobStatus) XXX_Unmarshal added in v0.21.0 

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

type Job 

type Job struct {
	metav1.TypeMeta `json:",inline"`
	// Standard object's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// Specification of the desired behavior of a job.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
	// +optional
	Spec JobSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`

	// Current status of a job.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
	// +optional
	Status JobStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}

Job represents the configuration of a single job.

func (*Job) DeepCopy 

func (in *Job) DeepCopy() *Job

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

func (*Job) DeepCopyInto 

func (in *Job) DeepCopyInto(out *Job)

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

func (*Job) DeepCopyObject 

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

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

func (*Job) Descriptor 

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

func (*Job) Marshal 

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

func (*Job) MarshalTo 

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

func (*Job) MarshalToSizedBuffer added in v0.16.4 

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

func (*Job) ProtoMessage 

func (*Job) ProtoMessage()

func (*Job) Reset 

func (m *Job) Reset()

func (*Job) Size 

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

func (*Job) String 

func (this *Job) String() string

func (Job) SwaggerDoc 

func (Job) SwaggerDoc() map[string]string

func (*Job) Unmarshal 

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

func (*Job) XXX_DiscardUnknown added in v0.16.4 

func (m *Job) XXX_DiscardUnknown()

func (*Job) XXX_Marshal added in v0.16.4 

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

func (*Job) XXX_Merge added in v0.16.4 

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

func (*Job) XXX_Size added in v0.16.4 

func (m *Job) XXX_Size() int

func (*Job) XXX_Unmarshal added in v0.16.4 

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

type JobCondition 

type JobCondition struct {
	// Type of job condition, Complete or Failed.
	Type JobConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=JobConditionType"`
	// Status of the condition, one of True, False, Unknown.
	Status corev1.ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status,casttype=k8s.io/api/core/v1.ConditionStatus"`
	// Last time the condition was checked.
	// +optional
	LastProbeTime metav1.Time `json:"lastProbeTime,omitempty" protobuf:"bytes,3,opt,name=lastProbeTime"`
	// Last time the condition transit from one status to another.
	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty" protobuf:"bytes,4,opt,name=lastTransitionTime"`
	// (brief) reason for the condition's last transition.
	// +optional
	Reason string `json:"reason,omitempty" protobuf:"bytes,5,opt,name=reason"`
	// Human readable message indicating details about last transition.
	// +optional
	Message string `json:"message,omitempty" protobuf:"bytes,6,opt,name=message"`
}

JobCondition describes current state of a job.

func (*JobCondition) DeepCopy 

func (in *JobCondition) DeepCopy() *JobCondition

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

func (*JobCondition) DeepCopyInto 

func (in *JobCondition) DeepCopyInto(out *JobCondition)

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

func (*JobCondition) Descriptor 

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

func (*JobCondition) Marshal 

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

func (*JobCondition) MarshalTo 

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

func (*JobCondition) MarshalToSizedBuffer added in v0.16.4 

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

func (*JobCondition) ProtoMessage 

func (*JobCondition) ProtoMessage()

func (*JobCondition) Reset 

func (m *JobCondition) Reset()

func (*JobCondition) Size 

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

func (*JobCondition) String 

func (this *JobCondition) String() string

func (JobCondition) SwaggerDoc 

func (JobCondition) SwaggerDoc() map[string]string

func (*JobCondition) Unmarshal 

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

func (*JobCondition) XXX_DiscardUnknown added in v0.16.4 

func (m *JobCondition) XXX_DiscardUnknown()

func (*JobCondition) XXX_Marshal added in v0.16.4 

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

func (*JobCondition) XXX_Merge added in v0.16.4 

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

func (*JobCondition) XXX_Size added in v0.16.4 

func (m *JobCondition) XXX_Size() int

func (*JobCondition) XXX_Unmarshal added in v0.16.4 

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

type JobConditionType 

type JobConditionType string
const (
	// JobSuspended means the job has been suspended.
	JobSuspended JobConditionType = "Suspended"
	// JobComplete means the job has completed its execution.
	JobComplete JobConditionType = "Complete"
	// JobFailed means the job has failed its execution.
	JobFailed JobConditionType = "Failed"
)

These are built-in conditions of a job.

type JobList 

type JobList struct {
	metav1.TypeMeta `json:",inline"`
	// Standard list metadata.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	// +optional
	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// items is the list of Jobs.
	Items []Job `json:"items" protobuf:"bytes,2,rep,name=items"`
}

JobList is a collection of jobs.

func (*JobList) DeepCopy 

func (in *JobList) DeepCopy() *JobList

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

func (*JobList) DeepCopyInto 

func (in *JobList) DeepCopyInto(out *JobList)

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

func (*JobList) DeepCopyObject 

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

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

func (*JobList) Descriptor 

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

func (*JobList) Marshal 

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

func (*JobList) MarshalTo 

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

func (*JobList) MarshalToSizedBuffer added in v0.16.4 

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

func (*JobList) ProtoMessage 

func (*JobList) ProtoMessage()

func (*JobList) Reset 

func (m *JobList) Reset()

func (*JobList) Size 

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

func (*JobList) String 

func (this *JobList) String() string

func (JobList) SwaggerDoc 

func (JobList) SwaggerDoc() map[string]string

func (*JobList) Unmarshal 

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

func (*JobList) XXX_DiscardUnknown added in v0.16.4 

func (m *JobList) XXX_DiscardUnknown()

func (*JobList) XXX_Marshal added in v0.16.4 

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

func (*JobList) XXX_Merge added in v0.16.4 

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

func (*JobList) XXX_Size added in v0.16.4 

func (m *JobList) XXX_Size() int

func (*JobList) XXX_Unmarshal added in v0.16.4 

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

type JobSpec 

type JobSpec struct {

	// Specifies the maximum desired number of pods the job should
	// run at any given time. The actual number of pods running in steady state will
	// be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism),
	// i.e. when the work left to do is less than max parallelism.
	// More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
	// +optional
	Parallelism *int32 `json:"parallelism,omitempty" protobuf:"varint,1,opt,name=parallelism"`

	// Specifies the desired number of successfully finished pods the
	// job should be run with.  Setting to nil means that the success of any
	// pod signals the success of all pods, and allows parallelism to have any positive
	// value.  Setting to 1 means that parallelism is limited to 1 and the success of that
	// pod signals the success of the job.
	// More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
	// +optional
	Completions *int32 `json:"completions,omitempty" protobuf:"varint,2,opt,name=completions"`

	// Specifies the duration in seconds relative to the startTime that the job
	// may be continuously active before the system tries to terminate it; value
	// must be positive integer. If a Job is suspended (at creation or through an
	// update), this timer will effectively be stopped and reset when the Job is
	// resumed again.
	// +optional
	ActiveDeadlineSeconds *int64 `json:"activeDeadlineSeconds,omitempty" protobuf:"varint,3,opt,name=activeDeadlineSeconds"`

	// Specifies the number of retries before marking this job failed.
	// Defaults to 6
	// +optional
	BackoffLimit *int32 `json:"backoffLimit,omitempty" protobuf:"varint,7,opt,name=backoffLimit"`

	// A label query over pods that should match the pod count.
	// Normally, the system sets this field for you.
	// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
	// +optional
	Selector *metav1.LabelSelector `json:"selector,omitempty" protobuf:"bytes,4,opt,name=selector"`

	// manualSelector controls generation of pod labels and pod selectors.
	// Leave `manualSelector` unset unless you are certain what you are doing.
	// When false or unset, the system pick labels unique to this job
	// and appends those labels to the pod template.  When true,
	// the user is responsible for picking unique labels and specifying
	// the selector.  Failure to pick a unique label may cause this
	// and other jobs to not function correctly.  However, You may see
	// `manualSelector=true` in jobs that were created with the old `extensions/v1beta1`
	// API.
	// More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector
	// +optional
	ManualSelector *bool `json:"manualSelector,omitempty" protobuf:"varint,5,opt,name=manualSelector"`

	// Describes the pod that will be created when executing a job.
	// More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
	Template corev1.PodTemplateSpec `json:"template" protobuf:"bytes,6,opt,name=template"`

	// ttlSecondsAfterFinished limits the lifetime of a Job that has finished
	// execution (either Complete or Failed). If this field is set,
	// ttlSecondsAfterFinished after the Job finishes, it is eligible to be
	// automatically deleted. When the Job is being deleted, its lifecycle
	// guarantees (e.g. finalizers) will be honored. If this field is unset,
	// the Job won't be automatically deleted. If this field is set to zero,
	// the Job becomes eligible to be deleted immediately after it finishes.
	// +optional
	TTLSecondsAfterFinished *int32 `json:"ttlSecondsAfterFinished,omitempty" protobuf:"varint,8,opt,name=ttlSecondsAfterFinished"`

	// CompletionMode specifies how Pod completions are tracked. It can be
	// `NonIndexed` (default) or `Indexed`.
	//
	// `NonIndexed` means that the Job is considered complete when there have
	// been .spec.completions successfully completed Pods. Each Pod completion is
	// homologous to each other.
	//
	// `Indexed` means that the Pods of a
	// Job get an associated completion index from 0 to (.spec.completions - 1),
	// available in the annotation batch.kubernetes.io/job-completion-index.
	// The Job is considered complete when there is one successfully completed Pod
	// for each index.
	// When value is `Indexed`, .spec.completions must be specified and
	// `.spec.parallelism` must be less than or equal to 10^5.
	// In addition, The Pod name takes the form
	// `$(job-name)-$(index)-$(random-string)`,
	// the Pod hostname takes the form `$(job-name)-$(index)`.
	//
	// More completion modes can be added in the future.
	// If the Job controller observes a mode that it doesn't recognize, which
	// is possible during upgrades due to version skew, the controller
	// skips updates for the Job.
	// +optional
	CompletionMode *CompletionMode `json:"completionMode,omitempty" protobuf:"bytes,9,opt,name=completionMode,casttype=CompletionMode"`

	// Suspend specifies whether the Job controller should create Pods or not. If
	// a Job is created with suspend set to true, no Pods are created by the Job
	// controller. If a Job is suspended after creation (i.e. the flag goes from
	// false to true), the Job controller will delete all active Pods associated
	// with this Job. Users must design their workload to gracefully handle this.
	// Suspending a Job will reset the StartTime field of the Job, effectively
	// resetting the ActiveDeadlineSeconds timer too. Defaults to false.
	//
	// +optional
	Suspend *bool `json:"suspend,omitempty" protobuf:"varint,10,opt,name=suspend"`
}

JobSpec describes how the job execution will look like.

func (*JobSpec) DeepCopy 

func (in *JobSpec) DeepCopy() *JobSpec

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

func (*JobSpec) DeepCopyInto 

func (in *JobSpec) DeepCopyInto(out *JobSpec)

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

func (*JobSpec) Descriptor 

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

func (*JobSpec) Marshal 

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

func (*JobSpec) MarshalTo 

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

func (*JobSpec) MarshalToSizedBuffer added in v0.16.4 

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

func (*JobSpec) ProtoMessage 

func (*JobSpec) ProtoMessage()

func (*JobSpec) Reset 

func (m *JobSpec) Reset()

func (*JobSpec) Size 

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

func (*JobSpec) String 

func (this *JobSpec) String() string

func (JobSpec) SwaggerDoc 

func (JobSpec) SwaggerDoc() map[string]string

func (*JobSpec) Unmarshal 

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

func (*JobSpec) XXX_DiscardUnknown added in v0.16.4 

func (m *JobSpec) XXX_DiscardUnknown()

func (*JobSpec) XXX_Marshal added in v0.16.4 

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

func (*JobSpec) XXX_Merge added in v0.16.4 

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

func (*JobSpec) XXX_Size added in v0.16.4 

func (m *JobSpec) XXX_Size() int

func (*JobSpec) XXX_Unmarshal added in v0.16.4 

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

type JobStatus 

type JobStatus struct {
	// The latest available observations of an object's current state. When a Job
	// fails, one of the conditions will have type "Failed" and status true. When
	// a Job is suspended, one of the conditions will have type "Suspended" and
	// status true; when the Job is resumed, the status of this condition will
	// become false. When a Job is completed, one of the conditions will have
	// type "Complete" and status true.
	// More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
	// +optional
	// +patchMergeKey=type
	// +patchStrategy=merge
	// +listType=atomic
	Conditions []JobCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`

	// Represents time when the job controller started processing a job. When a
	// Job is created in the suspended state, this field is not set until the
	// first time it is resumed. This field is reset every time a Job is resumed
	// from suspension. It is represented in RFC3339 form and is in UTC.
	// +optional
	StartTime *metav1.Time `json:"startTime,omitempty" protobuf:"bytes,2,opt,name=startTime"`

	// Represents time when the job was completed. It is not guaranteed to
	// be set in happens-before order across separate operations.
	// It is represented in RFC3339 form and is in UTC.
	// The completion time is only set when the job finishes successfully.
	// +optional
	CompletionTime *metav1.Time `json:"completionTime,omitempty" protobuf:"bytes,3,opt,name=completionTime"`

	// The number of pending and running pods.
	// +optional
	Active int32 `json:"active,omitempty" protobuf:"varint,4,opt,name=active"`

	// The number of pods which reached phase Succeeded.
	// +optional
	Succeeded int32 `json:"succeeded,omitempty" protobuf:"varint,5,opt,name=succeeded"`

	// The number of pods which reached phase Failed.
	// +optional
	Failed int32 `json:"failed,omitempty" protobuf:"varint,6,opt,name=failed"`

	// CompletedIndexes holds the completed indexes when .spec.completionMode =
	// "Indexed" in a text format. The indexes are represented as decimal integers
	// separated by commas. The numbers are listed in increasing order. Three or
	// more consecutive numbers are compressed and represented by the first and
	// last element of the series, separated by a hyphen.
	// For example, if the completed indexes are 1, 3, 4, 5 and 7, they are
	// represented as "1,3-5,7".
	// +optional
	CompletedIndexes string `json:"completedIndexes,omitempty" protobuf:"bytes,7,opt,name=completedIndexes"`

	// UncountedTerminatedPods holds the UIDs of Pods that have terminated but
	// the job controller hasn't yet accounted for in the status counters.
	//
	// The job controller creates pods with a finalizer. When a pod terminates
	// (succeeded or failed), the controller does three steps to account for it
	// in the job status:
	// (1) Add the pod UID to the arrays in this field.
	// (2) Remove the pod finalizer.
	// (3) Remove the pod UID from the arrays while increasing the corresponding
	//     counter.
	//
	// This field is beta-level. The job controller only makes use of this field
	// when the feature gate JobTrackingWithFinalizers is enabled (enabled
	// by default).
	// Old jobs might not be tracked using this field, in which case the field
	// remains null.
	// +optional
	UncountedTerminatedPods *UncountedTerminatedPods `json:"uncountedTerminatedPods,omitempty" protobuf:"bytes,8,opt,name=uncountedTerminatedPods"`

	// The number of pods which have a Ready condition.
	//
	// This field is beta-level. The job controller populates the field when
	// the feature gate JobReadyPods is enabled (enabled by default).
	// +optional
	Ready *int32 `json:"ready,omitempty" protobuf:"varint,9,opt,name=ready"`
}

JobStatus represents the current state of a Job.

func (*JobStatus) DeepCopy 

func (in *JobStatus) DeepCopy() *JobStatus

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

func (*JobStatus) DeepCopyInto 

func (in *JobStatus) DeepCopyInto(out *JobStatus)

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

func (*JobStatus) Descriptor 

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

func (*JobStatus) Marshal 

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

func (*JobStatus) MarshalTo 

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

func (*JobStatus) MarshalToSizedBuffer added in v0.16.4 

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

func (*JobStatus) ProtoMessage 

func (*JobStatus) ProtoMessage()

func (*JobStatus) Reset 

func (m *JobStatus) Reset()

func (*JobStatus) Size 

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

func (*JobStatus) String 

func (this *JobStatus) String() string

func (JobStatus) SwaggerDoc 

func (JobStatus) SwaggerDoc() map[string]string

func (*JobStatus) Unmarshal 

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

func (*JobStatus) XXX_DiscardUnknown added in v0.16.4 

func (m *JobStatus) XXX_DiscardUnknown()

func (*JobStatus) XXX_Marshal added in v0.16.4 

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

func (*JobStatus) XXX_Merge added in v0.16.4 

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

func (*JobStatus) XXX_Size added in v0.16.4 

func (m *JobStatus) XXX_Size() int

func (*JobStatus) XXX_Unmarshal added in v0.16.4 

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

type JobTemplateSpec added in v0.21.0 

type JobTemplateSpec struct {
	// Standard object's metadata of the jobs created from this template.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// Specification of the desired behavior of the job.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
	// +optional
	Spec JobSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
}

JobTemplateSpec describes the data a Job should have when created from a template

func (*JobTemplateSpec) DeepCopy added in v0.21.0 

func (in *JobTemplateSpec) DeepCopy() *JobTemplateSpec

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

func (*JobTemplateSpec) DeepCopyInto added in v0.21.0 

func (in *JobTemplateSpec) DeepCopyInto(out *JobTemplateSpec)

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

func (*JobTemplateSpec) Descriptor added in v0.21.0 

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

func (*JobTemplateSpec) Marshal added in v0.21.0 

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

func (*JobTemplateSpec) MarshalTo added in v0.21.0 

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

func (*JobTemplateSpec) MarshalToSizedBuffer added in v0.21.0 

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

func (*JobTemplateSpec) ProtoMessage added in v0.21.0 

func (*JobTemplateSpec) ProtoMessage()

func (*JobTemplateSpec) Reset added in v0.21.0 

func (m *JobTemplateSpec) Reset()

func (*JobTemplateSpec) Size added in v0.21.0 

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

func (*JobTemplateSpec) String added in v0.21.0 

func (this *JobTemplateSpec) String() string

func (JobTemplateSpec) SwaggerDoc added in v0.21.0 

func (JobTemplateSpec) SwaggerDoc() map[string]string

func (*JobTemplateSpec) Unmarshal added in v0.21.0 

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

func (*JobTemplateSpec) XXX_DiscardUnknown added in v0.21.0 

func (m *JobTemplateSpec) XXX_DiscardUnknown()

func (*JobTemplateSpec) XXX_Marshal added in v0.21.0 

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

func (*JobTemplateSpec) XXX_Merge added in v0.21.0 

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

func (*JobTemplateSpec) XXX_Size added in v0.21.0 

func (m *JobTemplateSpec) XXX_Size() int

func (*JobTemplateSpec) XXX_Unmarshal added in v0.21.0 

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

type UncountedTerminatedPods added in v0.22.0 

type UncountedTerminatedPods struct {
	// Succeeded holds UIDs of succeeded Pods.
	// +listType=set
	// +optional
	Succeeded []types.UID `json:"succeeded,omitempty" protobuf:"bytes,1,rep,name=succeeded,casttype=k8s.io/apimachinery/pkg/types.UID"`

	// Failed holds UIDs of failed Pods.
	// +listType=set
	// +optional
	Failed []types.UID `json:"failed,omitempty" protobuf:"bytes,2,rep,name=failed,casttype=k8s.io/apimachinery/pkg/types.UID"`
}

UncountedTerminatedPods holds UIDs of Pods that have terminated but haven't been accounted in Job status counters.

func (*UncountedTerminatedPods) DeepCopy added in v0.22.0 

func (in *UncountedTerminatedPods) DeepCopy() *UncountedTerminatedPods

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

func (*UncountedTerminatedPods) DeepCopyInto added in v0.22.0 

func (in *UncountedTerminatedPods) DeepCopyInto(out *UncountedTerminatedPods)

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

func (*UncountedTerminatedPods) Descriptor added in v0.22.0 

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

func (*UncountedTerminatedPods) Marshal added in v0.22.0 

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

func (*UncountedTerminatedPods) MarshalTo added in v0.22.0 

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

func (*UncountedTerminatedPods) MarshalToSizedBuffer added in v0.22.0 

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

func (*UncountedTerminatedPods) ProtoMessage added in v0.22.0 

func (*UncountedTerminatedPods) ProtoMessage()

func (*UncountedTerminatedPods) Reset added in v0.22.0 

func (m *UncountedTerminatedPods) Reset()

func (*UncountedTerminatedPods) Size added in v0.22.0 

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

func (*UncountedTerminatedPods) String added in v0.22.0 

func (this *UncountedTerminatedPods) String() string

func (UncountedTerminatedPods) SwaggerDoc added in v0.22.0 

func (UncountedTerminatedPods) SwaggerDoc() map[string]string

func (*UncountedTerminatedPods) Unmarshal added in v0.22.0 

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

func (*UncountedTerminatedPods) XXX_DiscardUnknown added in v0.22.0 

func (m *UncountedTerminatedPods) XXX_DiscardUnknown()

func (*UncountedTerminatedPods) XXX_Marshal added in v0.22.0 

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

func (*UncountedTerminatedPods) XXX_Merge added in v0.22.0 

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

func (*UncountedTerminatedPods) XXX_Size added in v0.22.0 

func (m *UncountedTerminatedPods) XXX_Size() int

func (*UncountedTerminatedPods) XXX_Unmarshal added in v0.22.0 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.