Add Admitted Workloads Field to LocalQueueStatus #382

kannon92 · 2022-09-07T22:03:29Z

What type of PR is this?

/kind api-change

What this PR does / why we need it:

Add AdmittedWorkloads to LocalQueueStatus API and update it in the LocalQueueController.

Which issue(s) this PR fixes:

Fixes #259

Special notes for your reviewer:

Sorry for the silliness with opening up multiple repos. I have my laptop setup with CLA and github commits but I committed from another instance. I didn't realize that if 1 commit doesn't have my email, it will fail the check.

k8s-ci-robot · 2022-09-07T22:03:37Z

Hi @kannon92. 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.

alculquicondor · 2022-09-08T18:27:24Z

/assign

apis/kueue/v1alpha2/localqueue_types.go

pkg/cache/cache.go

pkg/cache/cache_test.go

alculquicondor · 2022-09-08T19:45:14Z

pkg/controller/core/localqueue_controller.go

@@ -84,6 +84,13 @@ func (r *LocalQueueReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 	}

 	queueObj.Status.PendingWorkloads = pending
+	admitted, errAdmitted := r.cache.AdmittedWorkloadsLocalQueue(&queueObj)


Looks good, but this needs to be tested.

You can add checks to the existing integration tests in test/integration

Thank you! I was having some trouble running those on my setup.

I had some failures in unrelated code and some stuff to do with certs. I'll look more into it and add some tests in test/integration also.

Did you try make test-integration?

Yea, I'll try it again.

Alright. There is a regression caused by this code so I'll look into it, fix it and add some tests here.

I am unable to run make test-integration on my Mac M1. it says architecture not supported and then fails every test.

I get failures when I get a test failure but it seems to be caused by the controller test detecting an error.

@kannon92 Hi.
We will fix make test-integration for M1 Mac in #362. If you want to run test-integration on your local now, please check this comment.

@tenzen-y Thank you for that suggestion! Applied that fix locally and I was able to deduce where my test failure was. Pushed up a fix for that.

It looks like existing tests in the controller do verify status so I just added a new field for AdmittedWorkloads in the test. I think this is fine.

apis/kueue/v1alpha2/localqueue_types.go

pkg/cache/cache.go

pkg/cache/cache_test.go

alculquicondor · 2022-09-09T14:41:00Z

pkg/cache/cache_test.go

+				if diff := cmp.Diff(tc.wantQueueCounts[key], queueAdmitted); diff != "" {
+					t.Errorf("Wrong active workload counters for queues from AdmittedWorkloadsLocalQueue:\n%s", diff)
+				}


You can either do a single comparison after the loop ends, or you can add the key somewhere in the Error message. Otherwise we can't tell which queue counters didn't match

alculquicondor · 2022-09-09T14:41:19Z

Please fix the latest comment and squash

kerthcet · 2022-09-09T15:11:39Z

pkg/cache/cache.go

@@ -148,6 +148,17 @@ func (c *Cache) newClusterQueue(cq *kueue.ClusterQueue) (*ClusterQueue, error) {
 	return cqImpl, nil
 }

