CAMEL-21716: Improve JBang Kubernetes plugin container image options

christophd · davsclaus · commit 4c03397d26e2 · 2025-02-05T09:45:30.000+01:00
- Set basic settings on JIB image builder
- Introduce configurable base image (default is still eclipse-temurin:17)
- Set image platforms on JKube properties
- Set proper image push registry on JKube properties
diff --git a/docs/user-manual/modules/ROOT/pages/camel-jbang-kubernetes.adoc b/docs/user-manual/modules/ROOT/pages/camel-jbang-kubernetes.adoc
@@ -160,6 +160,15 @@ The Camel JBang Kubernetes export command provides several options to customize
 |--image-builder
 |The image builder used to build the container image (e.g. docker, jib, podman, s2i).
 
+|--image-platform
+|List of target platforms. Each platform is defined using os and architecture (e.g. linux/amd64).
+
+|--base-image
+|The base image that is used to build the container image from (default is eclipse-temurin:<java-version>).
+
+|--registry-mirror
+|Optional Docker registry mirror where to pull images from when building the container image.
+
 |--cluster-type
 |The target cluster type. Special configurations may be applied to different cluster types such as Kind or Minikube.
 
diff --git a/dsl/camel-jbang/camel-jbang-core/src/main/resources/templates/main-kubernetes-pom.tmpl b/dsl/camel-jbang/camel-jbang-core/src/main/resources/templates/main-kubernetes-pom.tmpl
@@ -132,7 +132,7 @@
                     <images>
                         <image>
                             <build>
-                                <from>eclipse-temurin:{{ .JavaVersion }}</from>
+                                <from>${jkube.base.image}</from>
                                 <entryPoint>
                                     <exec>
                                         <arg>java</arg>
diff --git a/dsl/camel-jbang/camel-jbang-core/src/main/resources/templates/quarkus-kubernetes-pom.tmpl b/dsl/camel-jbang/camel-jbang-core/src/main/resources/templates/quarkus-kubernetes-pom.tmpl
@@ -97,7 +97,7 @@
                     <images>
                         <image>
                             <build>
-                                <from>eclipse-temurin:{{ .JavaVersion }}</from>
+                                <from>${jkube.base.image}</from>
                                 <assembly>
                                     <layers>
                                         <layer>
diff --git a/dsl/camel-jbang/camel-jbang-core/src/main/resources/templates/spring-boot-kubernetes-pom.tmpl b/dsl/camel-jbang/camel-jbang-core/src/main/resources/templates/spring-boot-kubernetes-pom.tmpl
@@ -83,7 +83,7 @@
                     <images>
                         <image>
                             <build>
-                                <from>eclipse-temurin:{{ .JavaVersion }}</from>
+                                <from>${jkube.base.image}</from>
                                 <entryPoint>
                                     <exec>
                                         <arg>java</arg>
