Introduce a new extension for generating Dockerfiles #42316

iocanel · 2024-08-05T12:54:08Z

Updates:

Applied feedback from gsmet
Replaced String.format with Qute.fmt
dockerfiles command now forces quarkus-dockerfiles as dependency

gsmet

This looks good over all, I spotted only micro issues.

Not sure who would have the time to test this one. @maxandersen do you have somebody in mind?

gsmet · 2024-08-08T07:37:59Z

extensions/dockerfiles/picocli/pom.xml

+<dependency>
+    <groupId>org.eclipse.aether</groupId>
+    <artifactId>aether-api</artifactId>
+    <version>1.1.0</version>
+</dependency>
+<dependency>
+    <groupId>org.eclipse.aether</groupId>
+    <artifactId>aether-impl</artifactId>
+    <version>1.1.0</version>
+</dependency>
+<dependency>
+    <groupId>org.eclipse.aether</groupId>
+    <artifactId>aether-spi</artifactId>
+    <version>1.1.0</version>
+</dependency>
+<dependency>
+    <groupId>org.eclipse.aether</groupId>
+    <artifactId>aether-connector-basic</artifactId>
+    <version>1.1.0</version>
+</dependency>
+<dependency>
+    <groupId>org.eclipse.aether</groupId>
+    <artifactId>aether-transport-file</artifactId>
+    <version>1.1.0</version>
+</dependency>
+<dependency>
+    <groupId>org.eclipse.aether</groupId>
+    <artifactId>aether-transport-http</artifactId>
+    <version>1.1.0</version>
+    <exclusions>
+        <exclusion>
+          <groupId>org.slf4j</groupId>
+          <artifactId>*</artifactId>
+        </exclusion>
+    </exclusions>
+</dependency>


The indentation is off here.

gsmet · 2024-08-08T07:41:06Z

...les/deployment/src/main/java/io/quarkus/dockerfiles/deployment/DockerfilesConfiguration.java

+    static final String DEFAULT_JVM_FROM = "registry.access.redhat.com/ubi8/openjdk-21:1.19";
+    static final String DEFAULT_NATIVE_FROM = "registry.access.redhat.com/ubi8/ubi-minimal:8.9";
+
+    /**
+     * The from image to use for JVM based Dockerfiles
+     */
+    @ConfigItem(defaultValue = "registry.access.redhat.com/ubi8/openjdk-21:1.19")
+    String jvmFrom;
+
+    /**
+     * The from image to use for native based Dockerfiles
+     */
+    @ConfigItem(defaultValue = "registry.access.redhat.com/ubi8/ubi-minimal:8.9")
+    String nativeFrom;


Not for this PR but we need to centralize all these images reference somewhere. We have them spread all over our code and it's a recipe for disaster.

I will create an issue about this so that we discuss it when @cescoffier is back.

gsmet · 2024-08-08T07:41:46Z

extensions/dockerfiles/runtime/src/main/resources/META-INF/quarkus-extension.yaml

+metadata:
+  keywords:
+  - "dockerfiles"
+  guide: "https://quarkus.io/guides/dockerfiles"


Please only reference a guide here when you have one or @holly-cummins will be unhappy :).

gsmet · 2024-08-08T07:42:37Z

extensions/dockerfiles/cli/pom.xml

+    <build>
+      <plugins>
+        <plugin>
+          <groupId>io.quarkus</groupId>
+          <artifactId>quarkus-maven-plugin</artifactId>
+          <executions>
+            <execution>
+              <goals>
+                <goal>build</goal>
+                <goal>generate-code</goal>
+                <goal>generate-code-tests</goal>
+              </goals>
+                <configuration>
+                  <skipOriginalJarRename>true</skipOriginalJarRename>
+                  <environmentVariables>
+                      <MAVEN_REPO_LOCAL>${settings.localRepository}</MAVEN_REPO_LOCAL>
+                      <GRADLE_OPTS>${env.MAVEN_OPTS}</GRADLE_OPTS>
+                  </environmentVariables>
+               </configuration>
+            </execution>
+          </executions>
+        </plugin>
+        <plugin>
+          <artifactId>maven-compiler-plugin</artifactId>
+          <configuration>
+            <compilerArgs>
+              <arg>-parameters</arg>
+            </compilerArgs>
+          </configuration>
+        </plugin>
+      </plugins>
+    </build>


