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.

Sign up for GitHub

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

Jump to bottom

Deprecate / Remove jkube.io annotation prefix from JKubeAnnotations #1273

Closed
rohanKanojia opened this issue Feb 8, 2022 · 7 comments · Fixed by #1995
Closed

Deprecate / Remove jkube.io annotation prefix from JKubeAnnotations #1273

rohanKanojia opened this issue Feb 8, 2022 · 7 comments · Fixed by #1995
Assignees
@rohanKanojia
Labels
technical-debt
Milestone
1.12.0

Comments

@rohanKanojia
Copy link
Member

Description

While working on #1237 , I noticed that we generated some opinionated annotations which are prefixed by jkube.io. For example:

- apiVersion: apps/v1
  kind: Deployment
  metadata:
    annotations:
      jkube.io/scm-url: https://github.com/spring-projects/spring-boot/random-generator
      jkube.io/git-url: git@github.com:rohanKanojia/eclipse-jkube-demo-project.git
      jkube.io/scm-tag: HEAD
      jkube.io/git-commit: 40b69fc860db02bcbd02dc31e27791b48ccdd4dd
      jkube.io/git-branch: master

This reminded me of #1245 . This also could be side effect of s/fabric8/jkube. Since jkube.io is an unreachable address; Does it make sense to replace prefix with something else (eclipse.org/jkube or jkube.eclipse.org)? It seems to be coming from here:
https://github.com/eclipse/jkube/blob/0957e212de6ce6d9da5dd6aefa6c58d00a8ac853/jkube-kit/config/resource/src/main/java/org/eclipse/jkube/kit/config/resource/JKubeAnnotations.java#L46

I don't think we use these annotations internally as input from users like in the case of #1245 .
@rohanKanojia rohanKanojia changed the title Deprecate jkube.io annotation prefix Deprecate / Remove jkube.io annotation prefix from JKubeAnnotations Feb 8, 2022
@manusa manusa modified the milestone: 2.0.0 Feb 21, 2022
@manusa
Copy link
Member

manusa commented Feb 21, 2022

All annotations, or fields that use the jkube.io should be replaced to jkube.eclipse.org.

If we want to implement this for 1.x, we should provide at least a workaround to configure the former prefix in case users are relying on these values.

@anurag-rajawat
Copy link
Contributor

@rohanKanojia may I work on this?

@rohanKanojia
Copy link
Member Author

@anurag-rajawat : I'm sorry I didn't see your comment. I created it as a follow-up task for something I did in the past.

Would you like to work on more complicated issues?

@anurag-rajawat
Copy link
Contributor

yes @rohanKanojia

@anurag-rajawat
Copy link
Contributor

@rohanKanojia how do you want to proceed with this?
By removing or deprecating the annotation.

@rohanKanojia
Copy link
Member Author

Let me take care of this issue.

Do you think you can pick up #1954 ?

@rohanKanojia rohanKanojia self-assigned this Jan 9, 2023
@anurag-rajawat
Copy link
Contributor

Do you think you can pick up #1954 ?

I'm not sure but I can try.

