mxjob

Documentation

Index

• type MXJobWrapper
  • func MakeMXJob(name, ns string) *MXJobWrapper
  • func (j *MXJobWrapper) Active(rType kftraining.ReplicaType, c int32) *MXJobWrapper
  • func (j *MXJobWrapper) Annotations(annotations map[string]string) *MXJobWrapper
  • func (j *MXJobWrapper) Args(args []string) *MXJobWrapper
  • func (j *MXJobWrapper) Image(image string) *MXJobWrapper
  • func (j *MXJobWrapper) NodeSelector(k, v string) *MXJobWrapper
  • func (j *MXJobWrapper) Obj() *kftraining.MXJob
  • func (j *MXJobWrapper) Parallelism(workerParallelism, psParallelism int32) *MXJobWrapper
  • func (j *MXJobWrapper) PodAnnotation(replicaType kftraining.ReplicaType, k, v string) *MXJobWrapper
  • func (j *MXJobWrapper) PriorityClass(pc string) *MXJobWrapper
  • func (j *MXJobWrapper) Queue(queue string) *MXJobWrapper
  • func (j *MXJobWrapper) Request(replicaType kftraining.ReplicaType, r corev1.ResourceName, v string) *MXJobWrapper
  • func (j *MXJobWrapper) RoleNodeSelector(role kftraining.ReplicaType, k, v string) *MXJobWrapper
  • func (j *MXJobWrapper) StatusConditions(conditions ...kftraining.JobCondition) *MXJobWrapper
  • func (j *MXJobWrapper) Suspend(s bool) *MXJobWrapper
  • func (j *MXJobWrapper) UID(uid string) *MXJobWrapper
  • func (j *MXJobWrapper) WorkloadPriorityClass(wpc string) *MXJobWrapper

Types

type MXJobWrapper

type MXJobWrapper struct{ kftraining.MXJob }

MXJobWrapper wraps a Job.

func MakeMXJob

func MakeMXJob(name, ns string) *MXJobWrapper

MakeMXJob creates a wrapper for a suspended job with a single container and parallelism=1.

func (*MXJobWrapper) Active

func (j *MXJobWrapper) Active(rType kftraining.ReplicaType, c int32) *MXJobWrapper

Active updates the replicaStatus for Active of job.

func (*MXJobWrapper) Annotations

func (j *MXJobWrapper) Annotations(annotations map[string]string) *MXJobWrapper

Annotations updates annotations of the job.

func (*MXJobWrapper) Args

func (j *MXJobWrapper) Args(args []string) *MXJobWrapper

Args updates args of the job.

func (*MXJobWrapper) Image

func (j *MXJobWrapper) Image(image string) *MXJobWrapper

Image updates images of the job.

func (*MXJobWrapper) NodeSelector

func (j *MXJobWrapper) NodeSelector(k, v string) *MXJobWrapper

NodeSelector updates the nodeSelector of job.

func (*MXJobWrapper) Obj

func (j *MXJobWrapper) Obj() *kftraining.MXJob

Obj returns the inner Job.

func (*MXJobWrapper) Parallelism

func (j *MXJobWrapper) Parallelism(workerParallelism, psParallelism int32) *MXJobWrapper

Parallelism updates job parallelism.

func (*MXJobWrapper) PodAnnotation

func (j *MXJobWrapper) PodAnnotation(replicaType kftraining.ReplicaType, k, v string) *MXJobWrapper

PodAnnotation sets annotation at the pod template level

func (*MXJobWrapper) PriorityClass

func (j *MXJobWrapper) PriorityClass(pc string) *MXJobWrapper

PriorityClass updates job priorityclass.

func (*MXJobWrapper) Queue

func (j *MXJobWrapper) Queue(queue string) *MXJobWrapper

Queue updates the queue name of the job.

func (*MXJobWrapper) Request

func (j *MXJobWrapper) Request(replicaType kftraining.ReplicaType, r corev1.ResourceName, v string) *MXJobWrapper

Request adds a resource request to the default container.

func (*MXJobWrapper) RoleNodeSelector

func (j *MXJobWrapper) RoleNodeSelector(role kftraining.ReplicaType, k, v string) *MXJobWrapper

RoleNodeSelector updates the nodeSelector of job.

func (*MXJobWrapper) StatusConditions

func (j *MXJobWrapper) StatusConditions(conditions ...kftraining.JobCondition) *MXJobWrapper

StatusConditions updates status conditions of the MXJob.

func (*MXJobWrapper) Suspend

func (j *MXJobWrapper) Suspend(s bool) *MXJobWrapper

Suspend updates the suspend status of the job.

func (*MXJobWrapper) UID

func (j *MXJobWrapper) UID(uid string) *MXJobWrapper

UID updates the uid of the job.

func (*MXJobWrapper) WorkloadPriorityClass

func (j *MXJobWrapper) WorkloadPriorityClass(wpc string) *MXJobWrapper

WorkloadPriorityClass updates job workloadpriorityclass.