Skip to content

Commit

Permalink
doc : Update documentation to update annotation prefix to `jkube.ecli…
Browse files Browse the repository at this point in the history
…pse.org`

+ Mark `jkube.io/` annotations as Deprecated
+ Add `jkube.eclipse.org/` prefixed annotations to list of annotations
+ Add documentation for new ResourceConfig's field `useOldJKubePrefix`

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
  • Loading branch information
rohanKanojia authored and manusa committed Feb 23, 2023
1 parent 277cd36 commit fed7f07
Show file tree
Hide file tree
Showing 6 changed files with 70 additions and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Defaults to project description.

| *icon*
| The Chart URL to an SVG or PNG image to be used as an icon, default is extracted from the kubernetes manifest
(`kubernetes.yml`) `jkube.io/iconUrl` annotation if not provided.
(`kubernetes.yml`) `jkube.eclipse.org/iconUrl` annotation if not provided.
| `jkube.helm.icon`

| *keywords*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,25 @@ The following annotations will be added to the objects that support these annota
[cols="2,2,3"]
|===
| Maven Issue Tracker Info | Annotation | Description
| issueManagement/system
| jkube.eclipse.org/issue-system
| The Issue Management system like Bugzilla, JIRA, GitHub etc.,

| issueManagement/url
| jkube.eclipse.org/issue-tracker-url
| The Issue Management url e.g. GitHub Issues Url

| issueManagement/system
| jkube.io/issue-system
| The Issue Management system like Bugzilla, JIRA, GitHub etc.,
| _Deprecated: Use `jkube.eclipse.org/` annotation prefix._

The Issue Management system like Bugzilla, JIRA, GitHub etc.,

| issueManagement/url
| jkube.io/issue-tracker-url
| The Issue Management url e.g. GitHub Issues Url
| _Deprecated: Use `jkube.eclipse.org/` annotation prefix._

The Issue Management url e.g. GitHub Issues Url

|===

Expand All @@ -42,7 +53,7 @@ This information will be enriched as annotations in the generated manifest like,
kind: Service
metadata:
annotations:
jkube.io/issue-system: "GitHub"
jkube.io/issue-tracker-url: "https://github.com/reactiverse/vertx-maven-plugin/issues/"
jkube.eclipse.org/issue-system: "GitHub"
jkube.eclipse.org/issue-tracker-url: "https://github.com/reactiverse/vertx-maven-plugin/issues/"
# ...
----
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,45 @@ The following annotations will be added to the objects that supports annotations
| Maven SCM Info | Annotation | Description

| scm/connection
| jkube.io/scm-con-url
| jkube.eclipse.org/scm-con-url
| The SCM connection that will be used to connect to the project's SCM

| scm/developerConnection
| jkube.io/scm-devcon-url
| jkube.eclipse.org/scm-devcon-url
| The SCM Developer Connection that will be used to connect to the project's developer SCM

| scm/tag
| jkube.io/scm-tag
| jkube.eclipse.org/scm-tag
| The SCM tag that will be used to checkout the sources, like HEAD dev-branch etc.,

| scm/url
| jkube.io/scm-url
| jkube.eclipse.org/scm-url
| The SCM web url that can be used to browse the SCM over web browser

| scm/connection
| jkube.io/scm-con-url
| _Deprecated: Use `jkube.eclipse.org/` annotation prefix._

The SCM connection that will be used to connect to the project's SCM

| scm/developerConnection
| jkube.io/scm-devcon-url
| _Deprecated: Use `jkube.eclipse.org/` annotation prefix._

The SCM Developer Connection that will be used to connect to the project's developer SCM

| scm/tag
| jkube.io/scm-tag
| _Deprecated: Use `jkube.eclipse.org/` annotation prefix._

The SCM tag that will be used to checkout the sources, like HEAD dev-branch etc.,

| scm/url
| jkube.io/scm-url
| _Deprecated: Use `jkube.eclipse.org/` annotation prefix._

The SCM web url that can be used to browse the SCM over web browser

|===

Lets say you have a maven pom.xml with the following scm information,
Expand All @@ -47,10 +71,10 @@ This information will be enriched as annotations in the generated manifest like,
# ...
kind: Service
metadata:
annotations
jkube.io/scm-con-url: "scm:git:git://github.com/jkubeio/kubernetes-maven-plugin.git"
jkube.io/scm-devcon-url: "scm:git:git://github.com/jkubeio/kubernetes-maven-plugin.git"
jkube.io/scm-tag: "HEAD"
jkube.io/scm-url: "git://github.com/jkubeio/kubernetes-maven-plugin.git"
annotations:
jkube.eclipse.org/scm-con-url: "scm:git:git://github.com/jkubeio/kubernetes-maven-plugin.git"
jkube.eclipse.org/scm-devcon-url: "scm:git:git://github.com/jkubeio/kubernetes-maven-plugin.git"
jkube.eclipse.org/scm-tag: "HEAD"
jkube.eclipse.org/scm-url: "git://github.com/jkubeio/kubernetes-maven-plugin.git"
# ...
----
20 changes: 17 additions & 3 deletions jkube-kit/doc/src/main/asciidoc/inc/enricher/git/_jkube_git.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,29 @@ Enricher that adds info from `.git` directory as annotations. These are explaine
[cols="1,1"]
|===
| Annotation | Description
| `jkube.eclipse.org/git-branch`
| Current Git Branch

| `jkube.eclipse.org/git-commit`
| Latest commit of current branch

| `jkube.eclipse.org/git-url`
| URL of your configured git remote

| `jkube.io/git-branch`
| Current Git Branch
| _Deprecated: Use `jkube.eclipse.org/` annotation prefix._

Current Git Branch

| `jkube.io/git-commit`
| Latest commit of current branch
| _Deprecated: Use `jkube.eclipse.org/` annotation prefix._

Latest commit of current branch

| `jkube.io/git-url`
| URL of your configured git remote
| _Deprecated: Use `jkube.eclipse.org/` annotation prefix._

URL of your configured git remote

ifeval::["{goal-prefix}" == "oc"]
include::openshift-annotations/_openshift_annotations.adoc[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ endif::[]

| `serviceAccount`
| ServiceAccount name which will be used by pods created by controller resources(e.g. `Deployment`, `ReplicaSet` etc)

| `useLegacyJKubePrefix`
| Use old `jkube.io/` annotation prefix instead of `jkube.eclipse.org/` annotation prefix
|===

[[generated-controller-resource-configuration]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ This configuration section knows the following sub-elements in order to configur

| *icon*
| The Chart URL to an SVG or PNG image to be used as an icon, default is extracted from the kubernetes manifest
(`kubernetes.yml`) `jkube.io/iconUrl` annotation if not provided.
(`kubernetes.yml`) `jkube.eclipse.org/iconUrl` annotation if not provided.
| `jkube.helm.icon`

| *keywords*
Expand Down

0 comments on commit fed7f07

Please sign in to comment.