Implement GenericJob interface on batchv1.Job (cherry-picked and resolved conflicts) #616

mimowo · 2023-03-08T14:07:45Z

What type of PR is this?

/kind feature

What this PR does / why we need it:

This is an addition of the GenericJob interface, in preparation for creating a library for frameworks and to commonize code between Job and MPIJob.

Which issue(s) this PR fixes:

Part of #369

Special notes for your reviewer:

This is a fork of ebf2b81 by @kerthcet aligned with the current master.

netlify · 2023-03-08T14:07:55Z

✅ Deploy Preview for kubernetes-sigs-kueue canceled.

Name	Link
🔨 Latest commit	`33ff294`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-sigs-kueue/deploys/640992db97ca0400079f08a0

alculquicondor · 2023-03-08T14:20:40Z

@kerthcet we are eager to migrate the existing controllers to the library so that we can integrate Ray as well ray-project/kuberay#926. Is it ok with you if we merge this?

alculquicondor · 2023-03-08T14:42:24Z

pkg/controller/workload/job/job_controller.go

+type BatchJob struct {
+	batchv1.Job
+}


Suggested change

type BatchJob struct {

batchv1.Job

}

type Job batchv1.Job

I don't think this is equivalent. If I do that the extra interface functions don't compile. The idea of introducing BatchJob is so that we can implement GenericJob.

Is this equivalent? https://go.dev/play/p/N0o1sEDyJVF

Interesting, the example works indeed. However, there seems to be some subtle differences.
One thing is that when doing type BatchJob struct {batchv1.Job } the BatchJob has the Job field, so the code didn't compile for me at some places. Also, the BatchJob.Object() method now doesn't compile, but I guess I can make fixes.

With a type rename, I think this should work, so we don't need more variables.

var job *Job k8sClient.Get(ctx, job)

type definition will not inherit the methods. In k8sClient.Get(ctx, job) the job should be a Kubernetes Object. I considered type alias, but seems not the right scenario VS package migration.

/approve
up to you if you want to proceed with this or switch to type Job batch.Job

For now, I prefer the current approach, because it reflects the conceptual distinction between the Job object and the wrapper for the framework purposes. Also, I think we will have time to return to this on the follow up PR(s).

/hold cancel

pkg/controller/workload/job/job_controller.go

pkg/controller/workload/job/interface.go

pkg/controller/workload/job/helpers.go

pkg/controller/workload/job/job_controller.go

kerthcet · 2023-03-08T15:43:21Z

@kerthcet we are eager to migrate the existing controllers to the library so that we can integrate Ray as well ray-project/kuberay#926. Is it ok with you if we merge this?

Yes plz go ahead, I got something I need to take care of. I already talked with @mimowo offline. I will be back until tomorrow or longer. Thanks guys.

alculquicondor

/approve
up to you if you want to proceed with this or switch to type Job batch.Job

k8s-ci-robot · 2023-03-08T18:32:42Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alculquicondor, mimowo

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [alculquicondor]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

alculquicondor · 2023-03-08T18:32:47Z

/lgtm
/hold

kerthcet · 2023-03-09T04:18:10Z

pkg/controller/workload/job/job_controller.go

