mpijob

Documentation

Index

• Variables
• func GetWorkloadNameForMPIJob(jobName string, jobUID types.UID) string
• func NewJob() jobframework.GenericJob
• func SetupIndexes(ctx context.Context, indexer client.FieldIndexer) error
• type MPIJob
  • func (j *MPIJob) Finished() (message string, success, finished bool)
  • func (j *MPIJob) GVK() schema.GroupVersionKind
  • func (j *MPIJob) IsActive() bool
  • func (j *MPIJob) IsSuspended() bool
  • func (j *MPIJob) Object() client.Object
  • func (j *MPIJob) PodSets() []kueue.PodSet
  • func (j *MPIJob) PodsReady() bool
  • func (j *MPIJob) PriorityClass() string
  • func (j *MPIJob) RestorePodSetsInfo(podSetsInfo []podset.PodSetInfo) bool
  • func (j *MPIJob) RunWithPodSetsInfo(podSetsInfo []podset.PodSetInfo) error
  • func (j *MPIJob) Suspend()

Variables

var (
	FrameworkName = "kubeflow.org/mpijob"

	SetupMPIJobWebhook = jobframework.DefaultWebhookFactory(NewJob(), fromObject)
)

var NewReconciler = jobframework.NewGenericReconcilerFactory(func() jobframework.GenericJob { return &MPIJob{} })

Functions

func GetWorkloadNameForMPIJob

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

func NewJob

func NewJob() jobframework.GenericJob

func SetupIndexes

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

Types

type MPIJob

type MPIJob kubeflow.MPIJob

func (*MPIJob) Finished

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

func (*MPIJob) GVK

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

func (*MPIJob) IsActive

func (j *MPIJob) IsActive() bool

func (*MPIJob) IsSuspended

func (j *MPIJob) IsSuspended() bool

func (*MPIJob) Object

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

func (*MPIJob) PodSets

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

func (*MPIJob) PodsReady

func (j *MPIJob) PodsReady() bool

func (*MPIJob) PriorityClass

func (j *MPIJob) PriorityClass() string

PriorityClass calculates the priorityClass name needed for workload according to the following priorities:

1. .spec.runPolicy.schedulingPolicy.priorityClass
2. .spec.mpiReplicaSpecs[Launcher].template.spec.priorityClassName
3. .spec.mpiReplicaSpecs[Worker].template.spec.priorityClassName

This function is inspired by an analogous one in mpi-controller: https://github.com/kubeflow/mpi-operator/blob/5946ef4157599a474ab82ff80e780d5c2546c9ee/pkg/controller/podgroup.go#L69-L72

func (*MPIJob) RestorePodSetsInfo

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

func (*MPIJob) RunWithPodSetsInfo

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

func (*MPIJob) Suspend

func (j *MPIJob) Suspend()