This is an automated email from the ASF dual-hosted git repository.
cdeppisch pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new bb7a8729b56 CAMEL-21013: Fix JBang kubernetes plugin deployment to
OpenShift
bb7a8729b56 is described below
commit bb7a8729b561dbac9b4fdc579067971b80029ce7
Author: Christoph Deppisch <[email protected]>
AuthorDate: Mon Aug 12 20:36:01 2024 +0200
CAMEL-21013: Fix JBang kubernetes plugin deployment to OpenShift
- Fix deploy to OpenShift for runtime Quarkus
- Use cluster specific Kubernetes manifest to deploy to OpenShift
(kubernetes.yml or openshift.yml)
- Make sure generated manifest includes OpenShift specific resources such
as ImageStream or BuildConfig
- Fix image builder name for S2i (use openshift instead of s2i)
---
.../core/commands/k/IntegrationExportTest.java | 6 ++-
.../core/commands/kubernetes/ClusterType.java | 44 ++++++++++++++++++
.../core/commands/kubernetes/KubernetesDelete.java | 2 +-
.../core/commands/kubernetes/KubernetesExport.java | 39 ++++++++--------
.../core/commands/kubernetes/KubernetesHelper.java | 53 ++++++++++++++++++++++
.../core/commands/kubernetes/KubernetesRun.java | 21 ++++++---
.../commands/kubernetes/KubernetesExportTest.java | 5 +-
7 files changed, 141 insertions(+), 29 deletions(-)
diff --git
a/dsl/camel-jbang/camel-jbang-plugin-k/src/test/java/org/apache/camel/dsl/jbang/core/commands/k/IntegrationExportTest.java
b/dsl/camel-jbang/camel-jbang-plugin-k/src/test/java/org/apache/camel/dsl/jbang/core/commands/k/IntegrationExportTest.java
index 37ad037b487..47349563dd8 100644
---
a/dsl/camel-jbang/camel-jbang-plugin-k/src/test/java/org/apache/camel/dsl/jbang/core/commands/k/IntegrationExportTest.java
+++
b/dsl/camel-jbang/camel-jbang-plugin-k/src/test/java/org/apache/camel/dsl/jbang/core/commands/k/IntegrationExportTest.java
@@ -28,6 +28,8 @@ import io.fabric8.kubernetes.api.model.HasMetadata;
import io.fabric8.kubernetes.api.model.apps.Deployment;
import org.apache.camel.RuntimeCamelException;
import org.apache.camel.dsl.jbang.core.commands.CamelJBangMain;
+import org.apache.camel.dsl.jbang.core.commands.kubernetes.ClusterType;
+import org.apache.camel.dsl.jbang.core.commands.kubernetes.KubernetesHelper;
import org.apache.camel.dsl.jbang.core.commands.kubernetes.traits.BaseTrait;
import org.apache.camel.dsl.jbang.core.common.RuntimeType;
import org.junit.jupiter.api.Assertions;
@@ -107,7 +109,9 @@ class IntegrationExportTest extends CamelKBaseTest {
}
private <T extends HasMetadata> Optional<T> getResource(RuntimeType rt,
Class<T> type) throws IOException {
- try (FileInputStream fis = new FileInputStream(new File(workingDir,
"src/main/kubernetes/kubernetes.yml"))) {
+ try (FileInputStream fis = new FileInputStream(
+
KubernetesHelper.getKubernetesManifest(ClusterType.KUBERNETES.name(),
+ new File(workingDir, "/src/main/kubernetes")))) {
List<HasMetadata> resources = kubernetesClient.load(fis).items();
return resources.stream()
.filter(it -> type.isAssignableFrom(it.getClass()))
diff --git
a/dsl/camel-jbang/camel-jbang-plugin-kubernetes/src/main/java/org/apache/camel/dsl/jbang/core/commands/kubernetes/ClusterType.java
b/dsl/camel-jbang/camel-jbang-plugin-kubernetes/src/main/java/org/apache/camel/dsl/jbang/core/commands/kubernetes/ClusterType.java
new file mode 100644
index 00000000000..adc4ed98bac
--- /dev/null
+++
b/dsl/camel-jbang/camel-jbang-plugin-kubernetes/src/main/java/org/apache/camel/dsl/jbang/core/commands/kubernetes/ClusterType.java
@@ -0,0 +1,44 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.camel.dsl.jbang.core.commands.kubernetes;
+
+import java.util.Arrays;
+
+/**
+ * Known default cluster types.
+ */
+public enum ClusterType {
+ KUBERNETES,
+ OPENSHIFT,
+ KIND,
+ MINIKUBE;
+
+ public static ClusterType fromName(String name) {
+ return Arrays.stream(values())
+ .filter(ct -> ct.name().equalsIgnoreCase(name))
+ .findFirst().orElseThrow(() -> new
IllegalArgumentException("Unknown cluster type: %s".formatted(name)));
+ }
+
+ public boolean isEqualTo(String clusterType) {
+ if (clusterType == null) {
+ return false;
+ }
+
+ return this == fromName(clusterType);
+ }
+}
diff --git
a/dsl/camel-jbang/camel-jbang-plugin-kubernetes/src/main/java/org/apache/camel/dsl/jbang/core/commands/kubernetes/KubernetesDelete.java
b/dsl/camel-jbang/camel-jbang-plugin-kubernetes/src/main/java/org/apache/camel/dsl/jbang/core/commands/kubernetes/KubernetesDelete.java
index 7832970685f..dd0b1a08184 100644
---
a/dsl/camel-jbang/camel-jbang-plugin-kubernetes/src/main/java/org/apache/camel/dsl/jbang/core/commands/kubernetes/KubernetesDelete.java
+++
b/dsl/camel-jbang/camel-jbang-plugin-kubernetes/src/main/java/org/apache/camel/dsl/jbang/core/commands/kubernetes/KubernetesDelete.java
@@ -70,7 +70,7 @@ public class KubernetesDelete extends KubernetesBaseCommand {
return 1;
}
- File manifest = new File(resolvedWorkingDir,
"target/kubernetes/kubernetes.yml");
+ File manifest = KubernetesHelper.resolveKubernetesManifest(new
File(resolvedWorkingDir, "target/kubernetes"));
try (FileInputStream fis = new FileInputStream(manifest)) {
List<StatusDetails> status;
if (namespace != null) {
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
index 3236e039907..c9f94437812 100644
---
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
@@ -271,33 +271,34 @@ public class KubernetesExport extends Export {
if (runtime == RuntimeType.quarkus) {
// Quarkus specific dependencies
- if (clusterType != null && clusterType.equals("openshift")) {
+ if (ClusterType.OPENSHIFT.isEqualTo(clusterType)) {
addDependencies("io.quarkus:quarkus-openshift");
- if (imageBuilder == null) {
- // use s2i image builder as a default on OpenShift
- imageBuilder = "s2i";
- }
} else {
addDependencies("io.quarkus:quarkus-kubernetes");
+
+ // on clusters other than OpenShift we need a default image
builder
+ if (imageBuilder == null) {
+ imageBuilder = "jib";
+ }
}
// TODO: remove when fixed kubernetes-client version is part of
the Quarkus platform
// pin kubernetes-client to this version because of
https://github.com/fabric8io/kubernetes-client/issues/6059
addDependencies("io.fabric8:kubernetes-client:6.13.2");
- // Configure image builder - use Jib by default
- if (imageBuilder == null) {
- addDependencies("io.quarkus:quarkus-container-image-jib");
- } else if (imageBuilder.equals("s2i")) {
-
addDependencies("io.quarkus:quarkus-container-image-openshift");
- } else {
+ // auto translate s2i image builder to openshift
+ if ("s2i".equals(imageBuilder)) {
+ imageBuilder = "openshift";
+ }
+
+ // Configure image builder
+ if (imageBuilder != null) {
addDependencies("io.quarkus:quarkus-container-image-%s".formatted(imageBuilder));
+
buildProperties.add("quarkus.container-image.builder=%s".formatted(imageBuilder));
}
// Quarkus specific properties
buildProperties.add("quarkus.container-image.build=true");
- buildProperties
-
.add("quarkus.container-image.builder=%s".formatted(Optional.ofNullable(imageBuilder).orElse("jib")));
}
// SpringBoot Runtime specific
@@ -330,7 +331,7 @@ public class KubernetesExport extends Export {
if (runtime == RuntimeType.quarkus) {
var kubeManifest =
kubeFragments.stream().map(KubernetesHelper::dumpYaml).collect(Collectors.joining("---\n"));
safeCopy(new
ByteArrayInputStream(kubeManifest.getBytes(StandardCharsets.UTF_8)),
- new File(exportDir +
"/src/main/kubernetes/kubernetes.yml"));
+ KubernetesHelper.getKubernetesManifest(clusterType,
exportDir + "/src/main/kubernetes"));
}
// SpringBoot: dump each fragment to its respective kind
@@ -435,12 +436,10 @@ public class KubernetesExport extends Export {
}
}
- if (clusterType != null) {
- if (clusterType.equals("kind")) {
- return "localhost:5001";
- } else if (clusterType.equals("minikube")) {
- return "localhost:5000";
- }
+ if (ClusterType.KIND.isEqualTo(clusterType)) {
+ return "localhost:5001";
+ } else if (ClusterType.MINIKUBE.isEqualTo(clusterType)) {
+ return "localhost:5000";
}
return null;
diff --git
a/dsl/camel-jbang/camel-jbang-plugin-kubernetes/src/main/java/org/apache/camel/dsl/jbang/core/commands/kubernetes/KubernetesHelper.java
b/dsl/camel-jbang/camel-jbang-plugin-kubernetes/src/main/java/org/apache/camel/dsl/jbang/core/commands/kubernetes/KubernetesHelper.java
index 4017599e640..3228754ed5c 100644
---
a/dsl/camel-jbang/camel-jbang-plugin-kubernetes/src/main/java/org/apache/camel/dsl/jbang/core/commands/kubernetes/KubernetesHelper.java
+++
b/dsl/camel-jbang/camel-jbang-plugin-kubernetes/src/main/java/org/apache/camel/dsl/jbang/core/commands/kubernetes/KubernetesHelper.java
@@ -17,9 +17,13 @@
package org.apache.camel.dsl.jbang.core.commands.kubernetes;
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.util.Arrays;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
+import java.util.Optional;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.core.JsonParser;
@@ -151,4 +155,53 @@ public final class KubernetesHelper {
public static Map<String, Object> toJsonMap(Object model) {
return json().convertValue(model, Map.class);
}
+
+ public static File resolveKubernetesManifest(String workingDir) throws
FileNotFoundException {
+ return resolveKubernetesManifest(new File(workingDir));
+ }
+
+ public static File resolveKubernetesManifest(String workingDir, String
extension) throws FileNotFoundException {
+ return resolveKubernetesManifest(new File(workingDir), extension);
+ }
+
+ public static File resolveKubernetesManifest(File workingDir) throws
FileNotFoundException {
+ return resolveKubernetesManifest(workingDir, "yml");
+ }
+
+ public static File resolveKubernetesManifest(File workingDir, String
extension) throws FileNotFoundException {
+ // Try arbitrary Kubernetes manifest first
+ File manifest = getKubernetesManifest(ClusterType.KUBERNETES.name(),
workingDir);
+ if (manifest.exists()) {
+ return manifest;
+ }
+
+ // try to resolve from all the other cluster type specific manifests
+ return Arrays.stream(ClusterType.values())
+ .filter(ct -> ct != ClusterType.KUBERNETES)
+ .map(ct -> getKubernetesManifest(ct.name(), workingDir,
extension))
+ .filter(File::exists)
+ .findFirst()
+ .orElseThrow(() -> new FileNotFoundException(
+ "Unable to resolve Kubernetes manifest file type `%s`
in folder: %s"
+ .formatted(extension,
workingDir.toPath().toString())));
+ }
+
+ public static File getKubernetesManifest(String clusterType, String
workingDir) {
+ return getKubernetesManifest(clusterType, new File(workingDir));
+ }
+
+ public static File getKubernetesManifest(String clusterType, File
workingDir) {
+ return getKubernetesManifest(clusterType, workingDir, "yml");
+ }
+
+ public static File getKubernetesManifest(String clusterType, File
workingDir, String extension) {
+ String manifestFile;
+ if (ClusterType.KIND.isEqualTo(clusterType) ||
ClusterType.MINIKUBE.isEqualTo(clusterType)) {
+ manifestFile = "kubernetes";
+ } else {
+ manifestFile =
Optional.ofNullable(clusterType).map(String::toLowerCase).orElse("kubernetes");
+ }
+
+ return new File(workingDir, "%s.%s".formatted(manifestFile,
extension));
+ }
}
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
index 48fca276082..7f5d3d31c76 100644
---
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
@@ -24,6 +24,7 @@ import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
+import java.util.Optional;
import java.util.concurrent.TimeUnit;
import io.fabric8.kubernetes.api.model.Pod;
@@ -239,8 +240,9 @@ public class KubernetesRun extends KubernetesBaseCommand {
File manifest;
switch (output) {
- case "yaml" -> manifest = new File(workingDir,
"target/kubernetes/kubernetes.yml");
- case "json" -> manifest = new File(workingDir,
"target/kubernetes/kubernetes.json");
+ case "yaml" -> manifest =
KubernetesHelper.resolveKubernetesManifest(workingDir + "/target/kubernetes");
+ case "json" ->
+ manifest =
KubernetesHelper.resolveKubernetesManifest(workingDir + "/target/kubernetes",
"json");
default -> {
printer().printf("Unsupported output format '%s'
(supported: yaml, json)%n", output);
return 1;
@@ -261,7 +263,8 @@ public class KubernetesRun extends KubernetesBaseCommand {
}
if (exit != 0) {
- printer().println("Deployment to Kubernetes failed!");
+ printer().println("Deployment to %s
failed!".formatted(Optional.ofNullable(clusterType)
+ .map(StringHelper::capitalize).orElse("Kubernetes")));
return exit;
}
@@ -337,7 +340,8 @@ public class KubernetesRun extends KubernetesBaseCommand {
}
private Integer deployQuarkus(String workingDir) throws IOException,
InterruptedException {
- printer().println("Deploying to Kubernetes ...");
+ printer().println("Deploying to %s
...".formatted(Optional.ofNullable(clusterType)
+ .map(StringHelper::capitalize).orElse("Kubernetes")));
// Run Quarkus build via Maven
String mvnw = "/mvnw";
@@ -364,7 +368,11 @@ public class KubernetesRun extends KubernetesBaseCommand {
args.add("-Dquarkus.container-image.push=true");
}
- args.add("-Dquarkus.kubernetes.deploy=true");
+ if (ClusterType.OPENSHIFT.isEqualTo(clusterType)) {
+ args.add("-Dquarkus.openshift.deploy=true");
+ } else {
+ args.add("-Dquarkus.kubernetes.deploy=true");
+ }
if (namespace != null) {
args.add("-Dquarkus.kubernetes.namespace=%s".formatted(namespace));
@@ -393,7 +401,8 @@ public class KubernetesRun extends KubernetesBaseCommand {
}
private Integer deploySpringBoot(String workingDir) {
- printer().println("Deploying to Kubernetes ...");
+ printer().println("Deploying to %s
...".formatted(Optional.ofNullable(clusterType)
+ .map(StringHelper::capitalize).orElse("Kubernetes")));
// TODO: implement SpringBoot Kubernetes deployment
return 0;
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
index 5de16087997..8bbd061c744 100644
---
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
@@ -740,7 +740,10 @@ class KubernetesExportTest extends KubernetesBaseTest {
private <T extends HasMetadata> Optional<T> getResource(RuntimeType rt,
Class<T> type) throws IOException {
if (rt == RuntimeType.quarkus) {
- try (FileInputStream fis = new FileInputStream(new
File(workingDir, "src/main/kubernetes/kubernetes.yml"))) {
+ try (FileInputStream fis
+ = new FileInputStream(
+
KubernetesHelper.getKubernetesManifest(ClusterType.KUBERNETES.name(),
+ new File(workingDir,
"/src/main/kubernetes")))) {
List<HasMetadata> resources =
kubernetesClient.load(fis).items();
return resources.stream()
.filter(it -> type.isAssignableFrom(it.getClass()))
