Jkube: Can't seem to override the use of project.artifactId as the application reference in the deployment descriptor

Created on 2 Jul 2020  路  24Comments  路  Source: eclipse/jkube

Description

_This is likely just a configuration issue, but can't figure it out. Hence this ticket._

As part of our build we would like to control the application reference use across the different files generated from the resource goal.
Here's an example:

spec:
    ports:
    - name: http
      port: 8080
      protocol: TCP
      targetPort: 8080
    selector:
      app: greetings-api
      provider: jkube
      group: dk.something.someting.rest

The plugin doesn't seem to let us control the spec:selector:app reference - at least I can't figure out how. This defaults to the project.artifactId. This makes sense,, but we would like to have it a difference value, in order for us to deploy our application in different version; within the same namespace (running on OpenShift). Any way we could add the version or some other property to this string?
What happens now is that we get different applications deployed, but they seem to share their individual services and routes between them. Which isn't what we are looking for.

So how can we control the value ending up in the .yaml files under spec:selector:app?

Info

  • Eclipse JKube version: 1.0.0-alpha-4
  • Maven version (mvn -v) :
Apache Maven 3.6.0
Maven home: /usr/share/maven
Java version: 11.0.7, vendor: Ubuntu, runtime: /usr/lib/jvm/java-11-openjdk-amd64
Default locale: en, platform encoding: UTF-8
OS name: "linux", version: "4.4.0-17763-microsoft", arch: "amd64", family: "unix"
  • Kubernetes / Red Hat OpenShift setup and version:
OpenShift Master:
    v3.11.216 
Kubernetes Master:
    v1.11.0+d4cacc0
enhancement
Source
picture TueDissingWork

All 24 comments

Looks like ProjectLabelEnricher which is responsible for adding these selector doesn't support customizing them in the configuration:

https://github.com/eclipse/jkube/blob/d8b763722c64fe09e1738da1825bab00df7ab228/jkube-kit/enricher/generic/src/main/java/org/eclipse/jkube/enricher/generic/ProjectLabelEnricher.java#L159-L165

I think we should add some more configuration options in enricher config which can be used to customize generated selector labels:

https://github.com/eclipse/jkube/blob/d8b763722c64fe09e1738da1825bab00df7ab228/jkube-kit/enricher/generic/src/main/java/org/eclipse/jkube/enricher/generic/ProjectLabelEnricher.java#L55-L62

rohanKanojia picture rohanKanojia on 2 Jul 2020

N

Looks like ProjectLabelEnricher which is responsible for adding these selector doesn't support customizing them in the configuration:

https://github.com/eclipse/jkube/blob/d8b763722c64fe09e1738da1825bab00df7ab228/jkube-kit/enricher/generic/src/main/java/org/eclipse/jkube/enricher/generic/ProjectLabelEnricher.java#L159-L165

I think we should add some more configuration options in enricher config which can be used to customize generated selector labels:

https://github.com/eclipse/jkube/blob/d8b763722c64fe09e1738da1825bab00df7ab228/jkube-kit/enricher/generic/src/main/java/org/eclipse/jkube/enricher/generic/ProjectLabelEnricher.java#L55-L62

Nice rohanKanojia. That explains why it doesn't work for me :-)

TueDissingWork picture TueDissingWork on 2 Jul 2020

@TueDissingWork : Would you like to submit a PR to add options in Config if you have some time?

rohanKanojia picture rohanKanojia on 2 Jul 2020

@rohanKanojia Sure. Why not, but it will not be in the foreseeable future, as vacation time hits now.

TueDissingWork picture TueDissingWork on 2 Jul 2020

np, We would take this up in coming sprint

rohanKanojia picture rohanKanojia on 2 Jul 2020
👍1

Blocked by #248

manusa picture manusa on 13 Jul 2020

just merged back all changes from master, and now I can't bulid the project.
I am met with the following problems: 

[INFO] --- maven-enforcer-plugin:1.4.1:enforce (dependency-convergence) @ jkube-kit-common-maven ---
[WARNING]
Dependency convergence error for org.apache.maven:maven-model:3.0 paths to dependency are:
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-archiver:3.2.0
    +-org.apache.maven:maven-model:3.0
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-core:3.5.4
    +-org.apache.maven:maven-model:3.5.4
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-core:3.5.4
    +-org.apache.maven:maven-plugin-api:3.5.4
      +-org.apache.maven:maven-model:3.5.4
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-core:3.5.4
    +-org.apache.maven:maven-model-builder:3.5.4
      +-org.apache.maven:maven-model:3.5.4
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-core:3.5.4
    +-org.apache.maven:maven-resolver-provider:3.5.4
      +-org.apache.maven:maven-model:3.5.4

