pkg/util/testingjobs/rayjob/wrappers.go

/*
Copyright 2023 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package rayjob

import (
	rayjobapi "github.com/ray-project/kuberay/ray-operator/apis/ray/v1alpha1"
	corev1 "k8s.io/api/core/v1"
	"k8s.io/apimachinery/pkg/api/resource"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"

	"sigs.k8s.io/kueue/pkg/controller/jobframework"
	"sigs.k8s.io/kueue/pkg/util/pointer"
)

// JobWrapper wraps a RayJob.
type JobWrapper struct{ rayjobapi.RayJob }

// MakeJob creates a wrapper for a suspended rayJob
func MakeJob(name, ns string) *JobWrapper {
	return &JobWrapper{rayjobapi.RayJob{
		ObjectMeta: metav1.ObjectMeta{
			Name:        name,
			Namespace:   ns,
			Annotations: make(map[string]string, 1),
		},
		Spec: rayjobapi.RayJobSpec{
			ShutdownAfterJobFinishes: true,
			RayClusterSpec: &rayjobapi.RayClusterSpec{
				HeadGroupSpec: rayjobapi.HeadGroupSpec{
					RayStartParams: map[string]string{"p1": "v1"},
					Template: corev1.PodTemplateSpec{
						Spec: corev1.PodSpec{
							Containers: []corev1.Container{
								{
									Name: "head-container",
								},
							},
						},
					},
				},
				WorkerGroupSpecs: []rayjobapi.WorkerGroupSpec{
					{
						GroupName:      "workers-group-0",
						Replicas:       pointer.Int32(1),
						MinReplicas:    pointer.Int32(0),
						MaxReplicas:    pointer.Int32(10),
						RayStartParams: map[string]string{"p1": "v1"},
						Template: corev1.PodTemplateSpec{
							Spec: corev1.PodSpec{
								Containers: []corev1.Container{
									{
										Name: "worker-container",
									},
								},
							},
						},
					},
				},
			},
			Suspend: true,
		},
	}}
}

// Obj returns the inner Job.
func (j *JobWrapper) Obj() *rayjobapi.RayJob {
	return &j.RayJob
}

// Suspend updates the suspend status of the job
func (j *JobWrapper) Suspend(s bool) *JobWrapper {
	j.Spec.Suspend = s
	return j
}

// Queue updates the queue name of the job
func (j *JobWrapper) Queue(queue string) *JobWrapper {
	if j.Labels == nil {
		j.Labels = make(map[string]string)
	}
	j.Labels[jobframework.QueueLabel] = queue
	return j
}

func (j *JobWrapper) RequestWorkerGroup(name corev1.ResourceName, quantity string) *JobWrapper {
	c := &j.Spec.RayClusterSpec.WorkerGroupSpecs[0].Template.Spec.Containers[0]
	if c.Resources.Requests == nil {
		c.Resources.Requests = corev1.ResourceList{name: resource.MustParse(quantity)}
	} else {
		c.Resources.Requests[name] = resource.MustParse(quantity)
	}
	return j
}

func (j *JobWrapper) RequestHead(name corev1.ResourceName, quantity string) *JobWrapper {
	c := &j.Spec.RayClusterSpec.HeadGroupSpec.Template.Spec.Containers[0]
	if c.Resources.Requests == nil {
		c.Resources.Requests = corev1.ResourceList{name: resource.MustParse(quantity)}
	} else {
		c.Resources.Requests[name] = resource.MustParse(quantity)
	}
	return j
}

func (j *JobWrapper) ShutdownAfterJobFinishes(value bool) *JobWrapper {
	j.Spec.ShutdownAfterJobFinishes = value
	return j
}

func (j *JobWrapper) ClusterSelector(value map[string]string) *JobWrapper {
	j.Spec.ClusterSelector = value
	return j
}

func (j *JobWrapper) WithEnableAutoscaling(value *bool) *JobWrapper {
	j.Spec.RayClusterSpec.EnableInTreeAutoscaling = value
	return j
}

func (j *JobWrapper) WithWorkerGroups(workers ...rayjobapi.WorkerGroupSpec) *JobWrapper {
	j.Spec.RayClusterSpec.WorkerGroupSpecs = workers
	return j
}

func (j *JobWrapper) WithHeadGroupSpec(value rayjobapi.HeadGroupSpec) *JobWrapper {
	j.Spec.RayClusterSpec.HeadGroupSpec = value
	return j
}

func (j *JobWrapper) WithPriorityClassName(value string) *JobWrapper {
	j.Spec.RayClusterSpec.HeadGroupSpec.Template.Spec.PriorityClassName = value
	return j
}

func (j *JobWrapper) WithWorkerPriorityClassName(value string) *JobWrapper {
	j.Spec.RayClusterSpec.WorkerGroupSpecs[0].Template.Spec.PriorityClassName = value
	return j
}