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

Wrong information in the docs about run-sh and other io.fabric8 artifacts #1006

Closed
grgrzybek opened this issue Oct 13, 2021 · 4 comments · Fixed by #1525
Closed

Wrong information in the docs about run-sh and other io.fabric8 artifacts #1006

grgrzybek opened this issue Oct 13, 2021 · 4 comments · Fixed by #1525
Assignees
Labels
demoable Issues which can be demoed during the Sprint review meeting documentation Improvements or additions to documentation
Milestone

Comments

@grgrzybek
Copy link

Wrong information in the docs about run-sh and other io.fabric8 artifacts

Info

I was looking at:

and I believe these are the transitioned versions of https://dmp.fabric8.io/#maven-goals

For example in the fabric8's docker-maven-plugin there's:

Build Plugins

This plugin supports so call dmp-plugins which are used during the build phase. dmp-plugins are enabled by just declaring a dependency in the plugin declaration:

<plugin>
  <groupId>io.fabric8</groupId>
  <artifactId>docker-maven-plugin</artifactId>

  <dependencies>
    <dependency>
      <groupId>io.fabric8</groupId>
      <artifactId>run-java-sh</artifactId>
      <version>1.2.2</version>
    </dependency>
  </dependencies>
</plugin>

These plugins contain a descriptor META-INF/maven/io.fabric8/dmp-plugin with class names, line-by-line:

io.fabric8.runsh.RunShLoader

While in jkube docs there's simply:

Build Plugins

This plugin supports so call dmp-plugins which are used during the build phase. dmp-plugins are enabled by just declaring a dependency in the plugin declaration:

<plugin>
  <groupId>org.eclipse.jkube</groupId>
  <artifactId>kubernetes-maven-plugin</artifactId>

  <dependencies>
    <dependency>
      <groupId>org.eclipse.jkube</groupId>
      <artifactId>run-java-sh</artifactId>
      <version>1.2.2</version>
    </dependency>
  </dependencies>
</plugin>

org.eclipse.jkube.runsh.RunShLoader

while kubernetes-maven-plugin artifact was transitioned from io.fabric8 to org.eclipse.jkube groupId, it isn't the case with io.fabric8/run-java-sh GA and io.fabric8.runsh.RunShLoader class...

@manusa
Copy link
Member

manusa commented Oct 13, 2021

Some parts of the DMP documentation were ported regardless of the ported functionality when the project sources were partially merged. I'm not even sure that we support plugins any more.

@manusa manusa added the documentation Improvements or additions to documentation label Oct 13, 2021
@manusa manusa added this to the 1.6.0 milestone Oct 13, 2021
@manusa manusa added this to Backlog in Sprint #210 Nov 9, 2021
@manusa manusa modified the milestones: 1.6.0, 1.7.0 Jan 25, 2022
@manusa manusa modified the milestones: 1.7.0, 1.x Feb 25, 2022
@rohanKanojia rohanKanojia self-assigned this May 26, 2022
@rohanKanojia
Copy link
Member

rohanKanojia commented May 26, 2022

We do have functionality ported from dmp for this.

https://github.com/eclipse/jkube/blob/40added43dc6fbb180e2c79572628d0471be4195/kubernetes-maven-plugin/plugin/src/main/java/org/eclipse/jkube/maven/plugin/mojo/build/AbstractDockerMojo.java#L730-L735

We check for any class declared under META-INF/maven/io.fabric8/dmp-plugin and try to execute addExtraFiles method to extract extra files required for build in docker-extra directory.

However, DMP_PLUGIN_DESCRIPTOR constant is wrongly configured due to which this functionality doesn't work at the moment.

https://github.com/eclipse/jkube/blob/40added43dc6fbb180e2c79572628d0471be4195/kubernetes-maven-plugin/plugin/src/main/java/org/eclipse/jkube/maven/plugin/mojo/build/AbstractDockerMojo.java#L101

If I change it to META-INF/maven/io.fabric8/dmp-plugin, it works.

I'm able to get Run Java Sample in Docker Maven Plugin working by changing maven coordinates to org.eclipse.jkube:kubernetes-maven-plugin and tuning Dockerfile to add assembly name.