[WARNING]
Dependency convergence error for org.apache.maven:maven-artifact:3.0 paths to dependency are:
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-archiver:3.2.0
    +-org.apache.maven:maven-artifact:3.0
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-core:3.5.4
    +-org.apache.maven:maven-artifact:3.5.4
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-core:3.5.4
    +-org.apache.maven:maven-plugin-api:3.5.4
      +-org.apache.maven:maven-artifact:3.5.4
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-core:3.5.4
    +-org.apache.maven:maven-model-builder:3.5.4
      +-org.apache.maven:maven-artifact:3.5.4
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven.plugin-tools:maven-plugin-annotations:3.6.0
    +-org.apache.maven:maven-artifact:3.0

[WARNING]
Dependency convergence error for org.codehaus.plexus:plexus-interpolation:1.22 paths to dependency are:
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-archiver:3.2.0
    +-org.codehaus.plexus:plexus-interpolation:1.22
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-core:3.5.4
    +-org.apache.maven:maven-settings-builder:3.5.4
      +-org.codehaus.plexus:plexus-interpolation:1.24
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-core:3.5.4
    +-org.apache.maven:maven-model-builder:3.5.4
      +-org.codehaus.plexus:plexus-interpolation:1.24
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven.shared:maven-filtering:3.1.1
    +-org.codehaus.plexus:plexus-interpolation:1.22

[WARNING]
Dependency convergence error for org.apache.maven.shared:maven-shared-utils:3.2.0 paths to dependency are:
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-archiver:3.2.0
    +-org.apache.maven.shared:maven-shared-utils:3.2.0
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-core:3.5.4
    +-org.apache.maven.shared:maven-shared-utils:3.2.1
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven.shared:maven-filtering:3.1.1
    +-org.apache.maven.shared:maven-shared-utils:3.0.0

