JobSet labels and annotations not registered / documented

[sftim]

This is a Bug Report

Problem:
The JobSet API and its controller use annotations that we haven't yet registered; see the description of kubernetes-sigs/jobset#639 for a list.

Proposed Solution:

• Register (ie, document) these annotations / labels

Page to Update:
https://kubernetes.io/docs/reference/labels-annotations-taints/

/sig apps
/language en

[Adarsh-verma-14]

/sig docs

[dipesh-rawat]

/priority backlog
/triage accepted

[Adarsh-verma-14]

I will try to add PR for this.

/assign

[alculquicondor]

@sftim why should these annotations and labels be added if they are not in the kubernetes.io domain?

I don't see any other mentions of labels in the x-k8s.io domain in https://kubernetes.io/docs/reference/labels-annotations-taints/

[sftim]

@sftim why should these annotations and labels be added if they are not in the kubernetes.io domain?

I don't see any other mentions of labels in the x-k8s.io domain in https://kubernetes.io/docs/reference/labels-annotations-taints/

The question doesn't really make sense. This issue is about registering labels / annotations such as

• jobset.sigs.k8s.io/jobset-name
• jobset.sigs.k8s.io/global-replicas

k8s.io is an official domain; see the first sentence of https://kubernetes.io/docs/reference/labels-annotations-taints/

However, x-k8s.io is not. JobSet can use labels and annotations in that domain as much as it likes without registering them. Although, I still encourage SIGs to register official labels / annotations. They are available at the low, low price of $0.

[alculquicondor]

Interesting. I didn't know jobset was using the k8s.io domain instead of x-k8s.io.

I thought there were some requirements to get to use that domain, like an official API review, but maybe I was thinking of API groups.

[tengqm]

My understanding is that they should have used x-k8s.io. We don't have any other documentation about JobSets on the website anyway.