job

Documentation

Index

• Constants
• Variables
• func GetWorkloadNameForJob(jobName string, jobUID types.UID) string
• func NewJob() jobframework.GenericJob
• func SetupIndexes(ctx context.Context, fieldIndexer client.FieldIndexer) error
• func SetupWebhook(mgr ctrl.Manager, opts ...jobframework.Option) error
• type Job
  • func (j *Job) Finished() (message string, success, finished bool)
  • func (j *Job) GVK() schema.GroupVersionKind
  • func (j *Job) IsActive() bool
  • func (j *Job) IsSuspended() bool
  • func (j *Job) Object() client.Object
  • func (j *Job) PodLabelSelector() string
  • func (j *Job) PodSets() []kueue.PodSet
  • func (j *Job) PodsReady() bool
  • func (j *Job) ReclaimablePods() ([]kueue.ReclaimablePod, error)
  • func (j *Job) RestorePodSetsInfo(podSetsInfo []podset.PodSetInfo) bool
  • func (j *Job) RunWithPodSetsInfo(podSetsInfo []podset.PodSetInfo) error
  • func (j *Job) Stop(ctx context.Context, c client.Client, podSetsInfo []podset.PodSetInfo, ...) (bool, error)
  • func (j *Job) Suspend()
• type JobWebhook
  • func (w *JobWebhook) Default(ctx context.Context, obj runtime.Object) error
  • func (w *JobWebhook) ValidateCreate(ctx context.Context, obj runtime.Object) (admission.Warnings, error)
  • func (w *JobWebhook) ValidateDelete(_ context.Context, _ runtime.Object) (admission.Warnings, error)
  • func (w *JobWebhook) ValidateUpdate(ctx context.Context, oldObj, newObj runtime.Object) (admission.Warnings, error)

Constants

const (
	JobMinParallelismAnnotation              = "kueue.x-k8s.io/job-min-parallelism"
	JobCompletionsEqualParallelismAnnotation = "kueue.x-k8s.io/job-completions-equal-parallelism"
	StoppingAnnotation                       = "kueue.x-k8s.io/stopping"
)

Variables

var (
	FrameworkName = "batch/job"
)

var (
	ManagedLabels = []string{legacyJobNameLabel, legacyControllerUIDLabel, batchv1.JobNameLabel, batchv1.ControllerUidLabel}
)

The following labels are managed internally by batch/job controller, we should not propagate them to the workload.

var NewReconciler = jobframework.NewGenericReconcilerFactory(NewJob, func(b *builder.Builder, c client.Client) *builder.Builder {
	return b.Watches(&kueue.Workload{}, &parentWorkloadHandler{client: c})
})

Functions

func GetWorkloadNameForJob

func GetWorkloadNameForJob(jobName string, jobUID types.UID) string

func NewJob

func NewJob() jobframework.GenericJob

func SetupIndexes

func SetupIndexes(ctx context.Context, fieldIndexer client.FieldIndexer) error

func SetupWebhook

func SetupWebhook(mgr ctrl.Manager, opts ...jobframework.Option) error

SetupWebhook configures the webhook for batchJob.

Types

type Job

type Job batchv1.Job

func (*Job) Finished

func (j *Job) Finished() (message string, success, finished bool)

func (*Job) GVK

func (j *Job) GVK() schema.GroupVersionKind

func (*Job) IsActive

func (j *Job) IsActive() bool

func (*Job) IsSuspended

func (j *Job) IsSuspended() bool

func (*Job) Object

func (j *Job) Object() client.Object

func (*Job) PodLabelSelector

func (j *Job) PodLabelSelector() string

func (*Job) PodSets

func (j *Job) PodSets() []kueue.PodSet

func (*Job) PodsReady

func (j *Job) PodsReady() bool

func (*Job) ReclaimablePods

func (j *Job) ReclaimablePods() ([]kueue.ReclaimablePod, error)

func (*Job) RestorePodSetsInfo

func (j *Job) RestorePodSetsInfo(podSetsInfo []podset.PodSetInfo) bool

func (*Job) RunWithPodSetsInfo

func (j *Job) RunWithPodSetsInfo(podSetsInfo []podset.PodSetInfo) error

func (*Job) Stop

func (j *Job) Stop(ctx context.Context, c client.Client, podSetsInfo []podset.PodSetInfo, _ jobframework.StopReason, _ string) (bool, error)

func (*Job) Suspend

func (j *Job) Suspend()

type JobWebhook

type JobWebhook struct {
	// contains filtered or unexported fields
}

func (*JobWebhook) Default

func (w *JobWebhook) Default(ctx context.Context, obj runtime.Object) error

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

func (*JobWebhook) ValidateCreate

func (w *JobWebhook) ValidateCreate(ctx context.Context, obj runtime.Object) (admission.Warnings, error)

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

func (*JobWebhook) ValidateDelete

func (w *JobWebhook) ValidateDelete(_ context.Context, _ runtime.Object) (admission.Warnings, error)

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

func (*JobWebhook) ValidateUpdate

func (w *JobWebhook) ValidateUpdate(ctx context.Context, oldObj, newObj runtime.Object) (admission.Warnings, error)

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