Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[KubeRay] Support NumOfHosts when calculating PodSet assignments #3384

Merged
merged 1 commit into from
Oct 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions pkg/controller/jobs/raycluster/raycluster_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -113,14 +113,17 @@ func (j *RayCluster) PodSets() []kueue.PodSet {
// workers
for index := range j.Spec.WorkerGroupSpecs {
wgs := &j.Spec.WorkerGroupSpecs[index]
replicas := int32(1)
count := int32(1)
if wgs.Replicas != nil {
replicas = *wgs.Replicas
count = *wgs.Replicas
}
if wgs.NumOfHosts > 1 {
count *= wgs.NumOfHosts
}
podSets[index+1] = kueue.PodSet{
Name: strings.ToLower(wgs.GroupName),
Template: *wgs.Template.DeepCopy(),
Count: replicas,
Count: count,
TopologyRequest: jobframework.PodSetTopologyRequest(&wgs.Template.ObjectMeta),
}
}
Expand Down
136 changes: 136 additions & 0 deletions pkg/controller/jobs/raycluster/raycluster_controller_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -524,6 +524,142 @@ func TestReconciler(t *testing.T) {
Obj(),
},
},
"RayCluster with NumOfHosts > 1": {
initObjects: []client.Object{
utiltesting.MakeResourceFlavor("unit-test-flavor").NodeLabel("kubernetes.io/arch", "arm64").Obj(),
},
job: *baseJobWrapper.Clone().
WithNumOfHosts("workers-group-0", 2).
Obj(),
wantJob: *baseJobWrapper.Clone().
Suspend(false).
NodeSelectorHeadGroup("kubernetes.io/arch", "arm64").
WithNumOfHosts("workers-group-0", 2).
Obj(),
workloads: []kueue.Workload{
*utiltesting.MakeWorkload("test", "ns").
Finalizers(kueue.ResourceInUseFinalizerName).
PodSets(
kueue.PodSet{
Name: "head",
Count: int32(1),
Template: corev1.PodTemplateSpec{
Spec: corev1.PodSpec{

RestartPolicy: corev1.RestartPolicyNever,
Containers: []corev1.Container{
{
Name: "head-container",
Resources: corev1.ResourceRequirements{
Requests: make(corev1.ResourceList),
},
},
},
},
},
},
kueue.PodSet{
Name: "workers-group-0",
Count: int32(2),
Template: corev1.PodTemplateSpec{
Spec: corev1.PodSpec{
RestartPolicy: corev1.RestartPolicyNever,

Containers: []corev1.Container{
{
Name: "worker-container",
Resources: corev1.ResourceRequirements{
Requests: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("10"),
},
},
},
},
},
},
}).
Request(corev1.ResourceCPU, "10").
ReserveQuota(
utiltesting.MakeAdmission("cq", "head", "workers-group-0").
Assignment(corev1.ResourceCPU, "unit-test-flavor", "1").
AssignmentPodCount(2).
Obj(),
).
Admitted(true).
AdmissionCheck(kueue.AdmissionCheckState{
Name: "check",
State: kueue.CheckStateReady,
PodSetUpdates: []kueue.PodSetUpdate{
{
Name: "head",
},
{
Name: "workers-group-0",
},
},
}).
Obj(),
},
wantWorkloads: []kueue.Workload{
*utiltesting.MakeWorkload("a", "ns").
Finalizers(kueue.ResourceInUseFinalizerName).
PodSets(
kueue.PodSet{
Name: "head",
Count: int32(1),
Template: corev1.PodTemplateSpec{
Spec: corev1.PodSpec{
RestartPolicy: corev1.RestartPolicyNever,
Containers: []corev1.Container{
{
Name: "head-container",
Resources: corev1.ResourceRequirements{
Requests: make(corev1.ResourceList),
},
},
},
},
},
},
kueue.PodSet{
Name: "workers-group-0",
Count: int32(2),
Template: corev1.PodTemplateSpec{
Spec: corev1.PodSpec{
RestartPolicy: corev1.RestartPolicyNever,
Containers: []corev1.Container{
{
Name: "worker-container",
Resources: corev1.ResourceRequirements{
Requests: make(corev1.ResourceList),
},
},
},
},
},
}).
ReserveQuota(
utiltesting.MakeAdmission("cq", "head", "workers-group-0").
Assignment(corev1.ResourceCPU, "unit-test-flavor", "1").
AssignmentPodCount(2).
Obj(),
).
Admitted(true).
AdmissionCheck(kueue.AdmissionCheckState{
Name: "check",
State: kueue.CheckStateReady,
PodSetUpdates: []kueue.PodSetUpdate{
{
Name: "head",
},
{
Name: "workers-group-0",
},
},
}).
Obj(),
},
},
}
for name, tc := range cases {
t.Run(name, func(t *testing.T) {
Expand Down
9 changes: 6 additions & 3 deletions pkg/controller/jobs/rayjob/rayjob_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -117,14 +117,17 @@ func (j *RayJob) PodSets() []kueue.PodSet {
// workers
for index := range j.Spec.RayClusterSpec.WorkerGroupSpecs {
wgs := &j.Spec.RayClusterSpec.WorkerGroupSpecs[index]
replicas := int32(1)
count := int32(1)
if wgs.Replicas != nil {
replicas = *wgs.Replicas
count = *wgs.Replicas
}
if wgs.NumOfHosts > 1 {
count *= wgs.NumOfHosts
}
podSets[index+1] = kueue.PodSet{
Name: strings.ToLower(wgs.GroupName),
Template: *wgs.Template.DeepCopy(),
Count: replicas,
Count: count,
TopologyRequest: jobframework.PodSetTopologyRequest(&wgs.Template.ObjectMeta),
}
}
Expand Down
47 changes: 47 additions & 0 deletions pkg/controller/jobs/rayjob/rayjob_controller_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,53 @@ func TestPodSets(t *testing.T) {
}
},
},
"with NumOfHosts > 1": {
rayJob: (*RayJob)(testingrayutil.MakeJob("rayjob", "ns").
WithHeadGroupSpec(
rayv1.HeadGroupSpec{
Template: corev1.PodTemplateSpec{
Spec: corev1.PodSpec{Containers: []corev1.Container{{Name: "head_c"}}},
},
},
).
WithWorkerGroups(
rayv1.WorkerGroupSpec{
GroupName: "group1",
NumOfHosts: 4,
Template: corev1.PodTemplateSpec{
Spec: corev1.PodSpec{Containers: []corev1.Container{{Name: "group1_c"}}},
},
},
rayv1.WorkerGroupSpec{
GroupName: "group2",
Replicas: ptr.To[int32](3),
NumOfHosts: 4,
Template: corev1.PodTemplateSpec{
Spec: corev1.PodSpec{Containers: []corev1.Container{{Name: "group2_c"}}},
},
},
).
Obj()),
wantPodSets: func(rayJob *RayJob) []kueue.PodSet {
return []kueue.PodSet{
{
Name: headGroupPodSetName,
Count: 1,
Template: *rayJob.Spec.RayClusterSpec.HeadGroupSpec.Template.DeepCopy(),
},
{
Name: "group1",
Count: 4,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Count: 4,
Count: 1,

Template: *rayJob.Spec.RayClusterSpec.WorkerGroupSpecs[0].Template.DeepCopy(),
},
{
Name: "group2",
Count: 12,
Template: *rayJob.Spec.RayClusterSpec.WorkerGroupSpecs[1].Template.DeepCopy(),
},
}
},
},
}
for name, tc := range testCases {
t.Run(name, func(t *testing.T) {
Expand Down
9 changes: 9 additions & 0 deletions pkg/util/testingjobs/raycluster/wrappers.go
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,15 @@ func (j *ClusterWrapper) WithWorkerPriorityClassName(value string) *ClusterWrapp
return j
}

func (j *ClusterWrapper) WithNumOfHosts(groupName string, value int32) *ClusterWrapper {
for index, group := range j.Spec.WorkerGroupSpecs {
if group.GroupName == groupName {
j.Spec.WorkerGroupSpecs[index].NumOfHosts = value
}
}
return j
}

// WorkloadPriorityClass updates job workloadpriorityclass.
func (j *ClusterWrapper) WorkloadPriorityClass(wpc string) *ClusterWrapper {
if j.Labels == nil {
Expand Down