feat: update PodGroup label key #521

nayihz · 2023-02-21T11:35:49Z

What type of PR is this?

/kind feature

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes ##440

Special notes for your reviewer:

Does this PR introduce a user-facing change?

using new pod label key `scheduling.x-k8s.io/pod-group` to define a PodGroup.

k8s-ci-robot · 2023-02-21T11:35:57Z

Welcome @cmssczy!

It looks like this is your first PR to kubernetes-sigs/scheduler-plugins 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/scheduler-plugins has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2023-02-21T11:35:58Z

Hi @cmssczy. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

nayihz · 2023-02-22T14:15:11Z

@denkensk PTAL

zwpaper

@denkensk I have 2 more questions,

Should we handle the case that a Pod has both the new and deprecated key?
Should we add docs in README noticing the key changes?

zwpaper · 2023-02-23T05:30:36Z

pkg/util/podgroup.go

@@ -47,9 +47,12 @@ func CreateMergePatch(original, new interface{}) ([]byte, error) {
 	return patch, nil
 }

-// GetPodGroupLabel get pod group from pod annotations
+// GetPodGroupLabel get pod group name from pod annotations


Suggested change

// GetPodGroupLabel get pod group name from pod annotations

// GetPodGroupLabel get pod group name from pod labels

zwpaper · 2023-02-23T05:33:40Z

pkg/controllers/podgroup_controller.go

@@ -99,7 +99,20 @@ func (r *PodGroupReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
 		log.Error(err, "List pods for group failed")
 		return ctrl.Result{}, err
 	}
-	pods := podList.Items
+	pods := podList.DeepCopy().Items
+	// use deprecated label key if cannot list pod by new label.


Suggested change

// use deprecated label key if cannot list pod by new label.

// also list pods by the deprecated key for compatibility

zwpaper · 2023-02-23T05:36:54Z

pkg/controllers/podgroup_test.go

@@ -310,6 +326,20 @@ func makePods(podNames []string, pgName string, phase v1.PodPhase, reference []m
 	return pds
 }