rohanKanojia added a commit to rohanKanojia/jkube that referenced this issue May 26, 2022
…8` artifacts (eclipse-jkube#1006)

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
rohanKanojia added a commit to rohanKanojia/jkube that referenced this issue May 27, 2022
…8` artifacts (eclipse-jkube#1006)

+ Fix outdated dmp plugin descriptor for build-plugins funtionality
+ Add Kit Quickstart for implementing custom build plugin
+ Update documentation for build plugins and point to quickstart

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
rohanKanojia added a commit to rohanKanojia/jkube that referenced this issue May 27, 2022
…8` artifacts (eclipse-jkube#1006)

+ Fix outdated dmp plugin descriptor for build-plugins funtionality
+ Add Kit Quickstart for implementing custom build plugin
+ Update documentation for build plugins and point to quickstart

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
rohanKanojia added a commit to rohanKanojia/jkube that referenced this issue Jun 20, 2022
…8` artifacts (eclipse-jkube#1006)

+ Fix outdated dmp plugin descriptor for build-plugins funtionality
+ Add Kit Quickstart for implementing custom build plugin
+ Update documentation for build plugins and point to quickstart

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
rohanKanojia added a commit to rohanKanojia/jkube that referenced this issue Jul 12, 2022
…8` artifacts (eclipse-jkube#1006)

+ Fix outdated dmp plugin descriptor for build-plugins funtionality
+ Add Kit Quickstart for implementing custom build plugin
+ Update documentation for build plugins and point to quickstart

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
manusa pushed a commit to rohanKanojia/jkube that referenced this issue Jul 14, 2022
…8` artifacts (eclipse-jkube#1006)

+ Fix outdated dmp plugin descriptor for build-plugins funtionality
+ Add Kit Quickstart for implementing custom build plugin
+ Update documentation for build plugins and point to quickstart

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
rohanKanojia added a commit to rohanKanojia/jkube that referenced this issue Jul 15, 2022
…8` artifacts (eclipse-jkube#1006)

+ Fix outdated dmp plugin descriptor for build-plugins funtionality
+ Add Kit Quickstart for implementing custom build plugin
+ Update documentation for build plugins and point to quickstart

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
rohanKanojia added a commit to rohanKanojia/jkube that referenced this issue Aug 19, 2022
…8` artifacts (eclipse-jkube#1006)

+ Fix outdated dmp plugin descriptor for build-plugins funtionality

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
rohanKanojia added a commit to rohanKanojia/jkube that referenced this issue Aug 19, 2022
…uild plugin (eclipse-jkube#1006)

Requires eclipse-jkube#1525 to be merged first.

Add Custom build Plugin quickstart for implementing custom build plugin.

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
rohanKanojia added a commit to rohanKanojia/jkube that referenced this issue Aug 19, 2022
…8` artifacts (eclipse-jkube#1006)

+ Fix outdated dmp plugin descriptor for build-plugins funtionality

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
@manusa manusa self-assigned this Aug 25, 2022
manusa pushed a commit to rohanKanojia/jkube that referenced this issue Aug 25, 2022
…8` artifacts (eclipse-jkube#1006)

+ Fix outdated dmp plugin descriptor for build-plugins funtionality

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
manusa pushed a commit that referenced this issue Aug 25, 2022
…8` artifacts (#1006)

+ Fix outdated dmp plugin descriptor for build-plugins funtionality

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
@manusa manusa reopened this Aug 25, 2022
rohanKanojia added a commit to rohanKanojia/jkube that referenced this issue Aug 25, 2022
…uild plugin (eclipse-jkube#1006)

Add Custom build Plugin quickstart for implementing custom build plugin.

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
manusa pushed a commit that referenced this issue Aug 29, 2022
…uild plugin (#1006)

Add Custom build Plugin quickstart for implementing custom build plugin.

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
@manusa manusa modified the milestones: 1.x, 1.9.0 Sep 21, 2022
@manusa
Copy link
Member

manusa commented Sep 21, 2022

Hi @grgrzybek
We have now properly ported the "plugin"/"extensible" functionality from DMP to JKube.

The documentation has been updated and is available at: 10. JKube Plugins

We've also implemented two quickstarts:

And a video showcasing the Maven quickstart example: https://youtu.be/pzLO-m1WyuU?t=34

@manusa
Copy link
Member

manusa commented Sep 21, 2022

I'm closing this issue as completed, please feel free to open a new one in case you feel there's still something missing.

@manusa manusa closed this as completed Sep 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
demoable Issues which can be demoed during the Sprint review meeting documentation Improvements or additions to documentation
Projects
None yet
3 participants