+func (c *Cache) AdmittedWorkloadsLocalQueue(localQueue *kueue.LocalQueue) int32 {


AdmittedWorkloadsInLocalQueue?

kerthcet · 2022-09-09T15:13:17Z

pkg/cache/cache.go

+	defer c.Unlock()
+	cq, ok := c.clusterQueues[string(localQueue.Spec.ClusterQueue)]
+	if !ok {
+		return 0


Maybe we should also return error here.

Actually, the ClusterQueue might be created after the LocalQueue.

During that time, there can't be any admitted workloads. So 0 is the right value.

Ah yes, that's the case. Another approach is

queueObj.Status.AdmittedWorkloads, _ = r.cache.AdmittedWorkloadsLocalQueue(&queueObj)

But remaining the same also makes sense to me.

if there are no cases of error, I would not add error to the return values

kerthcet · 2022-09-09T15:16:52Z

/ok-to-test

Update apis/kueue/v1alpha2/localqueue_types.go Co-authored-by: Aldo Culquicondor <1299064+alculquicondor@users.noreply.github.com> Update pkg/cache/cache.go Co-authored-by: Aldo Culquicondor <1299064+alculquicondor@users.noreply.github.com> Update pkg/cache/cache_test.go Co-authored-by: Aldo Culquicondor <1299064+alculquicondor@users.noreply.github.com> pr changes Updating localqueue_controller_test to refect AdmittedWorkload add Pending comment fix cache flattened use flattened map with just ns and name Change function name and cleanup test code

alculquicondor

/lgtm
/approve

k8s-ci-robot · 2022-09-09T17:30:19Z

[APPROVALNOTIFIER] This PR is APPROVED

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

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

k8s-ci-robot added the kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API label Sep 7, 2022

k8s-ci-robot requested review from ahg-g and alculquicondor September 7, 2022 22:03

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 7, 2022

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Sep 7, 2022

kannon92 mentioned this pull request Sep 8, 2022

Add number of AdmittedWorkloads to LocalQueue status #259

Closed

3 tasks

k8s-ci-robot assigned alculquicondor Sep 8, 2022

alculquicondor reviewed Sep 8, 2022

View reviewed changes

kannon92 requested review from alculquicondor and removed request for ahg-g September 8, 2022 21:33

alculquicondor reviewed Sep 8, 2022

View reviewed changes

apis/kueue/v1alpha2/localqueue_types.go Outdated Show resolved Hide resolved

pkg/cache/cache.go Outdated Show resolved Hide resolved

pkg/cache/cache_test.go Outdated Show resolved Hide resolved

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 8, 2022

kannon92 requested a review from alculquicondor September 9, 2022 13:13

alculquicondor reviewed Sep 9, 2022

View reviewed changes

pkg/cache/cache_test.go Outdated Show resolved Hide resolved

pkg/cache/cache_test.go Outdated Show resolved Hide resolved

alculquicondor reviewed Sep 9, 2022

View reviewed changes

kerthcet reviewed Sep 9, 2022

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 Sep 9, 2022

alculquicondor reviewed Sep 9, 2022

View reviewed changes

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

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 9, 2022

k8s-ci-robot merged commit b2e20c7 into kubernetes-sigs:main Sep 9, 2022

kannon92 mentioned this pull request Sep 20, 2022

Add AdmittedWorkloads of LocalQueue to additionalPrinterColumns for kubebuilder #404

Merged

kannon92 mentioned this pull request Nov 29, 2022

REQUEST: New membership for @kannon92 kubernetes/org#3861

Closed

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Admitted Workloads Field to LocalQueueStatus #382

Add Admitted Workloads Field to LocalQueueStatus #382

kannon92 commented Sep 7, 2022

k8s-ci-robot commented Sep 7, 2022

alculquicondor commented Sep 8, 2022

alculquicondor Sep 8, 2022

kannon92 Sep 8, 2022

alculquicondor Sep 8, 2022

kannon92 Sep 8, 2022

kannon92 Sep 8, 2022

tenzen-y Sep 8, 2022

kannon92 Sep 8, 2022

kannon92 Sep 9, 2022

alculquicondor Sep 9, 2022

alculquicondor commented Sep 9, 2022

kerthcet Sep 9, 2022

kerthcet Sep 9, 2022

alculquicondor Sep 9, 2022

kerthcet Sep 9, 2022

alculquicondor Sep 9, 2022

kerthcet commented Sep 9, 2022

alculquicondor left a comment

k8s-ci-robot commented Sep 9, 2022

Add Admitted Workloads Field to LocalQueueStatus #382

Add Admitted Workloads Field to LocalQueueStatus #382

Conversation

kannon92 commented Sep 7, 2022

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:

k8s-ci-robot commented Sep 7, 2022

alculquicondor commented Sep 8, 2022

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alculquicondor commented Sep 9, 2022

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

kerthcet commented Sep 9, 2022

alculquicondor left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Sep 9, 2022