+	return nil
+}
+
+func (b *BatchJob) Finished() (metav1.Condition, bool) {


One argu about the condition is maybe some other projects do not use v1.Condition.

I sort of agree, but I think we still have time to return to this decision as we get more info from other frameworks.

If necessary, the controller implementations can translate from one object to the other. In general they should look pretty similar.

kerthcet · 2023-03-09T06:17:56Z

pkg/controller/workload/job/job_controller.go

+type BatchJob struct {
+	batchv1.Job
+}


type definition will not inherit the methods. In k8sClient.Get(ctx, job) the job should be a Kubernetes Object. I considered type alias, but seems not the right scenario VS package migration.

kerthcet · 2023-03-09T06:35:13Z

pkg/controller/workload/jobframework/helpers.go

+	}
+
+	// If there is no matching workload and the job is running, suspend it.
+	if match == nil && !job.IsSuspend() {


I used to think about move this out of the function then we can handle the Start & Stop operation in the main reconciler loop. But when the matched workload is nil we don't know the injected nodeSelector, so I raised the issue: #518

We can leave it as it-is and discuss about it in that issue.

It seems a separate issue, leaving as-is for now.

mimowo · 2023-03-09T08:01:09Z

/hold
I've realized the first commit is't marked as co-authored by @kerthcet , let me try to fix it.

Original commit by Kante Yin "Implement genericjob interface on batchv1.Job": kubernetes-sigs@ebf2b81 Cherry-picked and conflicts resolution by Michal Wozniak <mw219725@gmail.com> Co-authored-by: Kante Yin <kerthcet@gmail.com> Co-authored-by: Michal Wozniak <mw219725@gmail.com>

# Conflicts: # pkg/controller/workload/job/job_controller.go

mimowo · 2023-03-09T08:05:18Z

/hold
I've realized the first commit is't marked as co-authored by @kerthcet , let me try to fix it.

Done: https://github.com/kubernetes-sigs/kueue/pull/616/commits.

@kerthcet please renew the LGTM.

mimowo · 2023-03-09T08:07:56Z

/hold cancel
waiting for LGTM

kerthcet · 2023-03-09T08:16:14Z

/lgtm
We need more feedbacks also.

k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 8, 2023

k8s-ci-robot requested review from ArangoGutierrez and denkensk March 8, 2023 14:07

k8s-ci-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Mar 8, 2023

mimowo force-pushed the generic-job-interface branch 2 times, most recently from 790b086 to c5b7344 Compare March 8, 2023 14:20

mimowo force-pushed the generic-job-interface branch 2 times, most recently from 6926605 to 4fecb4e Compare March 8, 2023 14:23

alculquicondor reviewed Mar 8, 2023

View reviewed changes

mimowo changed the title ~~Implement GenericJob interface on batchv1.Job (forked and resolved conflicts)~~ Implement GenericJob interface on batchv1.Job (cherry-picked and resolved conflicts) Mar 8, 2023

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 8, 2023

mimowo force-pushed the generic-job-interface branch from 1d4a4ce to 435284a Compare March 8, 2023 16:40

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 8, 2023

alculquicondor reviewed Mar 8, 2023

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 8, 2023

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 8, 2023

k8s-ci-robot assigned alculquicondor Mar 8, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 8, 2023

kerthcet mentioned this pull request Mar 9, 2023

Fix workload would be created and deleted indefinitely #597

Closed

kerthcet reviewed Mar 9, 2023

View reviewed changes

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 9, 2023

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 9, 2023

Review remarks and cleanup

33ff294

# Conflicts: # pkg/controller/workload/job/job_controller.go

mimowo force-pushed the generic-job-interface branch from 435284a to 33ff294 Compare March 9, 2023 08:03

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 9, 2023

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 9, 2023

k8s-ci-robot assigned kerthcet Mar 9, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 9, 2023

k8s-ci-robot merged commit e01a5a8 into kubernetes-sigs:main Mar 9, 2023

alculquicondor mentioned this pull request Mar 15, 2023

Implement genericjob interface on batchv1.Job #544

Closed

mimowo deleted the generic-job-interface branch March 18, 2023 18:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement GenericJob interface on batchv1.Job (cherry-picked and resolved conflicts) #616

Implement GenericJob interface on batchv1.Job (cherry-picked and resolved conflicts) #616

mimowo commented Mar 8, 2023 •

edited

Loading

netlify bot commented Mar 8, 2023 •

edited

Loading

alculquicondor commented Mar 8, 2023

alculquicondor Mar 8, 2023

mimowo Mar 8, 2023

alculquicondor Mar 8, 2023

mimowo Mar 8, 2023 •

edited

Loading

alculquicondor Mar 8, 2023

kerthcet Mar 9, 2023

mimowo Mar 9, 2023

kerthcet commented Mar 8, 2023 •

edited

Loading

alculquicondor left a comment

k8s-ci-robot commented Mar 8, 2023

alculquicondor commented Mar 8, 2023

kerthcet Mar 9, 2023

mimowo Mar 9, 2023

alculquicondor Mar 9, 2023

kerthcet Mar 9, 2023

kerthcet Mar 9, 2023

mimowo Mar 9, 2023

mimowo commented Mar 9, 2023 •

edited

Loading

mimowo commented Mar 9, 2023

mimowo commented Mar 9, 2023

kerthcet commented Mar 9, 2023

Implement GenericJob interface on batchv1.Job (cherry-picked and resolved conflicts) #616

Implement GenericJob interface on batchv1.Job (cherry-picked and resolved conflicts) #616

Conversation

mimowo commented Mar 8, 2023 • edited Loading

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for your reviewer:

netlify bot commented Mar 8, 2023 • edited Loading

✅ Deploy Preview for kubernetes-sigs-kueue canceled.

alculquicondor commented Mar 8, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mimowo Mar 8, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kerthcet commented Mar 8, 2023 • edited Loading

alculquicondor left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Mar 8, 2023

alculquicondor commented Mar 8, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mimowo commented Mar 9, 2023 • edited Loading

mimowo commented Mar 9, 2023

mimowo commented Mar 9, 2023

kerthcet commented Mar 9, 2023

mimowo commented Mar 8, 2023 •

edited

Loading

netlify bot commented Mar 8, 2023 •

edited

Loading

mimowo Mar 8, 2023 •

edited

Loading

kerthcet commented Mar 8, 2023 •

edited

Loading

mimowo commented Mar 9, 2023 •

edited

Loading