search

kubernetes-sigs / kueue

Kubernetes-native Job Queueing
https://kueue.sigs.k8s.io
Apache License 2.0
1.35k stars 236 forks source link

Document labels/annotations that Kueue use in well-known labels/annotations #2858

Open kannon92 opened 1 month ago

kannon92 commented 1 month ago

It has came to my attention that kubernetes-sig related projects should publish their labels/annotations on the Kubernetes website.

We should document the labels/annotations that Kueue sets and publish them here.

This came up during a review of our blog post for JobSet (ref: https://github.com/kubernetes/website/issues/47373).

tenzen-y commented 1 month ago

/kind documentation

kannon92 commented 1 month ago

TBH I wanted to help with this one but I can't find labels/annotations that Kueue actually uses. Is there a single location where we have this?

tenzen-y commented 2 weeks ago

TBH I wanted to help with this one but I can't find labels/annotations that Kueue actually uses. Is there a single location where we have this?

Actually, we have some annotations and labels, but we did not summarize those. One things are here: https://github.com/kubernetes-sigs/kueue/blob/d4331979e09c7096f1f17426c9551476b3fe77fc/pkg/constants/constants.go

mimowo commented 2 weeks ago

+1 on the summary / list of those.

Actually, we have some annotations and labels, but we did not summarize those. One things are here: https://github.com/kubernetes-sigs/kueue/blob/d4331979e09c7096f1f17426c9551476b3fe77fc/pkg/constants/constants.go

This would be a good starting point. We may also add provreq.kueue.x-k8s.io/maxRunDurationSeconds which proves to be useful per https://github.com/kubernetes-sigs/kueue/issues/2802.

mbobrovskyi commented 2 days ago

@mimowo @tenzen-y I'm trying to summarize these, and here's what I've found:

Labels:

https://github.com/kubernetes-sigs/kueue/blob/d4331979e09c7096f1f17426c9551476b3fe77fc/pkg/constants/constants.go#L46-L47

https://github.com/kubernetes-sigs/kueue/blob/d4331979e09c7096f1f17426c9551476b3fe77fc/apis/kueue/v1alpha1/multikueue_types.go#L27-L29

https://github.com/kubernetes-sigs/kueue/blob/d4331979e09c7096f1f17426c9551476b3fe77fc/pkg/controller/constants/constants.go#L20-L21

https://github.com/kubernetes-sigs/kueue/blob/d4331979e09c7096f1f17426c9551476b3fe77fc/pkg/controller/constants/constants.go#L28-L29

https://github.com/kubernetes-sigs/kueue/blob/d4331979e09c7096f1f17426c9551476b3fe77fc/pkg/controller/constants/constants.go#L31-L33

https://github.com/kubernetes-sigs/kueue/blob/d4331979e09c7096f1f17426c9551476b3fe77fc/pkg/controller/constants/constants.go#L35-L38

https://github.com/kubernetes-sigs/kueue/blob/d4331979e09c7096f1f17426c9551476b3fe77fc/pkg/controller/jobs/pod/pod_webhook.go#L46

Annotations:

https://github.com/kubernetes-sigs/kueue/blob/d4331979e09c7096f1f17426c9551476b3fe77fc/pkg/controller/jobs/pod/pod_controller.go#L68

https://github.com/kubernetes-sigs/kueue/blob/d4331979e09c7096f1f17426c9551476b3fe77fc/pkg/controller/jobs/pod/pod_webhook.go#L47-L49

https://github.com/kubernetes-sigs/kueue/blob/d4331979e09c7096f1f17426c9551476b3fe77fc/pkg/controller/jobs/job/job_controller.go#L54-L56