Could you indent that part with 4 spaces too.

And yes, we need an XML formatter...

gsmet · 2024-08-09T08:15:53Z

Hey @iocanel . The feature freeze for 3.14 and 3.15 LTS is next Tuesday so we should really try to finalize this as it's an awesome feature.

Someone asked about it here #42441 and I was thinking of asking them to test but... we need instructions on how to install it as I don't think it comes by default?

gsmet

I added some additional comments that need fixing.

I saw you asked for a review by @maxandersen and @cescoffier anyway so I will let it there until they have time to review it.

gsmet · 2024-08-12T09:33:37Z

...les/deployment/src/main/java/io/quarkus/dockerfiles/deployment/DockerfilesConfiguration.java

+    @ConfigItem(defaultValue = "registry.access.redhat.com/ubi8/openjdk-21:1.19")
+    String jvmFrom;
+
+    /**
+     * The from image to use for native based Dockerfiles
+     */
+    @ConfigItem(defaultValue = "registry.access.redhat.com/ubi8/ubi-minimal:8.9")


BTW, the constants should be used here.

gsmet · 2024-08-12T09:33:47Z

...les/deployment/src/main/java/io/quarkus/dockerfiles/deployment/DockerfilesConfiguration.java

+@ConfigRoot
+public class DockerfilesConfiguration {
+
+    static final String DEFAULT_JVM_FROM = "registry.access.redhat.com/ubi8/openjdk-21:1.19";


Suggested change

static final String DEFAULT_JVM_FROM = "registry.access.redhat.com/ubi8/openjdk-21:1.19";

static final String DEFAULT_JVM_FROM = "registry.access.redhat.com/ubi8/openjdk-21:1.20";

gsmet · 2024-08-12T09:33:55Z

...les/deployment/src/main/java/io/quarkus/dockerfiles/deployment/DockerfilesConfiguration.java

+public class DockerfilesConfiguration {
+
+    static final String DEFAULT_JVM_FROM = "registry.access.redhat.com/ubi8/openjdk-21:1.19";
+    static final String DEFAULT_NATIVE_FROM = "registry.access.redhat.com/ubi8/ubi-minimal:8.9";


Suggested change

static final String DEFAULT_NATIVE_FROM = "registry.access.redhat.com/ubi8/ubi-minimal:8.9";

static final String DEFAULT_NATIVE_FROM = "registry.access.redhat.com/ubi8/ubi-minimal:8.10";

gsmet · 2024-08-12T09:37:43Z

I'm also wondering if in the future we should generate the default Dockerfiles from there to be consistent.

ia3andy · 2024-08-20T07:11:58Z

@iocanel any reason not to continue on what you started with codestarts?

ia3andy · 2024-08-20T07:17:53Z

It should be possible to share the same templates as the existing codestarts and use a subset part of the codestart generator for generation.

cescoffier

I may have missed something but where extensions can add packages and files to the generated docker files?

So far I only see the "from" customization.

iocanel · 2024-09-03T13:26:41Z

I may have missed something but where extensions can add packages and files to the generated docker files?

So far I only see the "from" customization.

What I had in my mind is to deal with just #41772 and leave the rest for future prs. If you feel that this needs to be done in one go, please let me know.

Relates to: quarkusio#43410

github-actions · 2024-10-01T05:57:21Z

🎊 PR Preview 4cab5df has been successfully built and deployed to https://quarkus-pr-main-42316-preview.surge.sh/version/main/guides/

Images of blog posts older than 3 months are not available.
Newsletters older than 3 months are not available.

quarkus-bot · 2024-10-01T05:58:28Z

Status for workflow `Quarkus Documentation CI`

This is the status report for running Quarkus Documentation CI on commit 95984d7.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

Warning

There are other workflow runs running, you probably need to wait for their status before merging.

quarkus-bot · 2024-10-01T10:37:25Z

Status for workflow `Quarkus CI`

This is the status report for running Quarkus CI on commit 95984d7.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

You can consult the Develocity build scans.

Flaky tests - Develocity

⚙️ JVM Tests - JDK 21

📦 extensions/infinispan-cache/deployment

✖ io.quarkus.cache.infinispan.InfinispanCacheTest.testGetAsyncWithParallelCalls - History

expected: "thread1" but was: "thread2" - org.opentest4j.AssertionFailedError

org.opentest4j.AssertionFailedError: 

expected: "thread1"
 but was: "thread2"
	at io.quarkus.cache.infinispan.InfinispanCacheTest.testGetAsyncWithParallelCalls(InfinispanCacheTest.java:283)
	at java.base/java.lang.reflect.Method.invoke(Method.java:580)
	at io.quarkus.test.QuarkusUnitTest.runExtensionMethod(QuarkusUnitTest.java:513)
	at io.quarkus.test.QuarkusUnitTest.interceptTestMethod(QuarkusUnitTest.java:427)

cescoffier · 2024-11-10T16:59:50Z

@iocanel Where are we on this?

iocanel · 2024-11-11T06:16:04Z

@iocanel Where are we on this?
AFAIR, @gsmet and @ia3andy concerns have been addressed. So, we could possible or merge.

cescoffier · 2024-11-17T15:07:26Z

...eployment/src/main/java/io/quarkus/deployment/builditem/SetClassPathSystemPropBuildItem.java

@@ -7,6 +7,9 @@
 * This system property is used in rare by libraries (Truffle for example) to create their own ClassLoaders.
 * The value of the system property is simply best effort, as there is no way to faithfully represent
 * the Quarkus ClassLoader hierarchies in a system property value.
+ *
+ * @deprecated This was initially added to support Truffle, but it is no longer needed so the build item should not be used


Why is this part of this PR?

cescoffier · 2024-11-17T15:08:22Z

extensions/dockerfiles/cli/pom.xml

+        <plugins>
+            <plugin>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-maven-plugin</artifactId>


In my case it was a problem to have CLI be a quarkus app. Check you can build from scratch.

cescoffier · 2024-11-17T15:08:41Z

extensions/dockerfiles/cli/src/main/java/io/quarkus/dockerfiles/cli/Dockerfiles.java

+import picocli.CommandLine.Parameters;
+
+@TopCommand
+@Command(name = "dockerfiles", sortOptions = false, mixinStandardHelpOptions = false, header = "Generate Dockerfiles.", headerHeading = "%n", commandListHeading = "%nCommands:%n", synopsisHeading = "%nUsage: ", optionListHeading = "%nOptions:%n")


Suggested change

@Command(name = "dockerfiles", sortOptions = false, mixinStandardHelpOptions = false, header = "Generate Dockerfiles.", headerHeading = "%n", commandListHeading = "%nCommands:%n", synopsisHeading = "%nUsage: ", optionListHeading = "%nOptions:%n")

@Command(name = "dockerfiles", sortOptions = false, mixinStandardHelpOptions = false, header = "Generate Dockerfiles/Containerfiles.", headerHeading = "%n", commandListHeading = "%nCommands:%n", synopsisHeading = "%nUsage: ", optionListHeading = "%nOptions:%n")

cescoffier · 2024-11-17T15:09:02Z

extensions/dockerfiles/cli/src/main/java/io/quarkus/dockerfiles/cli/Dockerfiles.java

+    @Option(names = { "--native" }, paramLabel = "", order = 5, description = "Flag to enable Native Dockerfile generation")
+    boolean generateNativeDockerfile;
+
+    @Parameters(arity = "0..1", paramLabel = "GENERATION_PATH", description = " The path to generate Dockerfiles")


Suggested change

@Parameters(arity = "0..1", paramLabel = "GENERATION_PATH", description = " The path to generate Dockerfiles")

@Parameters(arity = "0..1", paramLabel = "GENERATION_PATH", description = "The path to generate Dockerfiles")

cescoffier · 2024-11-17T15:10:05Z

extensions/dockerfiles/cli/src/main/java/io/quarkus/dockerfiles/cli/Dockerfiles.java

+    private static final ArtifactDependency QUARKUS_DOCKERFILES_SPI = new ArtifactDependency("io.quarkus",
+            "quarkus-dockerfiles-spi", null, "jar", Dockerfiles.getVersion());
+
+    @Option(names = { "--jvm" }, paramLabel = "", order = 5, description = "Flag to enable JVM Dockerfile generation")


Does it generate all the variants or a single one (in this case, which one?)

cescoffier · 2024-12-02T07:55:11Z

@iocanel ping.

iocanel · 2024-12-02T08:44:43Z

I'll get back to it this week

quarkus-bot bot added the area/dependencies Pull requests that update a dependency file label Aug 5, 2024

This comment has been minimized.

Sign in to view

iocanel force-pushed the gen-dockerfiles-from branch from ad21261 to 1866652 Compare August 6, 2024 06:07

This comment has been minimized.

Sign in to view

iocanel force-pushed the gen-dockerfiles-from branch from 1866652 to 4092aca Compare August 6, 2024 08:17

This comment has been minimized.

Sign in to view

iocanel force-pushed the gen-dockerfiles-from branch from 4092aca to afcb767 Compare August 6, 2024 08:47

This comment has been minimized.

Sign in to view

iocanel force-pushed the gen-dockerfiles-from branch from afcb767 to 8b617f8 Compare August 6, 2024 10:01

quarkus-bot bot added area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins area/documentation labels Aug 6, 2024

This comment has been minimized.

Sign in to view

iocanel force-pushed the gen-dockerfiles-from branch from 8b617f8 to 7ffcce4 Compare August 6, 2024 10:35

geoand requested review from cescoffier and maxandersen August 6, 2024 13:53

This comment has been minimized.

Sign in to view

quarkus-bot bot added the triage/flaky-test label Aug 6, 2024

gsmet reviewed Aug 8, 2024

View reviewed changes

gsmet mentioned this pull request Aug 8, 2024

Centralize reference to UBI images (and maybe others) #42389

Closed

gsmet requested changes Aug 12, 2024

View reviewed changes

maxandersen mentioned this pull request Aug 19, 2024

Codestart modularize Dockerfiles #42601

Closed

cescoffier requested changes Aug 20, 2024

View reviewed changes

Truffle no longer needs the java.class.path sysprop

7cbba9d

Relates to: quarkusio#43410

Deprecate SetClassPathSystemPropBuildItem

124ddcc

iocanel force-pushed the gen-dockerfiles-from branch from 7ffcce4 to ab5590e Compare September 30, 2024 08:23

quarkus-bot bot added area/cli Related to quarkus cli (not maven/gradle/etc.) area/core labels Sep 30, 2024

This comment has been minimized.

Sign in to view

feat: Introduce a new extension for generating Dockerfiles

95984d7

iocanel force-pushed the gen-dockerfiles-from branch from ab5590e to 95984d7 Compare October 1, 2024 05:21

iocanel requested review from gsmet and cescoffier November 11, 2024 06:16

cescoffier requested changes Nov 17, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce a new extension for generating Dockerfiles #42316

Introduce a new extension for generating Dockerfiles #42316

iocanel commented Aug 5, 2024 •

edited

Loading

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

gsmet left a comment

gsmet Aug 8, 2024

gsmet Aug 8, 2024

gsmet Aug 8, 2024

gsmet Aug 8, 2024

gsmet commented Aug 9, 2024

gsmet left a comment

gsmet Aug 12, 2024

gsmet Aug 12, 2024

gsmet Aug 12, 2024

gsmet commented Aug 12, 2024

ia3andy commented Aug 20, 2024 •

edited

Loading

ia3andy commented Aug 20, 2024

cescoffier left a comment

iocanel commented Sep 3, 2024

This comment has been minimized.

github-actions bot commented Oct 1, 2024

quarkus-bot bot commented Oct 1, 2024

quarkus-bot bot commented Oct 1, 2024 •

edited by github-actions bot

Loading

cescoffier commented Nov 10, 2024

iocanel commented Nov 11, 2024

cescoffier Nov 17, 2024

cescoffier Nov 17, 2024

cescoffier Nov 17, 2024

cescoffier Nov 17, 2024

cescoffier Nov 17, 2024

cescoffier commented Dec 2, 2024

iocanel commented Dec 2, 2024

	static final String DEFAULT_JVM_FROM = "registry.access.redhat.com/ubi8/openjdk-21:1.19";
	static final String DEFAULT_JVM_FROM = "registry.access.redhat.com/ubi8/openjdk-21:1.20";

	static final String DEFAULT_NATIVE_FROM = "registry.access.redhat.com/ubi8/ubi-minimal:8.9";
	static final String DEFAULT_NATIVE_FROM = "registry.access.redhat.com/ubi8/ubi-minimal:8.10";

	@Command(name = "dockerfiles", sortOptions = false, mixinStandardHelpOptions = false, header = "Generate Dockerfiles.", headerHeading = "%n", commandListHeading = "%nCommands:%n", synopsisHeading = "%nUsage: ", optionListHeading = "%nOptions:%n")
	@Command(name = "dockerfiles", sortOptions = false, mixinStandardHelpOptions = false, header = "Generate Dockerfiles/Containerfiles.", headerHeading = "%n", commandListHeading = "%nCommands:%n", synopsisHeading = "%nUsage: ", optionListHeading = "%nOptions:%n")

	@Parameters(arity = "0..1", paramLabel = "GENERATION_PATH", description = " The path to generate Dockerfiles")
	@Parameters(arity = "0..1", paramLabel = "GENERATION_PATH", description = "The path to generate Dockerfiles")

Introduce a new extension for generating Dockerfiles #42316

Are you sure you want to change the base?

Introduce a new extension for generating Dockerfiles #42316

Conversation

iocanel commented Aug 5, 2024 • edited Loading

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

gsmet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gsmet commented Aug 9, 2024

gsmet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gsmet commented Aug 12, 2024

ia3andy commented Aug 20, 2024 • edited Loading

ia3andy commented Aug 20, 2024

cescoffier left a comment

Choose a reason for hiding this comment

iocanel commented Sep 3, 2024

This comment has been minimized.

github-actions bot commented Oct 1, 2024

quarkus-bot bot commented Oct 1, 2024

Status for workflow Quarkus Documentation CI

quarkus-bot bot commented Oct 1, 2024 • edited by github-actions bot Loading

Status for workflow Quarkus CI

Flaky tests - Develocity

⚙️ JVM Tests - JDK 21

📦 extensions/infinispan-cache/deployment

cescoffier commented Nov 10, 2024

iocanel commented Nov 11, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cescoffier commented Dec 2, 2024

iocanel commented Dec 2, 2024

iocanel commented Aug 5, 2024 •

edited

Loading

ia3andy commented Aug 20, 2024 •

edited

Loading

Status for workflow `Quarkus Documentation CI`

quarkus-bot bot commented Oct 1, 2024 •

edited by github-actions bot

Loading

Status for workflow `Quarkus CI`