Merge pull request #24449 from gsmet/kind-support

Introduce Kind extension that supports autoloading
quarkusio · Mar 21, 2022 · 7d435c8 · 7d435c8
2 parents c9b15fb + dc05461
commit 7d435c8
Show file tree

Hide file tree

Showing 19 changed files with 500 additions and 98 deletions.
diff --git a/bom/application/pom.xml b/bom/application/pom.xml
@@ -2392,6 +2392,16 @@
                 <artifactId>quarkus-minikube-deployment</artifactId>
                 <version>${project.version}</version>
             </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-kind</artifactId>
+                <version>${project.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-kind-deployment</artifactId>
+                <version>${project.version}</version>
+            </dependency>
             <dependency>
                 <groupId>io.quarkus</groupId>
                 <artifactId>quarkus-kubernetes-client</artifactId>

diff --git a/devtools/bom-descriptor-json/pom.xml b/devtools/bom-descriptor-json/pom.xml
@@ -1085,6 +1085,19 @@
                         </exclusion>
                     </exclusions>
                 </dependency>
+                <dependency>
+                    <groupId>io.quarkus</groupId>
+                    <artifactId>quarkus-kind</artifactId>
+                    <version>${project.version}</version>
+                    <type>pom</type>
+                    <scope>test</scope>
+                    <exclusions>
+                        <exclusion>
+                            <groupId>*</groupId>
+                            <artifactId>*</artifactId>
+                        </exclusion>
+                    </exclusions>
+                </dependency>
                 <dependency>
                     <groupId>io.quarkus</groupId>
                     <artifactId>quarkus-kotlin</artifactId>

diff --git a/docs/pom.xml b/docs/pom.xml
@@ -1045,6 +1045,19 @@
                 </exclusion>
             </exclusions>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-kind-deployment</artifactId>
+            <version>${project.version}</version>
+            <type>pom</type>
+            <scope>test</scope>
+            <exclusions>
+                <exclusion>
+                    <groupId>*</groupId>
+                    <artifactId>*</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-kotlin-deployment</artifactId>

diff --git a/docs/src/main/asciidoc/deploying-to-kubernetes.adoc b/docs/src/main/asciidoc/deploying-to-kubernetes.adoc
@@ -661,6 +661,21 @@ only. When deploying to production, consider using the vanilla Kubernetes manife
 NOTE: If the assumptions the Minikube extension makes don't fit your workflow, nothing prevents you from using the regular Kubernetes extension to generate Kubernetes manifests
 and apply those to your Minikube cluster.
 
+=== Deploying to Kind
+https://kind.sigs.k8s.io/[Kind] is an other popular tool used as a Kubernetes cluster for development purposes. To make the deployment to Kind
+experience as frictionless as possible, Quarkus provides the `quarkus-kind` extension. This extension can be added to a project like so:
+
+[source,xml]
+----
+<dependency>
+    <groupId>io.quarkus</groupId>
+    <artifactId>quarkus-kind</artifactId>
+</dependency>
+----
+
+The purpose of this extension is to generate Kubernetes manifests (`kind.yaml` and `kind.json`) that are tailored to Kind and also to automate the process of loading images to the cluster
+when performing container image builds. The tailor made manifests will be pretty similar (they share the same rules) with Minikube (see above).
+
 == Tuning the generated resources using application.properties
 
 The Kubernetes extension allows tuning the generated manifest, using the `application.properties` file.

diff --git a/...ent/src/main/java/io/quarkus/container/image/buildpack/deployment/BuildpackProcessor.java b/...ent/src/main/java/io/quarkus/container/image/buildpack/deployment/BuildpackProcessor.java
@@ -22,6 +22,7 @@
 import io.quarkus.container.image.deployment.util.NativeBinaryUtil;
 import io.quarkus.container.spi.AvailableContainerImageExtensionBuildItem;
 import io.quarkus.container.spi.ContainerImageBuildRequestBuildItem;
+import io.quarkus.container.spi.ContainerImageBuilderBuildItem;
 import io.quarkus.container.spi.ContainerImageInfoBuildItem;
 import io.quarkus.container.spi.ContainerImageLabelBuildItem;
 import io.quarkus.container.spi.ContainerImagePushRequestBuildItem;
@@ -67,7 +68,8 @@ public void buildFromJar(ContainerImageConfig containerImageConfig, BuildpackCon
             Optional<ContainerImagePushRequestBuildItem> pushRequest,
             List<ContainerImageLabelBuildItem> containerImageLabels,
             Optional<AppCDSResultBuildItem> appCDSResult,
-            BuildProducer<ArtifactResultBuildItem> artifactResultProducer) {
+            BuildProducer<ArtifactResultBuildItem> artifactResultProducer,
+            BuildProducer<ContainerImageBuilderBuildItem> containerImageBuilder) {
 
         if (containerImageConfig.isBuildExplicitlyDisabled()) {
             return;
@@ -84,6 +86,7 @@ public void buildFromJar(ContainerImageConfig containerImageConfig, BuildpackCon
 
         artifactResultProducer.produce(new ArtifactResultBuildItem(null, "jar-container",
                 Collections.singletonMap("container-image", targetImageName)));
+        containerImageBuilder.produce(new ContainerImageBuilderBuildItem(BUILDPACK));
     }
 
     @BuildStep(onlyIf = { IsNormalNotRemoteDev.class, BuildpackBuild.class, NativeBuild.class })
@@ -94,7 +97,8 @@ public void buildFromNative(ContainerImageConfig containerImageConfig, Buildpack
             Optional<ContainerImageBuildRequestBuildItem> buildRequest,
             Optional<ContainerImagePushRequestBuildItem> pushRequest,
             List<ContainerImageLabelBuildItem> containerImageLabels,
-            BuildProducer<ArtifactResultBuildItem> artifactResultProducer) {
+            BuildProducer<ArtifactResultBuildItem> artifactResultProducer,
+            BuildProducer<ContainerImageBuilderBuildItem> containerImageBuilder) {
 
         if (containerImageConfig.isBuildExplicitlyDisabled()) {
             return;
@@ -116,6 +120,7 @@ public void buildFromNative(ContainerImageConfig containerImageConfig, Buildpack
 
         artifactResultProducer.produce(new ArtifactResultBuildItem(null, "native-container",
                 Collections.singletonMap("container-image", targetImageName)));
+        containerImageBuilder.produce(new ContainerImageBuilderBuildItem(BUILDPACK));
     }
 
     private Map<ProjectDirs, Path> getPaths(OutputTargetBuildItem outputTarget) {

diff --git a/...eployment/src/main/java/io/quarkus/container/image/docker/deployment/DockerProcessor.java b/...eployment/src/main/java/io/quarkus/container/image/docker/deployment/DockerProcessor.java
@@ -27,6 +27,7 @@
 import io.quarkus.container.image.deployment.util.NativeBinaryUtil;
 import io.quarkus.container.spi.AvailableContainerImageExtensionBuildItem;
 import io.quarkus.container.spi.ContainerImageBuildRequestBuildItem;
+import io.quarkus.container.spi.ContainerImageBuilderBuildItem;
 import io.quarkus.container.spi.ContainerImageInfoBuildItem;
 import io.quarkus.container.spi.ContainerImagePushRequestBuildItem;
 import io.quarkus.deployment.IsDockerWorking;
@@ -71,6 +72,7 @@ public void dockerBuildFromJar(DockerConfig dockerConfig,
             Optional<ContainerImagePushRequestBuildItem> pushRequest,
             @SuppressWarnings("unused") Optional<AppCDSResultBuildItem> appCDSResult, // ensure docker build will be performed after AppCDS creation
             BuildProducer<ArtifactResultBuildItem> artifactResultProducer,
+            BuildProducer<ContainerImageBuilderBuildItem> containerImageBuilder,
             PackageConfig packageConfig,
             @SuppressWarnings("unused") // used to ensure that the jar has been built
             JarBuildItem jar) {
@@ -109,6 +111,7 @@ public void dockerBuildFromJar(DockerConfig dockerConfig,
         // locally before pushing it to the registry
         artifactResultProducer.produce(new ArtifactResultBuildItem(null, "jar-container",
                 Map.of("container-image", builtContainerImage, "pull-required", "false")));
+        containerImageBuilder.produce(new ContainerImageBuilderBuildItem(DOCKER));
     }
 
     @BuildStep(onlyIf = { IsNormalNotRemoteDev.class, NativeBuild.class, DockerBuild.class })
@@ -120,6 +123,7 @@ public void dockerBuildFromNativeImage(DockerConfig dockerConfig,
             OutputTargetBuildItem out,
             Optional<UpxCompressedBuildItem> upxCompressed, // used to ensure that we work with the compressed native binary if compression was enabled
             BuildProducer<ArtifactResultBuildItem> artifactResultProducer,
+            BuildProducer<ContainerImageBuilderBuildItem> containerImageBuilder,
             PackageConfig packageConfig,
             // used to ensure that the native binary has been built
             NativeImageBuildItem nativeImage) {
@@ -149,6 +153,8 @@ public void dockerBuildFromNativeImage(DockerConfig dockerConfig,
         // locally before pushing it to the registry
         artifactResultProducer.produce(new ArtifactResultBuildItem(null, "native-container",
                 Map.of("container-image", builtContainerImage, "pull-required", "false")));
+
+        containerImageBuilder.produce(new ContainerImageBuilderBuildItem(DOCKER));
     }
 
     private String createContainerImage(ContainerImageConfig containerImageConfig, DockerConfig dockerConfig,

diff --git a/...-jib/deployment/src/main/java/io/quarkus/container/image/jib/deployment/JibProcessor.java b/...-jib/deployment/src/main/java/io/quarkus/container/image/jib/deployment/JibProcessor.java
@@ -51,6 +51,7 @@
 import io.quarkus.container.image.deployment.util.NativeBinaryUtil;
 import io.quarkus.container.spi.AvailableContainerImageExtensionBuildItem;
 import io.quarkus.container.spi.ContainerImageBuildRequestBuildItem;
+import io.quarkus.container.spi.ContainerImageBuilderBuildItem;
 import io.quarkus.container.spi.ContainerImageInfoBuildItem;
 import io.quarkus.container.spi.ContainerImageLabelBuildItem;
 import io.quarkus.container.spi.ContainerImagePushRequestBuildItem;
@@ -134,7 +135,8 @@ public void buildFromJar(ContainerImageConfig containerImageConfig, JibConfig ji
             Optional<ContainerImagePushRequestBuildItem> pushRequest,
             List<ContainerImageLabelBuildItem> containerImageLabels,
             Optional<AppCDSResultBuildItem> appCDSResult,
-            BuildProducer<ArtifactResultBuildItem> artifactResultProducer) {
+            BuildProducer<ArtifactResultBuildItem> artifactResultProducer,
+            BuildProducer<ContainerImageBuilderBuildItem> containerImageBuilder) {
 
         boolean buildContainerImage = buildContainerImageNeeded(containerImageConfig, buildRequest);
         boolean pushContainerImage = pushContainerImageNeeded(containerImageConfig, pushRequest);
@@ -168,6 +170,7 @@ public void buildFromJar(ContainerImageConfig containerImageConfig, JibConfig ji
         artifactResultProducer.produce(new ArtifactResultBuildItem(null, "jar-container",
                 Map.of("container-image", container.getTargetImage().toString(), "pull-required",
                         Boolean.toString(pushContainerImage))));
+        containerImageBuilder.produce(new ContainerImageBuilderBuildItem(JIB));
     }
 
     @BuildStep(onlyIf = { IsNormalNotRemoteDev.class, JibBuild.class, NativeBuild.class })
@@ -179,7 +182,8 @@ public void buildFromNative(ContainerImageConfig containerImageConfig, JibConfig
             Optional<ContainerImagePushRequestBuildItem> pushRequest,
             List<ContainerImageLabelBuildItem> containerImageLabels,
             Optional<UpxCompressedBuildItem> upxCompressed, // used to ensure that we work with the compressed native binary if compression was enabled
-            BuildProducer<ArtifactResultBuildItem> artifactResultProducer) {
+            BuildProducer<ArtifactResultBuildItem> artifactResultProducer,
+            BuildProducer<ContainerImageBuilderBuildItem> containerImageBuilder) {
 
         boolean buildContainerImage = buildContainerImageNeeded(containerImageConfig, buildRequest);
         boolean pushContainerImage = pushContainerImageNeeded(containerImageConfig, pushRequest);
@@ -206,6 +210,7 @@ public void buildFromNative(ContainerImageConfig containerImageConfig, JibConfig
         artifactResultProducer.produce(new ArtifactResultBuildItem(null, "native-container",
                 Map.of("container-image", container.getTargetImage().toString(), "pull-required",
                         "" + pushContainerImage)));
+        containerImageBuilder.produce(new ContainerImageBuilderBuildItem(JIB));
     }
 
     private JibContainer containerize(ContainerImageConfig containerImageConfig,

diff --git a/...ent/src/main/java/io/quarkus/container/image/openshift/deployment/OpenshiftProcessor.java b/...ent/src/main/java/io/quarkus/container/image/openshift/deployment/OpenshiftProcessor.java
@@ -47,6 +47,7 @@
 import io.quarkus.container.spi.AvailableContainerImageExtensionBuildItem;
 import io.quarkus.container.spi.BaseImageInfoBuildItem;
 import io.quarkus.container.spi.ContainerImageBuildRequestBuildItem;
+import io.quarkus.container.spi.ContainerImageBuilderBuildItem;
 import io.quarkus.container.spi.ContainerImageInfoBuildItem;
 import io.quarkus.container.spi.ContainerImagePushRequestBuildItem;
 import io.quarkus.deployment.IsNormalNotRemoteDev;
@@ -222,6 +223,7 @@ public void openshiftBuildFromJar(OpenshiftConfig openshiftConfig,
             Optional<ContainerImageBuildRequestBuildItem> buildRequest,
             Optional<ContainerImagePushRequestBuildItem> pushRequest,
             BuildProducer<ArtifactResultBuildItem> artifactResultProducer,
+            BuildProducer<ContainerImageBuilderBuildItem> containerImageBuilder,
             // used to ensure that the jar has been built
             JarBuildItem jar) {
 
@@ -265,6 +267,7 @@ public void openshiftBuildFromJar(OpenshiftConfig openshiftConfig,
                     jar.getPath());
         }
         artifactResultProducer.produce(new ArtifactResultBuildItem(null, "jar-container", Collections.emptyMap()));
+        containerImageBuilder.produce(new ContainerImageBuilderBuildItem(OPENSHIFT));
     }
 
     private String getContextRoot(String outputDirName, boolean isFastJar, BuildStrategy buildStrategy) {
@@ -287,6 +290,7 @@ public void openshiftBuildFromNative(OpenshiftConfig openshiftConfig, S2iConfig
             Optional<ContainerImageBuildRequestBuildItem> buildRequest,
             Optional<ContainerImagePushRequestBuildItem> pushRequest,
             BuildProducer<ArtifactResultBuildItem> artifactResultProducer,
+            BuildProducer<ContainerImageBuilderBuildItem> containerImageBuilder,
             NativeImageBuildItem nativeImage) {
 
         OpenshiftConfig config = mergeConfig(openshiftConfig, s2iConfig);
@@ -321,6 +325,7 @@ public void openshiftBuildFromNative(OpenshiftConfig openshiftConfig, S2iConfig
         createContainerImage(kubernetesClient, openshiftYml.get(), config, contextRoot, out.getOutputDirectory(),
                 nativeImage.getPath());
         artifactResultProducer.produce(new ArtifactResultBuildItem(null, "native-container", Collections.emptyMap()));
+        containerImageBuilder.produce(new ContainerImageBuilderBuildItem(OPENSHIFT));
     }
 
     public static void createContainerImage(KubernetesClientBuildItem kubernetesClient,

diff --git a/...-s2i/deployment/src/main/java/io/quarkus/container/image/s2i/deployment/S2iProcessor.java b/...-s2i/deployment/src/main/java/io/quarkus/container/image/s2i/deployment/S2iProcessor.java
@@ -44,6 +44,7 @@
 import io.quarkus.container.spi.AvailableContainerImageExtensionBuildItem;
 import io.quarkus.container.spi.BaseImageInfoBuildItem;
 import io.quarkus.container.spi.ContainerImageBuildRequestBuildItem;
+import io.quarkus.container.spi.ContainerImageBuilderBuildItem;
 import io.quarkus.container.spi.ContainerImageInfoBuildItem;
 import io.quarkus.container.spi.ContainerImagePushRequestBuildItem;
 import io.quarkus.deployment.IsNormalNotRemoteDev;
@@ -176,6 +177,7 @@ public void s2iBuildFromJar(S2iConfig s2iConfig, ContainerImageConfig containerI
             Optional<ContainerImageBuildRequestBuildItem> buildRequest,
             Optional<ContainerImagePushRequestBuildItem> pushRequest,
             BuildProducer<ArtifactResultBuildItem> artifactResultProducer,
+            BuildProducer<ContainerImageBuilderBuildItem> containerImageBuilder,
             // used to ensure that the jar has been built
             JarBuildItem jar) {
 
@@ -206,6 +208,7 @@ public void s2iBuildFromJar(S2iConfig s2iConfig, ContainerImageConfig containerI
         createContainerImage(kubernetesClient, openshiftYml.get(), s2iConfig, out.getOutputDirectory(), jar.getPath(),
                 out.getOutputDirectory().resolve("lib"));
         artifactResultProducer.produce(new ArtifactResultBuildItem(null, "jar-container", Collections.emptyMap()));
+        containerImageBuilder.produce(new ContainerImageBuilderBuildItem(S2I));
     }
 
     @BuildStep(onlyIf = { IsNormalNotRemoteDev.class, S2iBuild.class, NativeBuild.class })
@@ -217,6 +220,7 @@ public void s2iBuildFromNative(S2iConfig s2iConfig, ContainerImageConfig contain
             Optional<ContainerImageBuildRequestBuildItem> buildRequest,
             Optional<ContainerImagePushRequestBuildItem> pushRequest,
             BuildProducer<ArtifactResultBuildItem> artifactResultProducer,
+            BuildProducer<ContainerImageBuilderBuildItem> containerImageBuilder,
             NativeImageBuildItem nativeImage) {
 
         if (containerImageConfig.isBuildExplicitlyDisabled()) {
@@ -246,6 +250,7 @@ public void s2iBuildFromNative(S2iConfig s2iConfig, ContainerImageConfig contain
         createContainerImage(kubernetesClient, openshiftYml.get(), s2iConfig, out.getOutputDirectory(),
                 nativeImage.getPath());
         artifactResultProducer.produce(new ArtifactResultBuildItem(null, "native-container", Collections.emptyMap()));
+        containerImageBuilder.produce(new ContainerImageBuilderBuildItem(S2I));
     }
 
     public static void createContainerImage(KubernetesClientBuildItem kubernetesClient,

diff --git a/...iner-image/spi/src/main/java/io/quarkus/container/spi/ContainerImageBuilderBuildItem.java b/...iner-image/spi/src/main/java/io/quarkus/container/spi/ContainerImageBuilderBuildItem.java
@@ -0,0 +1,23 @@
+
+package io.quarkus.container.spi;
+
+import io.quarkus.builder.item.MultiBuildItem;
+
+/**
+ * A {@link MultiBuildItem} that represents eligible container image builders.
+ * Some extension have a dependency on external services (e.g. openshift and s2i).
+ * So, the persennce of the extension alone is not enough to let the build system know that extension is usable.
+ * This build item is produced only when all environment requirements are met.
+ */
+public final class ContainerImageBuilderBuildItem extends MultiBuildItem {
+
+    private final String builder;
+
+    public ContainerImageBuilderBuildItem(String builder) {
+        this.builder = builder;
+    }
+
+    public String getBuilder() {
+        return builder;
+    }
+}
diff --git a/extensions/kubernetes/kind/deployment/pom.xml b/extensions/kubernetes/kind/deployment/pom.xml
@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <groupId>io.quarkus</groupId>
+        <artifactId>quarkus-kind-parent</artifactId>
+        <version>999-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>quarkus-kind-deployment</artifactId>
+    <name>Quarkus - Kubernetes - Kind - Deployment</name>
+
+    <dependencies>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-kind</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-kubernetes-deployment</artifactId>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <annotationProcessorPaths>
+                        <path>
+                            <groupId>io.quarkus</groupId>
+                            <artifactId>quarkus-extension-processor</artifactId>
+                            <version>${project.version}</version>
+                        </path>
+                    </annotationProcessorPaths>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+</project>