[WARNING] Rule 0: org.apache.maven.plugins.enforcer.DependencyConvergence failed with message:
Failed while enforcing releasability the error(s) are [
Dependency convergence error for org.apache.maven:maven-model:3.0 paths to dependency are:
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-archiver:3.2.0
    +-org.apache.maven:maven-model:3.0
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-core:3.5.4
    +-org.apache.maven:maven-model:3.5.4
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-core:3.5.4
    +-org.apache.maven:maven-plugin-api:3.5.4
      +-org.apache.maven:maven-model:3.5.4
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-core:3.5.4
    +-org.apache.maven:maven-model-builder:3.5.4
      +-org.apache.maven:maven-model:3.5.4
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-core:3.5.4
    +-org.apache.maven:maven-resolver-provider:3.5.4
      +-org.apache.maven:maven-model:3.5.4
,
Dependency convergence error for org.apache.maven:maven-artifact:3.0 paths to dependency are:
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-archiver:3.2.0
    +-org.apache.maven:maven-artifact:3.0
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-core:3.5.4
    +-org.apache.maven:maven-artifact:3.5.4
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-core:3.5.4
    +-org.apache.maven:maven-plugin-api:3.5.4
      +-org.apache.maven:maven-artifact:3.5.4
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-core:3.5.4
    +-org.apache.maven:maven-model-builder:3.5.4
      +-org.apache.maven:maven-artifact:3.5.4
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven.plugin-tools:maven-plugin-annotations:3.6.0
    +-org.apache.maven:maven-artifact:3.0
,
Dependency convergence error for org.codehaus.plexus:plexus-interpolation:1.22 paths to dependency are:
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-archiver:3.2.0
    +-org.codehaus.plexus:plexus-interpolation:1.22
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-core:3.5.4
    +-org.apache.maven:maven-settings-builder:3.5.4
      +-org.codehaus.plexus:plexus-interpolation:1.24
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-core:3.5.4
    +-org.apache.maven:maven-model-builder:3.5.4
      +-org.codehaus.plexus:plexus-interpolation:1.24
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven.shared:maven-filtering:3.1.1
    +-org.codehaus.plexus:plexus-interpolation:1.22
,
Dependency convergence error for org.apache.maven.shared:maven-shared-utils:3.2.0 paths to dependency are:
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-archiver:3.2.0
    +-org.apache.maven.shared:maven-shared-utils:3.2.0
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven:maven-core:3.5.4
    +-org.apache.maven.shared:maven-shared-utils:3.2.1
and
+-org.eclipse.jkube:jkube-kit-common-maven:1.0.0-SNAPSHOT
  +-org.apache.maven.shared:maven-filtering:3.1.1
    +-org.apache.maven.shared:maven-shared-utils:3.0.0

Any advise on how to move past these checkers?

TueDissingWork picture TueDissingWork on 27 Jul 2020

Compare your pom files with the master branch to see diffs. It seems that some dependencies are colliding. Did your branch include any changes to pom.xml files?

manusa picture manusa on 27 Jul 2020

no changes to pom. manually skipping the enforcer for now. Will compare pom.
Thanks

TueDissingWork picture TueDissingWork on 27 Jul 2020

pom.xml are identical. Maybe a maven cache issue?

TueDissingWork picture TueDissingWork on 27 Jul 2020

That's really weird. Try with mvn -U... but it's really strange.
You are running mvn clean.... from the root directory, right?

manusa picture manusa on 27 Jul 2020

mvn -U clean install results in the above error.
[INFO] JKube Kit :: Common Maven .......................... FAILURE [ 3.618 s]

TueDissingWork picture TueDissingWork on 27 Jul 2020

Just performed a fresh checkout of master, but still can't build the project. Same error in Common Maven.
Running under WSL, but should not really matter.

TueDissingWork picture TueDissingWork on 27 Jul 2020

Since poms are configured to ignore snapshots since the 3rd of June, myabe something got there in the middle.
Could you try removing any JKube artifact from your .m2 (./org/eclipse/jkube/**/*) directory and recheck?

manusa picture manusa on 27 Jul 2020

Hhmmm, no difference either. I can work for now. Let's address this if its still a problem when I'm ready with some code. If others can build, then it must be something at my end.

TueDissingWork picture TueDissingWork on 27 Jul 2020

Can anyone point me to where I need to update the documentation, to make sure this new parameter gets documeted.
Have looked, but can't seem to find it.

TueDissingWork picture TueDissingWork on 27 Jul 2020

I think it's here:

https://github.com/eclipse/jkube/tree/master/kubernetes-maven-plugin/doc/src/main/asciidoc/inc

rohanKanojia picture rohanKanojia on 27 Jul 2020
👍1

I want to add some tests to the written code, but can't seem to figure out where the /jkube-kit-enricher-generic/src/main/java/org/eclipse/jkube/enricher/generic/ProjectLabelEnricher.java class is tested.
Found /jkube-kit-enricher-generic/src/test/java/org/eclipse/jkube/enricher/generic/MavenProjectEnricherTest.java, but that doesn't seem to test the project label part.

Is there a good example that I can look at?

TueDissingWork picture TueDissingWork on 28 Jul 2020

It appears that ProjectLabelEnricher doesn't have any test right now. You can have a look at tests for this package:

https://github.com/eclipse/jkube/tree/master/jkube-kit/enricher/generic/src/test/java/org/eclipse/jkube/enricher/generic

rohanKanojia picture rohanKanojia on 28 Jul 2020
👍1

OK. Thanks.

TueDissingWork picture TueDissingWork on 28 Jul 2020

So basically, you want to assert stuff inside .spec . I think you can provide a list of Deployment object and pass it to enricher as argument. Then you can assert the list returned and build Deployment using buildFirstItem() method, then assert generated Deployment object:

https://github.com/eclipse/jkube/blob/68ac53f4546610f05fbced4b75b49868a58556d7/jkube-kit/enricher/generic/src/test/java/org/eclipse/jkube/enricher/generic/openshift/DeploymentConfigEnricherTest.java#L50-L70

rohanKanojia picture rohanKanojia on 28 Jul 2020

So basically, you want to assert stuff inside .spec . I think you can provide a list of Deployment object and pass it to enricher as argument. Then you can assert the list returned and build Deployment using buildFirstItem() method, then assert generated Deployment object:

https://github.com/eclipse/jkube/blob/68ac53f4546610f05fbced4b75b49868a58556d7/jkube-kit/enricher/generic/src/test/java/org/eclipse/jkube/enricher/generic/openshift/DeploymentConfigEnricherTest.java#L50-L70

I found an example of the project label parameter, so it ended up being super simple.

I naturally forgot to sign off my commits :-( so now I'm fighting Git to let me change only my own commit messages.

TueDissingWork picture TueDissingWork on 28 Jul 2020

Maybe you could use git commit --amend ?

rohanKanojia picture rohanKanojia on 28 Jul 2020

Maybe you could use git commit --amend ?

Need to use git rebase...but yes the --amend option is nice.

TueDissingWork picture TueDissingWork on 28 Jul 2020
Was this page helpful?
0 / 5 - 0 ratings

Related issues

hlavki picture hlavki  路  6Comments
dzagagnoni picture dzagagnoni  路  8Comments
ohbus picture ohbus  路  4Comments
manusa picture manusa  路  5Comments
dcrissman picture dcrissman  路  6Comments