Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(Kubernetes) labels not public #449

Open
sftim opened this issue Nov 15, 2024 · 1 comment · May be fixed by #452
Open

(Kubernetes) labels not public #449

sftim opened this issue Nov 15, 2024 · 1 comment · May be fixed by #452
Labels
bug Something isn't working

Comments

@sftim
Copy link

sftim commented Nov 15, 2024

Describe the bug

Sablier uses private labels (private because there is no / in the key). Example:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: whoami
  labels:
    app: whoami
    sablier.enable: "true"
    sablier.group: mygroup

Context

  • Sablier version: 1.8.1
  • Provider: any Kubernetes
  • Reverse proxy: not applicable
  • Sablier running inside a container? not relevant

Expected behavior
The label keys for Sablier are public; for example:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: whoami
  labels:
    app.kubernetes.io/name: whoami # also good practice, but not core to THIS issue
    sablierapp.dev/enable: "true"
    sablierapp.dev/group: mygroup

Using public label keys is good practice, helps people find the documentation a little more easily, and avoids conflicting with organizations' own policies and conventions for private labels.

Additional context
Typically when Kubernetes-compatible projects adopt the official label convention(s), they add support for the new way; then they deprecate the old way (using private label keys), but continue to support it for many releases. The documentation recommends the new-style, public label keys.

Read https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set for Kubernetes' documentation about public vs. private label keys.

@sftim sftim added the bug Something isn't working label Nov 15, 2024
@acouvreur
Copy link
Member

Hey @sftim ! Thanks for the feedback! I will add support for those labels! The previous one will still be available, but will be deprecated.

acouvreur added a commit that referenced this issue Nov 17, 2024
@acouvreur acouvreur linked a pull request Nov 17, 2024 that will close this issue
@acouvreur acouvreur linked a pull request Nov 17, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants