Skip to content

[CAMEL-21032] Generate k8s service for health endpoint #14971

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
christophd merged 1 commit into from
Aug 2, 2024
Merged

[CAMEL-21032] Generate k8s service for health endpoint #14971

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions dsl/camel-jbang/camel-jbang-core/src/main/resources/templates/main-kubernetes-pom.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,21 @@
</build>

<profiles>
<profile>
<id>camel.debug</id>
<activation>
<property>
<name>camel.debug</name>
<value>true</value>
</property>
</activation>
<dependencies>
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-debug</artifactId>
</dependency>
</dependencies>
</profile>
</profiles>

</project>
15 changes: 15 additions & 0 deletions ...camel-jbang/camel-jbang-core/src/main/resources/templates/spring-boot-kubernetes-pom.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,21 @@
</build>

<profiles>
<profile>
<id>camel.debug</id>
<activation>
<property>
<name>camel.debug</name>
<value>true</value>
</property>
</activation>
<dependencies>
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-debug</artifactId>
</dependency>
</dependencies>
</profile>
</profiles>

</project>
2 changes: 1 addition & 1 deletion ...ang-plugin-k/src/test/java/org/apache/camel/dsl/jbang/core/commands/k/CamelKBaseTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public void setupFixtures() {
}

@BeforeEach
public void setup() {
public void setup() throws Exception {
printer = new StringPrinter();
k8sServer.reset();
}
Expand Down
27 changes: 19 additions & 8 deletions ...gin-k/src/test/java/org/apache/camel/dsl/jbang/core/commands/k/IntegrationExportTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,22 +21,25 @@
import java.io.FileInputStream;
import java.io.IOException;
import java.nio.file.Files;
import java.util.List;
import java.util.Optional;

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.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;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

class IntegrationExportTest {
class IntegrationExportTest extends CamelKBaseTest {

private File workingDir;

@BeforeEach
public void setup() throws IOException {
public void setup() throws Exception {
workingDir = Files.createTempDirectory("camel-k-integration-export").toFile();
workingDir.deleteOnExit();
}
Expand All @@ -50,7 +53,7 @@ public void shouldExportFromIntegration() throws Exception {

Assertions.assertEquals(0, exit);

Deployment deployment = getDeployment(workingDir);
Deployment deployment = getDeployment(RuntimeType.quarkus);
Assertions.assertEquals("routes", deployment.getMetadata().getName());
Assertions.assertEquals(1, deployment.getSpec().getTemplate().getSpec().getContainers().size());
Assertions.assertEquals("routes", deployment.getMetadata().getLabels().get(BaseTrait.INTEGRATION_LABEL));
Expand All @@ -75,7 +78,7 @@ public void shouldExportFromPipe() throws Exception {

Assertions.assertEquals(0, exit);

Deployment deployment = getDeployment(workingDir);
Deployment deployment = getDeployment(RuntimeType.quarkus);
Assertions.assertEquals("timer-to-log", deployment.getMetadata().getName());
Assertions.assertEquals(1, deployment.getSpec().getTemplate().getSpec().getContainers().size());
Assertions.assertEquals("timer-to-log", deployment.getMetadata().getLabels().get(BaseTrait.INTEGRATION_LABEL));
Expand All @@ -98,10 +101,18 @@ private IntegrationExport createCommand(String[] files, String exportDir) {
RuntimeType.quarkus, files, exportDir, "camel-test", false);
}

private Deployment getDeployment(File workingDir) throws IOException {
private Deployment getDeployment(RuntimeType rt) throws IOException {
return getResource(rt, Deployment.class)
.orElseThrow(() -> new RuntimeCamelException("Cannot find deployment for: %s".formatted(rt.runtime())));
}

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"))) {
return KubernetesHelper.yaml().loadAs(fis, Deployment.class);
List<HasMetadata> resources = kubernetesClient.load(fis).items();
return resources.stream()
.filter(it -> type.isAssignableFrom(it.getClass()))
.map(type::cast)
.findFirst();
}
}

}
2 changes: 1 addition & 1 deletion ...s/src/main/java/org/apache/camel/dsl/jbang/core/commands/kubernetes/KubernetesExport.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ public Integer export() throws Exception {
buildProperties.add("%s.kubernetes.image-name=%s".formatted(propPrefix, container.getImage()));
buildProperties.add("%s.kubernetes.ports.%s.container-port=%d".formatted(propPrefix,
Optional.ofNullable(container.getPortName()).orElse(ContainerTrait.DEFAULT_CONTAINER_PORT_NAME),
Optional.ofNullable(container.getPort()).orElse(ContainerTrait.DEFAULT_CONTAINER_PORT)));
Optional.ofNullable(container.getPort()).map(Long::intValue).orElse(ContainerTrait.DEFAULT_CONTAINER_PORT)));

// Need to set quarkus.container properties, otherwise these settings get overwritten by Quarkus
if (container.getName() != null && !container.getName().equals(projectName)) {
Expand Down
5 changes: 3 additions & 2 deletions .../main/java/org/apache/camel/dsl/jbang/core/commands/kubernetes/traits/ContainerTrait.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
public class ContainerTrait extends BaseTrait {

public static final int CONTAINER_TRAIT_ORDER = 1600;
public static final long DEFAULT_CONTAINER_PORT = 8080;
public static final int DEFAULT_CONTAINER_PORT = 8080;
public static final String DEFAULT_CONTAINER_PORT_NAME = "http";

public ContainerTrait() {
Expand Down Expand Up @@ -57,7 +57,8 @@ public void apply(Traits traitConfig, TraitContext context) {
if (containerTrait.getPort() != null || context.getService().isPresent() || context.getKnativeService().isPresent()) {
container.addToPorts(new ContainerPortBuilder()
.withName(Optional.ofNullable(containerTrait.getPortName()).orElse(DEFAULT_CONTAINER_PORT_NAME))
.withContainerPort(Optional.ofNullable(containerTrait.getPort()).map(Long::intValue).orElse(8080))
.withContainerPort(
Optional.ofNullable(containerTrait.getPort()).map(Long::intValue).orElse(DEFAULT_CONTAINER_PORT))
.withProtocol("TCP")
.build());
}
Expand Down
8 changes: 7 additions & 1 deletion ...rc/main/java/org/apache/camel/dsl/jbang/core/commands/kubernetes/traits/ServiceTrait.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
public class ServiceTrait extends BaseTrait {

public static final int SERVICE_TRAIT_ORDER = 1500;
public static final int DEFAULT_SERVICE_PORT = 80;

public ServiceTrait() {
super("service", SERVICE_TRAIT_ORDER);
Expand All @@ -46,6 +47,10 @@ public boolean configure(Traits traitConfig, TraitContext context) {
return traitConfig.getService().getEnabled();
}

if (traitConfig.getContainer().getPort() != null) {
Copy link
Contributor

@christophd christophd Jul 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need similar for the Knative trait as it also checks on TraitHelper.exposesHttpService()

return true;
}

return TraitHelper.exposesHttpService(context);
}

Expand All @@ -67,7 +72,8 @@ public void apply(Traits traitConfig, TraitContext context) {
.addToPorts(new ServicePortBuilder()
.withName(Optional.ofNullable(containerTrait.getServicePortName())
.orElse(ContainerTrait.DEFAULT_CONTAINER_PORT_NAME))
.withPort(Optional.ofNullable(containerTrait.getServicePort()).map(Long::intValue).orElse(80))
.withPort(Optional.ofNullable(containerTrait.getServicePort()).map(Long::intValue)
.orElse(DEFAULT_SERVICE_PORT))
.withTargetPort(
new IntOrString(
Optional.ofNullable(containerTrait.getPortName())
Expand Down
17 changes: 9 additions & 8 deletions ...src/main/java/org/apache/camel/dsl/jbang/core/commands/kubernetes/traits/TraitHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,6 @@ private TraitHelper() {
/**
* Parses given list of trait expressions to proper trait model object.
*
* @param traits
* @return
*/
public static Traits parseTraits(String[] traits) {
if (traits == null || traits.length == 0) {
Expand All @@ -70,9 +68,8 @@ public static Traits parseTraits(String[] traits) {
* Parses given list of trait expressions to proper trait model object. Supports trait options in the form of
* key=value and trait annotation configuration.
*
* @param traits trait key-value-pairs.
* @param annotations trait annotation configuration.
* @return
* @param traits trait key-value-pairs.
* @param annotations trait annotation configuration.
*/
public static Traits parseTraits(String[] traits, String[] annotations) {
Map<String, Map<String, Object>> traitConfigMap = new HashMap<>();
Expand Down Expand Up @@ -150,9 +147,6 @@ public static Traits parseTraits(String[] traits, String[] annotations) {
* Resolve trait value with automatic type conversion. Some trait keys (like enabled, verbose) need to be converted
* to boolean type.
*
* @param traitKey
* @param value
* @return
*/
private static Object resolveTraitValue(String traitKey, String value) {
if (traitKey.equalsIgnoreCase("enabled") ||
Expand Down Expand Up @@ -311,6 +305,13 @@ public static void configureContainerImage(
containerTrait.setImage("%s%s:%s".formatted(registryPrefix, imageName, version));
}

// Plain export command always exposes a health endpoint on 8080.
// Skip this, when we decide that the health endpoint can be disabled.
if (containerTrait.getPort() == null) {
containerTrait.setPortName(ContainerTrait.DEFAULT_CONTAINER_PORT_NAME);
containerTrait.setPort((long) ContainerTrait.DEFAULT_CONTAINER_PORT);
}

traitsSpec.setContainer(containerTrait);
}
}
Expand Down
67 changes: 50 additions & 17 deletions ...c/test/java/org/apache/camel/dsl/jbang/core/commands/kubernetes/KubernetesExportTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,10 @@
import io.fabric8.knative.eventing.v1.Trigger;
import io.fabric8.knative.messaging.v1.Subscription;
import io.fabric8.knative.sources.v1.SinkBinding;
import io.fabric8.kubernetes.api.model.Container;
import io.fabric8.kubernetes.api.model.HasMetadata;
import io.fabric8.kubernetes.api.model.Service;
import io.fabric8.kubernetes.api.model.ServicePort;
import io.fabric8.kubernetes.api.model.apps.Deployment;
import org.apache.camel.RuntimeCamelException;
import org.apache.camel.dsl.jbang.core.commands.CamelJBangMain;
Expand Down Expand Up @@ -111,7 +113,7 @@ public void shouldGenerateKubernetesManifest(RuntimeType rt) throws Exception {
Assertions.assertEquals("quay.io/camel-test/route:1.0-SNAPSHOT",
deployment.getSpec().getTemplate().getSpec().getContainers().get(0).getImage());

Assertions.assertFalse(hasService(rt));
Assertions.assertTrue(hasService(rt));
Assertions.assertFalse(hasKnativeService(rt));
}

Expand All @@ -136,7 +138,7 @@ public void shouldAddApplicationProperties(RuntimeType rt) throws Exception {
Assertions.assertEquals("camel-test/route:1.0-SNAPSHOT",
deployment.getSpec().getTemplate().getSpec().getContainers().get(0).getImage());

Assertions.assertFalse(hasService(rt));
Assertions.assertTrue(hasService(rt));
Assertions.assertFalse(hasKnativeService(rt));

Properties applicationProperties = getApplicationProperties(workingDir);
Expand All @@ -145,33 +147,64 @@ public void shouldAddApplicationProperties(RuntimeType rt) throws Exception {
Assertions.assertEquals("baz", applicationProperties.get("bar"));
}

@ParameterizedTest
@MethodSource("runtimeProvider")
public void shouldAddDefaultServiceSpec(RuntimeType rt) throws Exception {
KubernetesExport command = createCommand(new String[] { "classpath:route.yaml" },
"--trait", "service.type=NodePort",
"--runtime=" + rt.runtime());
command.doCall();

Assertions.assertTrue(hasService(rt));
Assertions.assertFalse(hasKnativeService(rt));

Deployment deployment = getDeployment(rt);
Container container = deployment.getSpec().getTemplate().getSpec().getContainers().get(0);
Assertions.assertEquals("route", deployment.getMetadata().getName());
Assertions.assertEquals(1, deployment.getSpec().getTemplate().getSpec().getContainers().size());
Assertions.assertEquals("route:1.0-SNAPSHOT", container.getImage());
Assertions.assertEquals(1, container.getPorts().size());
Assertions.assertEquals("http", container.getPorts().get(0).getName());
Assertions.assertEquals(8080, container.getPorts().get(0).getContainerPort());

Service service = getService(rt);
List<ServicePort> ports = service.getSpec().getPorts();
Assertions.assertEquals("route", service.getMetadata().getName());
Assertions.assertEquals("NodePort", service.getSpec().getType());
Assertions.assertEquals(1, ports.size());
Assertions.assertEquals("http", ports.get(0).getName());
Assertions.assertEquals(80, ports.get(0).getPort());
Assertions.assertEquals("http", ports.get(0).getTargetPort().getStrVal());
}

@ParameterizedTest
@MethodSource("runtimeProvider")
public void shouldAddServiceSpec(RuntimeType rt) throws Exception {
KubernetesExport command = createCommand(new String[] { "classpath:route-service.yaml" },
"--image-group=camel-test", "--runtime=" + rt.runtime());
"--trait", "service.type=NodePort",
"--runtime=" + rt.runtime());
command.doCall();

Assertions.assertTrue(hasService(rt));
Assertions.assertFalse(hasKnativeService(rt));

Deployment deployment = getDeployment(rt);
Container container = deployment.getSpec().getTemplate().getSpec().getContainers().get(0);
Assertions.assertEquals("route-service", deployment.getMetadata().getName());
Assertions.assertEquals(1, deployment.getSpec().getTemplate().getSpec().getContainers().size());
Assertions.assertEquals("camel-test/route-service:1.0-SNAPSHOT",
deployment.getSpec().getTemplate().getSpec().getContainers().get(0).getImage());
Assertions.assertEquals(1, deployment.getSpec().getTemplate().getSpec().getContainers().get(0).getPorts().size());
Assertions.assertEquals("http",
deployment.getSpec().getTemplate().getSpec().getContainers().get(0).getPorts().get(0).getName());
Assertions.assertEquals(8080,
deployment.getSpec().getTemplate().getSpec().getContainers().get(0).getPorts().get(0).getContainerPort());
Assertions.assertEquals("route-service:1.0-SNAPSHOT", container.getImage());
Assertions.assertEquals(1, container.getPorts().size());
Assertions.assertEquals("http", container.getPorts().get(0).getName());
Assertions.assertEquals(8080, container.getPorts().get(0).getContainerPort());

Service service = getService(rt);
List<ServicePort> ports = service.getSpec().getPorts();
Assertions.assertEquals("route-service", service.getMetadata().getName());
Assertions.assertEquals(1, service.getSpec().getPorts().size());
Assertions.assertEquals("http", service.getSpec().getPorts().get(0).getName());
Assertions.assertEquals(80, service.getSpec().getPorts().get(0).getPort());
Assertions.assertEquals("http", service.getSpec().getPorts().get(0).getTargetPort().getStrVal());
Assertions.assertEquals("NodePort", service.getSpec().getType());
Assertions.assertEquals(1, ports.size());
Assertions.assertEquals("http", ports.get(0).getName());
Assertions.assertEquals(80, ports.get(0).getPort());
Assertions.assertEquals("http", ports.get(0).getTargetPort().getStrVal());
}

@ParameterizedTest
Expand Down Expand Up @@ -359,7 +392,7 @@ public void shouldAddKnativeBrokerSinkBinding(RuntimeType rt) throws Exception {
"--image-group=camel-test", "--runtime=" + rt.runtime());
command.doCall();

Assertions.assertFalse(hasService(rt));
Assertions.assertTrue(hasService(rt));
Assertions.assertFalse(hasKnativeService(rt));

SinkBinding sinkBinding = getResource(rt, SinkBinding.class)
Expand Down Expand Up @@ -399,7 +432,7 @@ public void shouldAddKnativeChannelSinkBinding(RuntimeType rt) throws Exception
"--image-group=camel-test", "--runtime=" + rt.runtime());
command.doCall();

Assertions.assertFalse(hasService(rt));
Assertions.assertTrue(hasService(rt));
Assertions.assertFalse(hasKnativeService(rt));

SinkBinding sinkBinding = getResource(rt, SinkBinding.class)
Expand Down Expand Up @@ -439,7 +472,7 @@ public void shouldAddKnativeEndpointSinkBinding(RuntimeType rt) throws Exception
"--image-group=camel-test", "--runtime=" + rt.runtime());
command.doCall();

Assertions.assertFalse(hasService(rt));
Assertions.assertTrue(hasService(rt));
Assertions.assertFalse(hasKnativeService(rt));

SinkBinding sinkBinding = getResource(rt, SinkBinding.class)
Expand Down
2 changes: 1 addition & 1 deletion dsl/camel-jbang/camel-jbang-plugin-kubernetes/src/test/resources/route-service.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@
uri: 'platform-http:/roll-dice'
steps:
- set-body:
simple: 'roll: $simple{random(1,6)}'
simple: 'roll: $simple{random(1,7)}'