Introduce a new extension for generating Dockerfiles #42316

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

quarkus-bot · 2024-08-06T16:08:28Z

Status for workflow `Quarkus CI`

This is the status report for running Quarkus CI on commit 7ffcce4.

✅ 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 17

📦 integration-tests/opentelemetry

✖ io.quarkus.it.opentelemetry.MetricsTest.directCounterTest - History

Condition with Lambda expression in io.quarkus.it.opentelemetry.MetricsTest was not fulfilled within 5 seconds. - org.awaitility.core.ConditionTimeoutException

org.awaitility.core.ConditionTimeoutException: Condition with Lambda expression in io.quarkus.it.opentelemetry.MetricsTest was not fulfilled within 5 seconds.
	at org.awaitility.core.ConditionAwaiter.await(ConditionAwaiter.java:167)
	at org.awaitility.core.CallableCondition.await(CallableCondition.java:78)
	at org.awaitility.core.CallableCondition.await(CallableCondition.java:26)
	at org.awaitility.core.ConditionFactory.until(ConditionFactory.java:1006)
	at org.awaitility.core.ConditionFactory.until(ConditionFactory.java:975)
	at io.quarkus.it.opentelemetry.MetricsTest.directCounterTest(MetricsTest.java:54)
	at java.base/java.lang.reflect.Method.invoke(Method.java:569)

⚙️ JVM Tests - JDK 21

📦 extensions/smallrye-reactive-messaging/deployment

✖ io.quarkus.smallrye.reactivemessaging.hotreload.ConnectorChangeTest.testUpdatingConnector - History

Expecting actual: ["-6","-8","-9","-10","-11","-12","-13","-14"] to start with: ["-6", "-7", "-8", "-9"] - java.lang.AssertionError

java.lang.AssertionError: 

Expecting actual:
  ["-6","-8","-9","-10","-11","-12","-13","-14"]
to start with:
  ["-6", "-7", "-8", "-9"]

	at io.quarkus.smallrye.reactivemessaging.hotreload.ConnectorChangeTest.testUpdatingConnector(ConnectorChangeTest.java:41)

📦 integration-tests/opentelemetry

✖ io.quarkus.it.opentelemetry.MetricsTest.directCounterTest - History

Condition with Lambda expression in io.quarkus.it.opentelemetry.MetricsTest was not fulfilled within 5 seconds. - org.awaitility.core.ConditionTimeoutException

org.awaitility.core.ConditionTimeoutException: Condition with Lambda expression in io.quarkus.it.opentelemetry.MetricsTest was not fulfilled within 5 seconds.
	at org.awaitility.core.ConditionAwaiter.await(ConditionAwaiter.java:167)
	at org.awaitility.core.CallableCondition.await(CallableCondition.java:78)
	at org.awaitility.core.CallableCondition.await(CallableCondition.java:26)
	at org.awaitility.core.ConditionFactory.until(ConditionFactory.java:1006)
	at org.awaitility.core.ConditionFactory.until(ConditionFactory.java:975)
	at io.quarkus.it.opentelemetry.MetricsTest.directCounterTest(MetricsTest.java:54)
	at java.base/java.lang.reflect.Method.invoke(Method.java:580)

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.

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