diff --git a/dsl/camel-jbang/camel-jbang-plugin-kubernetes/src/main/java/org/apache/camel/dsl/jbang/core/commands/kubernetes/KubernetesExport.java b/dsl/camel-jbang/camel-jbang-plugin-kubernetes/src/main/java/org/apache/camel/dsl/jbang/core/commands/kubernetes/KubernetesExport.java
@@ -102,12 +102,24 @@ public class KubernetesExport extends Export {
 
     @CommandLine.Option(names = { "--image-builder" }, defaultValue = "jib",
                         description = "The image builder used to build the container image (e.g. docker, jib, podman).")
-    protected String imageBuilder;
+    protected String imageBuilder = "jib";
 
     @CommandLine.Option(names = { "--image-push" }, defaultValue = "true",
                         description = "Whether to push the container image to a given image registry.")
     protected boolean imagePush = true;
 
+    @CommandLine.Option(names = { "--image-platform" },
+                        description = "List of target platforms. Each platform is defined using os and architecture (e.g. linux/amd64).")
+    protected String[] imagePlatforms;
+
+    @CommandLine.Option(names = { "--base-image" },
+                        description = "The base image that is used to build the container image from (default is eclipse-temurin:<java-version>).")
+    protected String baseImage;
+
+    @CommandLine.Option(names = { "--registry-mirror" },
+                        description = "Optional Docker registry mirror where to pull images from when building the container image.")
+    protected String registryMirror;
+
     @CommandLine.Option(names = { "--cluster-type" },
                         description = "The target cluster type. Special configurations may be applied to different cluster types such as Kind or Minikube or Openshift.")
     protected String clusterType;
@@ -182,9 +194,15 @@ public Integer export() throws Exception {
 
         if (resolvedImageRegistry != null) {
             buildProperties.add("jkube.container-image.registry=%s".formatted(resolvedImageRegistry));
+            if (imagePush) {
+                buildProperties.add("jkube.docker.push.registry=%s".formatted(resolvedImageRegistry));
+            }
+
             // [TODO] jkube config for insecure registries?
-            // var allowInsecure = resolvedImageRegistry.startsWith("localhost");
-            // buildProperties.add("%s.container-image.insecure=%b".formatted(propPrefix, allowInsecure));
+            var allowInsecure = resolvedImageRegistry.startsWith("localhost");
+            if (allowInsecure && "jib".equals(imageBuilder)) {
+                buildProperties.add("jib.allowInsecureRegistries=true");
+            }
         }
 
         String projectName = getProjectName();
@@ -255,6 +273,7 @@ public Integer export() throws Exception {
 
         Container container = traitsSpec.getContainer();
 
+        buildProperties.add("jkube.image.name=%s".formatted(container.getImage()));
         buildProperties.add("jkube.container-image.name=%s".formatted(container.getImage()));
 
         if (container.getName() != null && !container.getName().equals(projectName)) {
@@ -278,8 +297,26 @@ public Integer export() throws Exception {
             buildProperties.add("jkube.maven.plugin=%s".formatted("kubernetes-maven-plugin"));
         }
 
-        if ("docker".equals(imageBuilder) || "jib".equals(imageBuilder)) {
-            buildProperties.add("jkube.build.strategy=%s".formatted(imageBuilder));
+        if (baseImage == null) {
+            // use default base image with java version
+            baseImage = "eclipse-temurin:%s".formatted(javaVersion);
+        }
+
+        if (registryMirror != null) {
+            baseImage = "%s/%s".formatted(registryMirror, baseImage);
+        }
+
+        buildProperties.add("jkube.base.image=%s".formatted(baseImage));
+        buildProperties.add("jkube.build.strategy=%s".formatted(imageBuilder));
+
+        if ("jib".equals(imageBuilder)) {
+            buildProperties.add("jkube.container-image.nocache=true");
+            buildProperties.add("jib.disableUpdateChecks=true");
+        }
+
+        if (imagePlatforms != null) {
+            buildProperties.add("jkube.container-image.platforms=%s".formatted(
+                    Arrays.stream(imagePlatforms).distinct().collect(Collectors.joining(","))));
         }
 
         // Runtime specific for Main
diff --git a/dsl/camel-jbang/camel-jbang-plugin-kubernetes/src/main/java/org/apache/camel/dsl/jbang/core/commands/kubernetes/KubernetesRun.java b/dsl/camel-jbang/camel-jbang-plugin-kubernetes/src/main/java/org/apache/camel/dsl/jbang/core/commands/kubernetes/KubernetesRun.java
@@ -144,7 +144,7 @@ public class KubernetesRun extends KubernetesBaseCommand {
 
     @CommandLine.Option(names = { "--image-builder" }, defaultValue = "jib",
                         description = "The image builder used to build the container image (e.g. docker, jib, podman).")
-    String imageBuilder;
+    String imageBuilder = "jib";
 
     @CommandLine.Option(names = { "--cluster-type" },
                         description = "The target cluster type. Special configurations may be applied to different cluster types such as Kind or Minikube.")
@@ -158,9 +158,17 @@ public class KubernetesRun extends KubernetesBaseCommand {
                         description = "Whether to push image to given image registry as part of the run.")
     boolean imagePush = true;
 
-    @CommandLine.Option(names = { "--image-platforms" },
-                        description = "List of target platforms. Each platform is defined using the pattern.")
-    String imagePlatforms;
+    @CommandLine.Option(names = { "--image-platform" },
+                        description = "List of target platforms. Each platform is defined using os and architecture (e.g. linux/amd64).")
+    String[] imagePlatforms;
+
+    @CommandLine.Option(names = { "--base-image" },
+                        description = "The base image that is used to build the container image from (default is eclipse-temurin:<java-version>).")
+    String baseImage;
+
+    @CommandLine.Option(names = { "--registry-mirror" },
+                        description = "Optional Docker registry mirror where to pull images from when building the container image.")
+    String registryMirror;
 
     // Export base options
 
@@ -386,6 +394,9 @@ private KubernetesExport configureExport(String workingDir) {
         export.imageGroup = imageGroup;
         export.imagePush = imagePush;
         export.imageBuilder = imageBuilder;
+        export.imagePlatforms = imagePlatforms;
+        export.baseImage = baseImage;
+        export.registryMirror = registryMirror;
         export.clusterType = clusterType;
         export.serviceAccount = serviceAccount;
         export.setApplicationProperties(properties);
diff --git a/dsl/camel-jbang/camel-jbang-plugin-kubernetes/src/test/java/org/apache/camel/dsl/jbang/core/commands/kubernetes/KubernetesExportTest.java b/dsl/camel-jbang/camel-jbang-plugin-kubernetes/src/test/java/org/apache/camel/dsl/jbang/core/commands/kubernetes/KubernetesExportTest.java
@@ -61,6 +61,14 @@ public void shouldGenerateProject(RuntimeType rt) throws Exception {
         Assertions.assertEquals("examples", model.getGroupId());
         Assertions.assertEquals("route", model.getArtifactId());
         Assertions.assertEquals("1.0.0", model.getVersion());
+
+        Properties props = model.getProperties();
+        Assertions.assertEquals("examples/route:1.0.0", props.get("jkube.image.name"));
+        Assertions.assertEquals("eclipse-temurin:17", props.get("jkube.base.image"));
+        Assertions.assertEquals("jib", props.get("jkube.build.strategy"));
+        Assertions.assertNull(props.get("jkube.docker.push.registry"));
+        Assertions.assertNull(props.get("jkube.container-image.registry"));
+        Assertions.assertNull(props.get("jkube.container-image.platforms"));
     }
 
     @ParameterizedTest
@@ -77,6 +85,30 @@ public void shouldGenerateNamedProject(RuntimeType rt) throws Exception {
         Assertions.assertEquals("1.0-SNAPSHOT", model.getVersion());
     }
 
+    @ParameterizedTest
+    @MethodSource("runtimeProvider")
+    public void shouldConfigureContainerImage(RuntimeType rt) throws Exception {
+        KubernetesExport command = createCommand(new String[] { "classpath:route.yaml" },
+                "--image-registry=quay.io", "--image-group=camel-riders", "--base-image=my-base-image:latest",
+                "--registry-mirror=mirror.gcr.io", "--image-builder=docker",
+                "--image-platform=linux/amd64", "--image-platform=linux/arm64", "--runtime=" + rt.runtime());
+        int exit = command.doCall();
+        Assertions.assertEquals(0, exit);
+
+        Model model = readMavenModel();
+        Assertions.assertEquals("org.example.project", model.getGroupId());
+        Assertions.assertEquals("route", model.getArtifactId());
+        Assertions.assertEquals("1.0-SNAPSHOT", model.getVersion());
+
+        Properties props = model.getProperties();
+        Assertions.assertEquals("quay.io/camel-riders/route:1.0-SNAPSHOT", props.get("jkube.image.name"));
+        Assertions.assertEquals("mirror.gcr.io/my-base-image:latest", props.get("jkube.base.image"));
+        Assertions.assertEquals("docker", props.get("jkube.build.strategy"));
+        Assertions.assertEquals("quay.io", props.get("jkube.docker.push.registry"));
+        Assertions.assertEquals("quay.io", props.get("jkube.container-image.registry"));
+        Assertions.assertEquals("linux/amd64,linux/arm64", props.get("jkube.container-image.platforms"));
+    }
+
     @ParameterizedTest
     @MethodSource("runtimeProvider")
     public void shouldGenerateKubernetesManifest(RuntimeType rt) throws Exception {