+func makePodsWithDeprecatedLabel(podNames []string, pgName string, phase v1.PodPhase, reference []metav1.OwnerReference) []*v1.Pod {


how about adding an args for makePods instead of a new function?

denkensk · 2023-02-23T15:01:04Z

/ok-to-test

denkensk · 2023-02-23T15:06:04Z

Should we handle the case that a Pod has both the new and deprecated key?

If so, the new key first

Should we add docs in README noticing the key changes?

Yes. It's essential and necessary.

nayihz · 2023-02-24T11:39:15Z

Should we handle the case that a Pod has both the new and deprecated key?

If so, the new key first

Having implement this in function GetPodGroupLabel.

Should we add docs in README noticing the key changes?

Yes. It's essential and necessary.

Added a notice in pkg/coscheduling/README.md. Please let me know if it is not suitable

Huang-Wei · 2023-02-28T05:11:28Z

pkg/controllers/podgroup_controller.go

@@ -99,7 +99,20 @@ func (r *PodGroupReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
 		log.Error(err, "List pods for group failed")
 		return ctrl.Result{}, err
 	}
-	pods := podList.Items
+	pods := podList.DeepCopy().Items
+	// also list pods by the deprecated key for compatibility.


we don't need to actually, given the version is alpha.

Also I'm planning to standardize the group name (to x-k8s.io #525 ) in this release. So it's a breaking change anyway.

@denkensk WDYT?

Huang-Wei · 2023-02-28T06:45:57Z

pkg/coscheduling/README.md

@@ -15,8 +15,9 @@ This folder holds the coscheduling plugin implementations based on [Coscheduling
 ## Tutorial

 ### PodGroup
+>❗We have changed this label from `pod-group.scheduling.sigs.k8s.io` to `scheduling.sigs.k8s.io/pod-group` in new version.


Once #526 gets merged, update it to scheduling.x-k8s.io/pod-group

Huang-Wei

LGTM. Just a nit.

Huang-Wei · 2023-03-01T22:28:23Z

pkg/controllers/podgroup_test.go

@@ -281,7 +281,6 @@ func setUp(ctx context.Context,
 	objs := []runtime.Object{pg}
 	if len(podNames) != 0 {
 		ps := makePods(podNames, pgName, podPhase, podOwnerReference)
-		// s.AddKnownTypes(clientgoscheme.SchemeGroupVersion, ps)


remove this.

This comment had been removed.

It's still there :)

Am I misunderstanding you? This line had been remove in this pr already.
Did you mean remove this line or uncomment this line?

Ah my bad... somehow I always perceived this line was newly introduced...

Huang-Wei · 2023-03-03T05:30:14Z

/lgtm
/approve

Thanks @czybjtu !

k8s-ci-robot · 2023-03-03T05:30:22Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: czybjtu, Huang-Wei

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~~ [Huang-Wei]

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

nayihz · 2023-03-03T05:51:06Z

/retest

k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. 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 Feb 21, 2023

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Feb 21, 2023

k8s-ci-robot requested review from seanmalloy and yuanchen8911 February 21, 2023 11:36

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 21, 2023

zwpaper suggested changes Feb 23, 2023

View reviewed changes

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Feb 23, 2023

nayihz force-pushed the feat_podgroup_label branch from e239aa1 to b530534 Compare February 24, 2023 11:39

Huang-Wei reviewed Feb 28, 2023

View reviewed changes

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

nayihz force-pushed the feat_podgroup_label branch from b530534 to 068ba00 Compare March 1, 2023 07:13

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

feat: update PodGroup label key

23e980c

nayihz force-pushed the feat_podgroup_label branch from 068ba00 to 23e980c Compare March 1, 2023 07:31

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 1, 2023

nayihz requested review from Huang-Wei and removed request for seanmalloy and yuanchen8911 March 1, 2023 13:43

Huang-Wei reviewed Mar 1, 2023

View reviewed changes

k8s-ci-robot assigned Huang-Wei Mar 3, 2023

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

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

zwpaper mentioned this pull request Mar 3, 2023

REQUEST: New membership for zwpaper kubernetes/org#4061

Closed

9 tasks

k8s-ci-robot merged commit 95751be into kubernetes-sigs:master Mar 3, 2023

nayihz deleted the feat_podgroup_label branch March 3, 2023 07:30

tenzen-y mentioned this pull request Mar 3, 2023

Support coscheduling plugin kubeflow/mpi-operator#500

Closed

2 tasks

nayihz mentioned this pull request Apr 10, 2023

REQUEST: New membership for czybjtu kubernetes/org#4154

Closed

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: update PodGroup label key #521

feat: update PodGroup label key #521

nayihz commented Feb 21, 2023 •

edited

Loading

k8s-ci-robot commented Feb 21, 2023

k8s-ci-robot commented Feb 21, 2023

nayihz commented Feb 22, 2023

zwpaper left a comment

zwpaper Feb 23, 2023

zwpaper Feb 23, 2023

zwpaper Feb 23, 2023

denkensk commented Feb 23, 2023

denkensk commented Feb 23, 2023

nayihz commented Feb 24, 2023

Huang-Wei Feb 28, 2023 •

edited

Loading

nayihz Mar 1, 2023

Huang-Wei Feb 28, 2023

Huang-Wei left a comment

Huang-Wei Mar 1, 2023

nayihz Mar 2, 2023

Huang-Wei Mar 2, 2023

nayihz Mar 3, 2023

Huang-Wei Mar 3, 2023

Huang-Wei commented Mar 3, 2023

k8s-ci-robot commented Mar 3, 2023

nayihz commented Mar 3, 2023

	// GetPodGroupLabel get pod group name from pod annotations
	// GetPodGroupLabel get pod group name from pod labels

	// use deprecated label key if cannot list pod by new label.
	// also list pods by the deprecated key for compatibility

feat: update PodGroup label key #521

feat: update PodGroup label key #521

Conversation

nayihz commented Feb 21, 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:

Does this PR introduce a user-facing change?

k8s-ci-robot commented Feb 21, 2023

k8s-ci-robot commented Feb 21, 2023

nayihz commented Feb 22, 2023

zwpaper left a 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

denkensk commented Feb 23, 2023

denkensk commented Feb 23, 2023

nayihz commented Feb 24, 2023

Huang-Wei Feb 28, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Huang-Wei left a 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

Choose a reason for hiding this comment

Huang-Wei commented Mar 3, 2023

k8s-ci-robot commented Mar 3, 2023

nayihz commented Mar 3, 2023

nayihz commented Feb 21, 2023 •

edited

Loading

Huang-Wei Feb 28, 2023 •

edited

Loading