rohanKanojia added a commit to rohanKanojia/jkube that referenced this issue Jan 9, 2023
@rohanKanojia
refactor (jkube-kit/config/resource) : Deprecate jkube.io annotatio…
eb8520c 
…n prefix for JKubeAnnotations (eclipse-jkube#1273)

+ Deprecate `jkube.io` annotation prefix in favor of `jkube.eclipse.org`
+ Add `jkube.useDeprecatedAnnotations` flag to switch to `jkube.io`
  annotation prefix in case any user is interested in this.

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
rohanKanojia added a commit to rohanKanojia/jkube that referenced this issue Jan 10, 2023
@rohanKanojia
refactor (jkube-kit/config/resource) : Deprecate jkube.io annotatio…
3be8092 
…n prefix for JKubeAnnotations (eclipse-jkube#1273)

+ Deprecate `jkube.io` annotation prefix in favor of `jkube.eclipse.org`
+ Add `jkube.useOldJKubePrefix` flag to switch to `jkube.io`
  annotation prefix in case any user is interested in this.

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
rohanKanojia added a commit to rohanKanojia/jkube that referenced this issue Jan 10, 2023
@rohanKanojia
refactor (jkube-kit/config/resource) : Deprecate jkube.io annotatio…
dcdbb82 
…n prefix for JKubeAnnotations (eclipse-jkube#1273)

+ Deprecate `jkube.io` annotation prefix in favor of `jkube.eclipse.org`
+ Add `jkube.useOldJKubePrefix` flag to switch to `jkube.io`
  annotation prefix in case any user is interested in this.

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
rohanKanojia added a commit to rohanKanojia/jkube that referenced this issue Jan 10, 2023
@rohanKanojia
refactor (jkube-kit/config/resource) : Deprecate jkube.io annotatio…
42a7952 
…n prefix in favor of `jkube.eclipse.org` for JKubeAnnotations (eclipse-jkube#1273)

+ Deprecate `jkube.io` annotation prefix in favor of `jkube.eclipse.org`
+ Add `jkube.useOldJKubePrefix` flag to switch to `jkube.io`
  annotation prefix in case any user is interested in this.

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
@rohanKanojia rohanKanojia mentioned this issue Jan 10, 2023
Merged
17 tasks
rohanKanojia added a commit to rohanKanojia/jkube that referenced this issue Jan 12, 2023
@rohanKanojia
refactor (jkube-kit/config/resource) : Deprecate jkube.io annotatio…
9e486ca 
…n prefix in favor of `jkube.eclipse.org` for JKubeAnnotations (eclipse-jkube#1273)

+ Deprecate `jkube.io` annotation prefix in favor of `jkube.eclipse.org`
+ Add `jkube.useOldJKubePrefix` flag to switch to `jkube.io`
  annotation prefix in case any user is interested in this.

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
rohanKanojia added a commit to rohanKanojia/jkube that referenced this issue Jan 30, 2023
@rohanKanojia
refactor (jkube-kit/config/resource) : Deprecate jkube.io annotatio…
5588b14 
…n prefix in favor of `jkube.eclipse.org` for JKubeAnnotations (eclipse-jkube#1273)

+ Deprecate `jkube.io` annotation prefix in favor of `jkube.eclipse.org`
+ Add `jkube.useOldJKubePrefix` flag to switch to `jkube.io`
  annotation prefix in case any user is interested in this.

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
rohanKanojia added a commit to rohanKanojia/jkube that referenced this issue Feb 14, 2023
@rohanKanojia
refactor (jkube-kit/config/resource) : Deprecate jkube.io annotatio…
373c9dd 
…n prefix in favor of `jkube.eclipse.org` for JKubeAnnotations (eclipse-jkube#1273)

+ Deprecate `jkube.io` annotation prefix in favor of `jkube.eclipse.org`
+ Add `jkube.useOldJKubePrefix` flag to switch to `jkube.io`
  annotation prefix in case any user is interested in this.

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
rohanKanojia added a commit to rohanKanojia/jkube that referenced this issue Feb 15, 2023
@rohanKanojia
refactor (jkube-kit/config/resource) : Deprecate jkube.io annotatio…
c25fbbc 
…n prefix in favor of `jkube.eclipse.org` for JKubeAnnotations (eclipse-jkube#1273)

+ Deprecate `jkube.io` annotation prefix in favor of `jkube.eclipse.org`
+ Add `jkube.useOldJKubePrefix` flag to switch to `jkube.io`
  annotation prefix in case any user is interested in this.

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
rohanKanojia added a commit to rohanKanojia/jkube that referenced this issue Feb 16, 2023
@rohanKanojia
refactor (jkube-kit/config/resource) : Deprecate jkube.io annotatio…
048ac43 
…n prefix in favor of `jkube.eclipse.org` for JKubeAnnotations (eclipse-jkube#1273)

+ Deprecate `jkube.io` annotation prefix in favor of `jkube.eclipse.org`
+ Add `jkube.useOldJKubePrefix` flag to switch to `jkube.io`
  annotation prefix in case any user is interested in this.

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
rohanKanojia added a commit to rohanKanojia/jkube that referenced this issue Feb 21, 2023
@rohanKanojia
refactor (jkube-kit/config/resource) : Deprecate jkube.io annotatio…
b76c69e 
…n prefix in favor of `jkube.eclipse.org` for JKubeAnnotations (eclipse-jkube#1273)

+ Deprecate `jkube.io` annotation prefix in favor of `jkube.eclipse.org`
+ Add `jkube.useOldJKubePrefix` flag to switch to `jkube.io`
  annotation prefix in case any user is interested in this.

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
rohanKanojia added a commit to rohanKanojia/jkube that referenced this issue Feb 23, 2023
@rohanKanojia
refactor (jkube-kit/config/resource) : Deprecate jkube.io annotatio…
a8c428e 
…n prefix in favor of `jkube.eclipse.org` for JKubeAnnotations (eclipse-jkube#1273)

+ Deprecate `jkube.io` annotation prefix in favor of `jkube.eclipse.org`
+ Add `jkube.useOldJKubePrefix` flag to switch to `jkube.io`
  annotation prefix in case any user is interested in this.

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
@rohanKanojia rohanKanojia mentioned this issue Feb 23, 2023
Open
3 tasks
rohanKanojia added a commit to rohanKanojia/jkube that referenced this issue Feb 23, 2023
@rohanKanojia
refactor (jkube-kit/config/resource) : Deprecate jkube.io annotatio…
3b58294 
…n prefix in favor of `jkube.eclipse.org` for JKubeAnnotations (eclipse-jkube#1273)

+ Deprecate `jkube.io` annotation prefix in favor of `jkube.eclipse.org`
+ Add `jkube.useOldJKubePrefix` flag to switch to `jkube.io`
  annotation prefix in case any user is interested in this.

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
@manusa manusa added this to the 1.12.0 milestone Feb 23, 2023
manusa pushed a commit that referenced this issue Feb 23, 2023
@rohanKanojia @manusa
refactor (jkube-kit/config/resource) : Deprecate jkube.io annotatio…
ba95fb2 
…n prefix in favor of `jkube.eclipse.org` for JKubeAnnotations (#1273)

+ Deprecate `jkube.io` annotation prefix in favor of `jkube.eclipse.org`
+ Add `jkube.useOldJKubePrefix` flag to switch to `jkube.io`
  annotation prefix in case any user is interested in this.

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rohanKanojia rohanKanojia

Labels
technical-debt
Projects
None yet
Milestone
1.12.0
3 participants
@manusa @rohanKanojia @anurag-rajawat