This is an automated email from the ASF dual-hosted git repository. jamesnetherton pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel-quarkus.git
commit ee337cb4e9c92feb1d3e0b0fb2585d0f3bc3117a Author: Luca Burgazzoli <lburgazz...@gmail.com> AuthorDate: Mon Mar 25 10:14:12 2024 +0100 Move Kubernetes cluster service to its own module --- docs/modules/ROOT/nav.adoc | 1 + ...rnetes.adoc => kubernetes-cluster-service.adoc} | 85 +++----------- .../pages/reference/extensions/kubernetes.adoc | 124 --------------------- .../deployment/pom.xml | 12 +- .../KubernetesClusterServiceProcessor.java | 0 .../KubernetesClusterServiceConfigDefaultTest.java | 2 +- ...terServiceConfigEnabledWithRebalancingTest.java | 3 +- ...terServiceConfigEnabledWithoutDefaultsTest.java | 3 +- ...ServiceConfigEnabledWithoutRebalancingTest.java | 3 +- extensions/kubernetes-cluster-service/pom.xml | 37 ++++++ .../runtime}/pom.xml | 56 ++++++++-- .../runtime/src/main/doc/configuration.adoc | 23 ---- .../KubernetesClusterServiceBuildTimeConfig.java | 8 +- .../cluster/KubernetesClusterServiceRecorder.java | 0 .../KubernetesClusterServiceRuntimeConfig.java | 0 .../main/resources/META-INF/quarkus-extension.yaml | 32 ++++++ extensions/kubernetes/deployment/pom.xml | 5 - .../runtime/src/main/doc/configuration.adoc | 23 ---- extensions/pom.xml | 1 + integration-tests/master-openshift/pom.xml | 4 + .../src/main/resources/application.properties | 1 - poms/bom/pom.xml | 10 ++ 22 files changed, 160 insertions(+), 273 deletions(-) diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index 36658c68d6..8256a43780 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -86,6 +86,7 @@ *** xref:reference/extensions/chunk.adoc[Chunk] *** xref:reference/extensions/core-cloud.adoc[Cloud] *** xref:reference/extensions/cloudevents.adoc[Cloudevents] +*** xref:reference/extensions/kubernetes-cluster-service.adoc[Cluster Service] *** xref:reference/extensions/coap.adoc[CoAP] *** xref:reference/extensions/cometd.adoc[CometD] *** xref:reference/extensions/console.adoc[Console] diff --git a/docs/modules/ROOT/pages/reference/extensions/kubernetes.adoc b/docs/modules/ROOT/pages/reference/extensions/kubernetes-cluster-service.adoc similarity index 53% copy from docs/modules/ROOT/pages/reference/extensions/kubernetes.adoc copy to docs/modules/ROOT/pages/reference/extensions/kubernetes-cluster-service.adoc index 97fc2967c9..5e16fe5891 100644 --- a/docs/modules/ROOT/pages/reference/extensions/kubernetes.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/kubernetes-cluster-service.adoc @@ -1,55 +1,28 @@ // Do not edit directly! // This file was generated by camel-quarkus-maven-plugin:update-extension-doc-page -[id="extensions-kubernetes"] -= Kubernetes -:page-aliases: extensions/kubernetes.adoc +[id="extensions-kubernetes-cluster-service"] += Kubernetes Cluster Service :linkattrs: -:cq-artifact-id: camel-quarkus-kubernetes +:cq-artifact-id: camel-quarkus-kubernetes-cluster-service :cq-native-supported: true :cq-status: Stable :cq-status-deprecation: Stable -:cq-description: Perform operations against Kubernetes API +:cq-description: Provides a Kubernetes implementation of the Camel Cluster Service SPI :cq-deprecated: false -:cq-jvm-since: 1.0.0 -:cq-native-since: 1.0.0 +:cq-jvm-since: 3.10.0 +:cq-native-since: 3.10.0 ifeval::[{doc-show-badges} == true] [.badges] -[.badge-key]##JVM since##[.badge-supported]##1.0.0## [.badge-key]##Native since##[.badge-supported]##1.0.0## +[.badge-key]##JVM since##[.badge-supported]##3.10.0## [.badge-key]##Native since##[.badge-supported]##3.10.0## endif::[] -Perform operations against Kubernetes API - -[id="extensions-kubernetes-whats-inside"] -== What's inside - -* xref:{cq-camel-components}::kubernetes-config-maps-component.adoc[Kubernetes ConfigMap component], URI syntax: `kubernetes-config-maps:masterUrl` -* xref:{cq-camel-components}::kubernetes-cronjob-component.adoc[Kubernetes Cronjob component], URI syntax: `kubernetes-cronjob:masterUrl` -* xref:{cq-camel-components}::kubernetes-custom-resources-component.adoc[Kubernetes Custom Resources component], URI syntax: `kubernetes-custom-resources:masterUrl` -* xref:{cq-camel-components}::kubernetes-deployments-component.adoc[Kubernetes Deployments component], URI syntax: `kubernetes-deployments:masterUrl` -* xref:{cq-camel-components}::kubernetes-events-component.adoc[Kubernetes Event component], URI syntax: `kubernetes-events:masterUrl` -* xref:{cq-camel-components}::kubernetes-hpa-component.adoc[Kubernetes HPA component], URI syntax: `kubernetes-hpa:masterUrl` -* xref:{cq-camel-components}::kubernetes-job-component.adoc[Kubernetes Job component], URI syntax: `kubernetes-job:masterUrl` -* xref:{cq-camel-components}::kubernetes-namespaces-component.adoc[Kubernetes Namespaces component], URI syntax: `kubernetes-namespaces:masterUrl` -* xref:{cq-camel-components}::kubernetes-nodes-component.adoc[Kubernetes Nodes component], URI syntax: `kubernetes-nodes:masterUrl` -* xref:{cq-camel-components}::kubernetes-persistent-volumes-component.adoc[Kubernetes Persistent Volume component], URI syntax: `kubernetes-persistent-volumes:masterUrl` -* xref:{cq-camel-components}::kubernetes-persistent-volumes-claims-component.adoc[Kubernetes Persistent Volume Claim component], URI syntax: `kubernetes-persistent-volumes-claims:masterUrl` -* xref:{cq-camel-components}::kubernetes-pods-component.adoc[Kubernetes Pods component], URI syntax: `kubernetes-pods:masterUrl` -* xref:{cq-camel-components}::kubernetes-replication-controllers-component.adoc[Kubernetes Replication Controller component], URI syntax: `kubernetes-replication-controllers:masterUrl` -* xref:{cq-camel-components}::kubernetes-resources-quota-component.adoc[Kubernetes Resources Quota component], URI syntax: `kubernetes-resources-quota:masterUrl` -* xref:{cq-camel-components}::kubernetes-secrets-component.adoc[Kubernetes Secrets component], URI syntax: `kubernetes-secrets:masterUrl` -* xref:{cq-camel-components}::kubernetes-service-accounts-component.adoc[Kubernetes Service Account component], URI syntax: `kubernetes-service-accounts:masterUrl` -* xref:{cq-camel-components}::kubernetes-services-component.adoc[Kubernetes Services component], URI syntax: `kubernetes-services:masterUrl` -* xref:{cq-camel-components}::openshift-build-configs-component.adoc[Openshift Build Config component], URI syntax: `openshift-build-configs:masterUrl` -* xref:{cq-camel-components}::openshift-builds-component.adoc[Openshift Builds component], URI syntax: `openshift-builds:masterUrl` -* xref:{cq-camel-components}::openshift-deploymentconfigs-component.adoc[Openshift Deployment Configs component], URI syntax: `openshift-deploymentconfigs:masterUrl` - -Please refer to the above links for usage and configuration details. - -[id="extensions-kubernetes-maven-coordinates"] +Provides a Kubernetes implementation of the Camel Cluster Service SPI + +[id="extensions-kubernetes-cluster-service-maven-coordinates"] == Maven coordinates -https://{link-quarkus-code-generator}/?extension-search=camel-quarkus-kubernetes[Create a new project with this extension on {link-quarkus-code-generator}, window="_blank"] +https://{link-quarkus-code-generator}/?extension-search=camel-quarkus-kubernetes-cluster-service[Create a new project with this extension on {link-quarkus-code-generator}, window="_blank"] Or add the coordinates to your existing project: @@ -57,39 +30,21 @@ Or add the coordinates to your existing project: ---- <dependency> <groupId>org.apache.camel.quarkus</groupId> - <artifactId>camel-quarkus-kubernetes</artifactId> + <artifactId>camel-quarkus-kubernetes-cluster-service</artifactId> </dependency> ---- ifeval::[{doc-show-user-guide-link} == true] Check the xref:user-guide/index.adoc[User guide] for more information about writing Camel Quarkus applications. endif::[] -[id="extensions-kubernetes-additional-camel-quarkus-configuration"] +[id="extensions-kubernetes-cluster-service-additional-camel-quarkus-configuration"] == Additional Camel Quarkus configuration ifeval::[{doc-show-extra-content} == true] include::extra-content.adoc[] endif::[] -[id="extensions-kubernetes-configuration-automatic-registration-of-a-kubernetes-client-instance"] -=== Automatic registration of a Kubernetes Client instance - -The extension automatically registers a Kubernetes Client bean named `kubernetesClient`. You can reference the bean in your routes like this: - - from("direct:pods") - .to("kubernetes-pods:///?kubernetesClient=#kubernetesClient&operation=listPods") - -By default the client is configured from the local kubeconfig file. You can customize the client configuration via properties within `application.properties`: - -[source,properties] ----- -quarkus.kubernetes-client.master-url=https://my.k8s.host -quarkus.kubernetes-client.namespace=my-namespace ----- - -The full set of configuration options are documented in the https://quarkus.io/guides/kubernetes-client#quarkus-kubernetes-client_configuration[Quarkus Kubernetes Client guide]. - -[id="extensions-kubernetes-configuration-having-only-a-single-consumer-in-a-cluster-consuming-from-a-given-endpoint"] +[id="extensions-kubernetes-cluster-service-configuration-having-only-a-single-consumer-in-a-cluster-consuming-from-a-given-endpoint"] === Having only a single consumer in a cluster consuming from a given endpoint When the same route is deployed on multiple pods, it could be interesting to use this extension in conjunction with the xref:reference/extensions/master.adoc[Master one]. @@ -101,12 +56,6 @@ For instance, having the route below deployed on multiple pods: from("master:ns:timer:test?period=100").log("Timer invoked on a single pod at a time"); ``` -It's possible to enable the kubernetes cluster service with a property like below: - -``` -quarkus.camel.cluster.kubernetes.enabled = true -``` - As a result, a single consumer will be active across the `ns` camel master namespace. It means that, at a given time, only a single timer will generate exchanges across the whole cluster. In other words, messages will be logged every 100ms on a single pod at a time. @@ -119,12 +68,6 @@ The kubernetes cluster service could further be tuned by tweaking `quarkus.camel | Configuration property | Type | Default -|icon:lock[title=Fixed at build time] [[quarkus.camel.cluster.kubernetes.enabled]]`link:#quarkus.camel.cluster.kubernetes.enabled[quarkus.camel.cluster.kubernetes.enabled]` - -Whether a Kubernetes Cluster Service should be automatically configured according to 'quarkus.camel.cluster.kubernetes.++*++' configurations. -| `boolean` -| `false` - |icon:lock[title=Fixed at build time] [[quarkus.camel.cluster.kubernetes.rebalancing]]`link:#quarkus.camel.cluster.kubernetes.rebalancing[quarkus.camel.cluster.kubernetes.rebalancing]` Whether the camel master namespace leaders should be distributed evenly across all the camel contexts in the cluster. diff --git a/docs/modules/ROOT/pages/reference/extensions/kubernetes.adoc b/docs/modules/ROOT/pages/reference/extensions/kubernetes.adoc index 97fc2967c9..31e2b10df4 100644 --- a/docs/modules/ROOT/pages/reference/extensions/kubernetes.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/kubernetes.adoc @@ -89,127 +89,3 @@ quarkus.kubernetes-client.namespace=my-namespace The full set of configuration options are documented in the https://quarkus.io/guides/kubernetes-client#quarkus-kubernetes-client_configuration[Quarkus Kubernetes Client guide]. -[id="extensions-kubernetes-configuration-having-only-a-single-consumer-in-a-cluster-consuming-from-a-given-endpoint"] -=== Having only a single consumer in a cluster consuming from a given endpoint - -When the same route is deployed on multiple pods, it could be interesting to use this extension in conjunction with the xref:reference/extensions/master.adoc[Master one]. -In such a setup, a single consumer will be active at a time across the whole camel master namespace. - -For instance, having the route below deployed on multiple pods: - -``` -from("master:ns:timer:test?period=100").log("Timer invoked on a single pod at a time"); -``` - -It's possible to enable the kubernetes cluster service with a property like below: - -``` -quarkus.camel.cluster.kubernetes.enabled = true -``` - -As a result, a single consumer will be active across the `ns` camel master namespace. -It means that, at a given time, only a single timer will generate exchanges across the whole cluster. -In other words, messages will be logged every 100ms on a single pod at a time. - -The kubernetes cluster service could further be tuned by tweaking `quarkus.camel.cluster.kubernetes.*` properties. - - -[width="100%",cols="80,5,15",options="header"] -|=== -| Configuration property | Type | Default - - -|icon:lock[title=Fixed at build time] [[quarkus.camel.cluster.kubernetes.enabled]]`link:#quarkus.camel.cluster.kubernetes.enabled[quarkus.camel.cluster.kubernetes.enabled]` - -Whether a Kubernetes Cluster Service should be automatically configured according to 'quarkus.camel.cluster.kubernetes.++*++' configurations. -| `boolean` -| `false` - -|icon:lock[title=Fixed at build time] [[quarkus.camel.cluster.kubernetes.rebalancing]]`link:#quarkus.camel.cluster.kubernetes.rebalancing[quarkus.camel.cluster.kubernetes.rebalancing]` - -Whether the camel master namespace leaders should be distributed evenly across all the camel contexts in the cluster. -| `boolean` -| `true` - -| [[quarkus.camel.cluster.kubernetes.id]]`link:#quarkus.camel.cluster.kubernetes.id[quarkus.camel.cluster.kubernetes.id]` - -The cluster service ID (defaults to null). -| `string` -| - -| [[quarkus.camel.cluster.kubernetes.master-url]]`link:#quarkus.camel.cluster.kubernetes.master-url[quarkus.camel.cluster.kubernetes.master-url]` - -The URL of the Kubernetes master (read from Kubernetes client properties by default). -| `string` -| - -| [[quarkus.camel.cluster.kubernetes.connection-timeout-millis]]`link:#quarkus.camel.cluster.kubernetes.connection-timeout-millis[quarkus.camel.cluster.kubernetes.connection-timeout-millis]` - -The connection timeout in milliseconds to use when making requests to the Kubernetes API server. -| `java.lang.Integer` -| - -| [[quarkus.camel.cluster.kubernetes.namespace]]`link:#quarkus.camel.cluster.kubernetes.namespace[quarkus.camel.cluster.kubernetes.namespace]` - -The name of the Kubernetes namespace containing the pods and the configmap (autodetected by default). -| `string` -| - -| [[quarkus.camel.cluster.kubernetes.pod-name]]`link:#quarkus.camel.cluster.kubernetes.pod-name[quarkus.camel.cluster.kubernetes.pod-name]` - -The name of the current pod (autodetected from container host name by default). -| `string` -| - -| [[quarkus.camel.cluster.kubernetes.jitter-factor]]`link:#quarkus.camel.cluster.kubernetes.jitter-factor[quarkus.camel.cluster.kubernetes.jitter-factor]` - -The jitter factor to apply in order to prevent all pods to call Kubernetes APIs in the same instant (defaults to 1.2). -| `java.lang.Double` -| - -| [[quarkus.camel.cluster.kubernetes.lease-duration-millis]]`link:#quarkus.camel.cluster.kubernetes.lease-duration-millis[quarkus.camel.cluster.kubernetes.lease-duration-millis]` - -The default duration of the lease for the current leader (defaults to 15000). -| `java.lang.Long` -| - -| [[quarkus.camel.cluster.kubernetes.renew-deadline-millis]]`link:#quarkus.camel.cluster.kubernetes.renew-deadline-millis[quarkus.camel.cluster.kubernetes.renew-deadline-millis]` - -The deadline after which the leader must stop its services because it may have lost the leadership (defaults to 10000). -| `java.lang.Long` -| - -| [[quarkus.camel.cluster.kubernetes.retry-period-millis]]`link:#quarkus.camel.cluster.kubernetes.retry-period-millis[quarkus.camel.cluster.kubernetes.retry-period-millis]` - -The time between two subsequent attempts to check and acquire the leadership. It is randomized using the jitter factor (defaults to 2000). -| `java.lang.Long` -| - -| [[quarkus.camel.cluster.kubernetes.order]]`link:#quarkus.camel.cluster.kubernetes.order[quarkus.camel.cluster.kubernetes.order]` - -Service lookup order/priority (defaults to 2147482647). -| `java.lang.Integer` -| - -| [[quarkus.camel.cluster.kubernetes.resource-name]]`link:#quarkus.camel.cluster.kubernetes.resource-name[quarkus.camel.cluster.kubernetes.resource-name]` - -The name of the lease resource used to do optimistic locking (defaults to 'leaders'). The resource name is used as prefix when the underlying Kubernetes resource can manage a single lock. -| `string` -| - -| [[quarkus.camel.cluster.kubernetes.lease-resource-type]]`link:#quarkus.camel.cluster.kubernetes.lease-resource-type[quarkus.camel.cluster.kubernetes.lease-resource-type]` - -The lease resource type used in Kubernetes, either 'config-map' or 'lease' (defaults to 'lease'). -| `org.apache.camel.component.kubernetes.cluster.LeaseResourceType` -| - -| [[quarkus.camel.cluster.kubernetes.labels]]`link:#quarkus.camel.cluster.kubernetes.labels[quarkus.camel.cluster.kubernetes.labels]` - -The labels key/value used to identify the pods composing the cluster, defaults to empty map. -| ``Map<String,String>`` -| -|=== - -[.configuration-legend] -{doc-link-icon-lock}[title=Fixed at build time] Configuration property fixed at build time. All other configuration properties are overridable at runtime. - diff --git a/extensions/kubernetes/deployment/pom.xml b/extensions/kubernetes-cluster-service/deployment/pom.xml similarity index 85% copy from extensions/kubernetes/deployment/pom.xml copy to extensions/kubernetes-cluster-service/deployment/pom.xml index 06d69a2454..b46c8f2157 100644 --- a/extensions/kubernetes/deployment/pom.xml +++ b/extensions/kubernetes-cluster-service/deployment/pom.xml @@ -21,13 +21,13 @@ <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.apache.camel.quarkus</groupId> - <artifactId>camel-quarkus-kubernetes-parent</artifactId> + <artifactId>camel-quarkus-kubernetes-cluster-service-parent</artifactId> <version>3.10.0-SNAPSHOT</version> <relativePath>../pom.xml</relativePath> </parent> - <artifactId>camel-quarkus-kubernetes-deployment</artifactId> - <name>Camel Quarkus :: Kubernetes :: Deployment</name> + <artifactId>camel-quarkus-kubernetes-cluster-service-deployment</artifactId> + <name>Camel Quarkus :: Kubernetes Cluster Service :: Deployment</name> <dependencies> <dependency> @@ -48,7 +48,11 @@ </dependency> <dependency> <groupId>org.apache.camel.quarkus</groupId> - <artifactId>camel-quarkus-kubernetes</artifactId> + <artifactId>camel-quarkus-kubernetes-deployment</artifactId> + </dependency> + <dependency> + <groupId>org.apache.camel.quarkus</groupId> + <artifactId>camel-quarkus-kubernetes-cluster-service</artifactId> </dependency> <dependency> <groupId>io.quarkus</groupId> diff --git a/extensions/kubernetes/deployment/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceProcessor.java b/extensions/kubernetes-cluster-service/deployment/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceProcessor.java similarity index 100% rename from extensions/kubernetes/deployment/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceProcessor.java rename to extensions/kubernetes-cluster-service/deployment/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceProcessor.java diff --git a/extensions/kubernetes/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigDefaultTest.java b/extensions/kubernetes-cluster-service/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigDefaultTest.java similarity index 97% rename from extensions/kubernetes/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigDefaultTest.java rename to extensions/kubernetes-cluster-service/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigDefaultTest.java index 2d4fd38c98..33793443b0 100644 --- a/extensions/kubernetes/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigDefaultTest.java +++ b/extensions/kubernetes-cluster-service/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigDefaultTest.java @@ -40,7 +40,7 @@ public class KubernetesClusterServiceConfigDefaultTest { .setArchiveProducer(() -> ShrinkWrap.create(JavaArchive.class).addAsResource(applicationProperties(), "application.properties")); - public static final Asset applicationProperties() { + public static Asset applicationProperties() { Writer writer = new StringWriter(); Properties props = new Properties(); diff --git a/extensions/kubernetes/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigEnabledWithRebalancingTest.java b/extensions/kubernetes-cluster-service/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigEnabledWithRebalancingTest.java similarity index 95% rename from extensions/kubernetes/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigEnabledWithRebalancingTest.java rename to extensions/kubernetes-cluster-service/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigEnabledWithRebalancingTest.java index 7c4196e2ca..f5499a6507 100644 --- a/extensions/kubernetes/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigEnabledWithRebalancingTest.java +++ b/extensions/kubernetes-cluster-service/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigEnabledWithRebalancingTest.java @@ -40,11 +40,10 @@ public class KubernetesClusterServiceConfigEnabledWithRebalancingTest { .setArchiveProducer(() -> ShrinkWrap.create(JavaArchive.class).addAsResource(applicationProperties(), "application.properties")); - public static final Asset applicationProperties() { + public static Asset applicationProperties() { Writer writer = new StringWriter(); Properties props = new Properties(); - props.setProperty("quarkus.camel.cluster.kubernetes.enabled", "true"); try { props.store(writer, ""); diff --git a/extensions/kubernetes/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigEnabledWithoutDefaultsTest.java b/extensions/kubernetes-cluster-service/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigEnabledWithoutDefaultsTest.java similarity index 97% rename from extensions/kubernetes/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigEnabledWithoutDefaultsTest.java rename to extensions/kubernetes-cluster-service/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigEnabledWithoutDefaultsTest.java index 089820d4d8..7633422e4b 100644 --- a/extensions/kubernetes/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigEnabledWithoutDefaultsTest.java +++ b/extensions/kubernetes-cluster-service/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigEnabledWithoutDefaultsTest.java @@ -43,11 +43,10 @@ public class KubernetesClusterServiceConfigEnabledWithoutDefaultsTest { .setArchiveProducer(() -> ShrinkWrap.create(JavaArchive.class).addAsResource(applicationProperties(), "application.properties")); - public static final Asset applicationProperties() { + public static Asset applicationProperties() { Writer writer = new StringWriter(); Properties props = new Properties(); - props.setProperty("quarkus.camel.cluster.kubernetes.enabled", "true"); props.setProperty("quarkus.camel.cluster.kubernetes.id", "kcs-id"); props.setProperty("quarkus.camel.cluster.kubernetes.master-url", "kcs-master-url"); props.setProperty("quarkus.camel.cluster.kubernetes.connection-timeout-millis", "5033"); diff --git a/extensions/kubernetes/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigEnabledWithoutRebalancingTest.java b/extensions/kubernetes-cluster-service/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigEnabledWithoutRebalancingTest.java similarity index 96% rename from extensions/kubernetes/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigEnabledWithoutRebalancingTest.java rename to extensions/kubernetes-cluster-service/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigEnabledWithoutRebalancingTest.java index 281062bd5c..c2f1df0115 100644 --- a/extensions/kubernetes/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigEnabledWithoutRebalancingTest.java +++ b/extensions/kubernetes-cluster-service/deployment/src/test/java/org/apache/camel/quarkus/component/kubernetes/cluster/deployment/KubernetesClusterServiceConfigEnabledWithoutRebalancingTest.java @@ -45,11 +45,10 @@ public class KubernetesClusterServiceConfigEnabledWithoutRebalancingTest { .setArchiveProducer(() -> ShrinkWrap.create(JavaArchive.class).addAsResource(applicationProperties(), "application.properties")); - public static final Asset applicationProperties() { + public static Asset applicationProperties() { Writer writer = new StringWriter(); Properties props = new Properties(); - props.setProperty("quarkus.camel.cluster.kubernetes.enabled", "true"); props.setProperty("quarkus.camel.cluster.kubernetes.rebalancing", "false"); try { diff --git a/extensions/kubernetes-cluster-service/pom.xml b/extensions/kubernetes-cluster-service/pom.xml new file mode 100644 index 0000000000..5d268f73f4 --- /dev/null +++ b/extensions/kubernetes-cluster-service/pom.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + + 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. + +--> +<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 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + <modelVersion>4.0.0</modelVersion> + <parent> + <groupId>org.apache.camel.quarkus</groupId> + <artifactId>camel-quarkus-extensions</artifactId> + <version>3.10.0-SNAPSHOT</version> + <relativePath>../pom.xml</relativePath> + </parent> + + <artifactId>camel-quarkus-kubernetes-cluster-service-parent</artifactId> + <name>Camel Quarkus :: Kubernetes Cluster Service</name> + <packaging>pom</packaging> + + <modules> + <module>deployment</module> + <module>runtime</module> + </modules> +</project> diff --git a/extensions/kubernetes/deployment/pom.xml b/extensions/kubernetes-cluster-service/runtime/pom.xml similarity index 57% copy from extensions/kubernetes/deployment/pom.xml copy to extensions/kubernetes-cluster-service/runtime/pom.xml index 06d69a2454..aaa916b725 100644 --- a/extensions/kubernetes/deployment/pom.xml +++ b/extensions/kubernetes-cluster-service/runtime/pom.xml @@ -21,44 +21,49 @@ <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.apache.camel.quarkus</groupId> - <artifactId>camel-quarkus-kubernetes-parent</artifactId> + <artifactId>camel-quarkus-kubernetes-cluster-service-parent</artifactId> <version>3.10.0-SNAPSHOT</version> <relativePath>../pom.xml</relativePath> </parent> - <artifactId>camel-quarkus-kubernetes-deployment</artifactId> - <name>Camel Quarkus :: Kubernetes :: Deployment</name> + <artifactId>camel-quarkus-kubernetes-cluster-service</artifactId> + <name>Camel Quarkus :: Kubernetes Cluster Service :: Runtime</name> + <description>Provides a Kubernetes implementation of the Camel Cluster Service SPI</description> + + <properties> + <camel.quarkus.jvmSince>3.10.0</camel.quarkus.jvmSince> + <camel.quarkus.nativeSince>3.10.0</camel.quarkus.nativeSince> + </properties> <dependencies> <dependency> <groupId>io.quarkus</groupId> - <artifactId>quarkus-kubernetes-client-deployment</artifactId> + <artifactId>quarkus-kubernetes-client</artifactId> </dependency> <dependency> <groupId>org.apache.camel.quarkus</groupId> - <artifactId>camel-quarkus-core-deployment</artifactId> + <artifactId>camel-quarkus-core</artifactId> </dependency> <dependency> <groupId>org.apache.camel.quarkus</groupId> - <artifactId>camel-quarkus-core-cloud-deployment</artifactId> + <artifactId>camel-quarkus-core-cloud</artifactId> </dependency> <dependency> <groupId>org.apache.camel.quarkus</groupId> - <artifactId>camel-quarkus-support-commons-logging-deployment</artifactId> + <artifactId>camel-quarkus-support-commons-logging</artifactId> </dependency> <dependency> <groupId>org.apache.camel.quarkus</groupId> <artifactId>camel-quarkus-kubernetes</artifactId> </dependency> - <dependency> - <groupId>io.quarkus</groupId> - <artifactId>quarkus-junit5-internal</artifactId> - <scope>test</scope> - </dependency> </dependencies> <build> <plugins> + <plugin> + <groupId>io.quarkus</groupId> + <artifactId>quarkus-extension-maven-plugin</artifactId> + </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> @@ -75,4 +80,31 @@ </plugins> </build> + <profiles> + <profile> + <id>full</id> + <activation> + <property> + <name>!quickly</name> + </property> + </activation> + <build> + <plugins> + <plugin> + <groupId>org.apache.camel.quarkus</groupId> + <artifactId>camel-quarkus-maven-plugin</artifactId> + <executions> + <execution> + <id>update-extension-doc-page</id> + <goals> + <goal>update-extension-doc-page</goal> + </goals> + <phase>process-classes</phase> + </execution> + </executions> + </plugin> + </plugins> + </build> + </profile> + </profiles> </project> diff --git a/extensions/kubernetes/runtime/src/main/doc/configuration.adoc b/extensions/kubernetes-cluster-service/runtime/src/main/doc/configuration.adoc similarity index 51% copy from extensions/kubernetes/runtime/src/main/doc/configuration.adoc copy to extensions/kubernetes-cluster-service/runtime/src/main/doc/configuration.adoc index 8acafeb39f..2655415293 100644 --- a/extensions/kubernetes/runtime/src/main/doc/configuration.adoc +++ b/extensions/kubernetes-cluster-service/runtime/src/main/doc/configuration.adoc @@ -2,23 +2,6 @@ ifeval::[{doc-show-extra-content} == true] include::extra-content.adoc[] endif::[] -=== Automatic registration of a Kubernetes Client instance - -The extension automatically registers a Kubernetes Client bean named `kubernetesClient`. You can reference the bean in your routes like this: - - from("direct:pods") - .to("kubernetes-pods:///?kubernetesClient=#kubernetesClient&operation=listPods") - -By default the client is configured from the local kubeconfig file. You can customize the client configuration via properties within `application.properties`: - -[source,properties] ----- -quarkus.kubernetes-client.master-url=https://my.k8s.host -quarkus.kubernetes-client.namespace=my-namespace ----- - -The full set of configuration options are documented in the https://quarkus.io/guides/kubernetes-client#quarkus-kubernetes-client_configuration[Quarkus Kubernetes Client guide]. - === Having only a single consumer in a cluster consuming from a given endpoint When the same route is deployed on multiple pods, it could be interesting to use this extension in conjunction with the xref:reference/extensions/master.adoc[Master one]. @@ -30,12 +13,6 @@ For instance, having the route below deployed on multiple pods: from("master:ns:timer:test?period=100").log("Timer invoked on a single pod at a time"); ``` -It's possible to enable the kubernetes cluster service with a property like below: - -``` -quarkus.camel.cluster.kubernetes.enabled = true -``` - As a result, a single consumer will be active across the `ns` camel master namespace. It means that, at a given time, only a single timer will generate exchanges across the whole cluster. In other words, messages will be logged every 100ms on a single pod at a time. diff --git a/extensions/kubernetes/runtime/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/KubernetesClusterServiceBuildTimeConfig.java b/extensions/kubernetes-cluster-service/runtime/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/KubernetesClusterServiceBuildTimeConfig.java similarity index 87% rename from extensions/kubernetes/runtime/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/KubernetesClusterServiceBuildTimeConfig.java rename to extensions/kubernetes-cluster-service/runtime/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/KubernetesClusterServiceBuildTimeConfig.java index 7d992f6e8f..024f282cdf 100644 --- a/extensions/kubernetes/runtime/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/KubernetesClusterServiceBuildTimeConfig.java +++ b/extensions/kubernetes-cluster-service/runtime/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/KubernetesClusterServiceBuildTimeConfig.java @@ -24,12 +24,15 @@ import io.quarkus.runtime.annotations.ConfigRoot; @ConfigRoot(name = "camel.cluster.kubernetes", phase = ConfigPhase.BUILD_AND_RUN_TIME_FIXED) public class KubernetesClusterServiceBuildTimeConfig { - /** * Whether a Kubernetes Cluster Service should be automatically configured * according to 'quarkus.camel.cluster.kubernetes.*' configurations. + * + * @deprecated this property is no longer needed as the Kubernetes implementation of the Camel CLuster Service API has + * been moved to a dedicated extension. */ - @ConfigItem(defaultValue = "false") + @Deprecated(since = "3.10.0", forRemoval = true) + @ConfigItem(defaultValue = "true") public boolean enabled; /** @@ -47,5 +50,4 @@ public class KubernetesClusterServiceBuildTimeConfig { return config.enabled; } } - } diff --git a/extensions/kubernetes/runtime/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/KubernetesClusterServiceRecorder.java b/extensions/kubernetes-cluster-service/runtime/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/KubernetesClusterServiceRecorder.java similarity index 100% rename from extensions/kubernetes/runtime/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/KubernetesClusterServiceRecorder.java rename to extensions/kubernetes-cluster-service/runtime/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/KubernetesClusterServiceRecorder.java diff --git a/extensions/kubernetes/runtime/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/KubernetesClusterServiceRuntimeConfig.java b/extensions/kubernetes-cluster-service/runtime/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/KubernetesClusterServiceRuntimeConfig.java similarity index 100% rename from extensions/kubernetes/runtime/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/KubernetesClusterServiceRuntimeConfig.java rename to extensions/kubernetes-cluster-service/runtime/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/KubernetesClusterServiceRuntimeConfig.java diff --git a/extensions/kubernetes-cluster-service/runtime/src/main/resources/META-INF/quarkus-extension.yaml b/extensions/kubernetes-cluster-service/runtime/src/main/resources/META-INF/quarkus-extension.yaml new file mode 100644 index 0000000000..fa4ee1da47 --- /dev/null +++ b/extensions/kubernetes-cluster-service/runtime/src/main/resources/META-INF/quarkus-extension.yaml @@ -0,0 +1,32 @@ +# +# 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. +# + +# This is a generated file. Do not edit directly! +# To re-generate, run the following command from the top level directory: +# +# mvn -N cq:update-quarkus-metadata +# +--- +name: "Camel Kubernetes Cluster Service" +description: "Provides a Kubernetes implementation of the Camel Cluster Service SPI" +metadata: + icon-url: "https://raw.githubusercontent.com/apache/camel-website/main/antora-ui-camel/src/img/logo-d.svg" + guide: "https://camel.apache.org/camel-quarkus/latest/reference/extensions/kubernetes-cluster-service.html" + categories: + - "integration" + status: + - "stable" diff --git a/extensions/kubernetes/deployment/pom.xml b/extensions/kubernetes/deployment/pom.xml index 06d69a2454..b31f828b0a 100644 --- a/extensions/kubernetes/deployment/pom.xml +++ b/extensions/kubernetes/deployment/pom.xml @@ -50,11 +50,6 @@ <groupId>org.apache.camel.quarkus</groupId> <artifactId>camel-quarkus-kubernetes</artifactId> </dependency> - <dependency> - <groupId>io.quarkus</groupId> - <artifactId>quarkus-junit5-internal</artifactId> - <scope>test</scope> - </dependency> </dependencies> <build> diff --git a/extensions/kubernetes/runtime/src/main/doc/configuration.adoc b/extensions/kubernetes/runtime/src/main/doc/configuration.adoc index 8acafeb39f..01a10f2421 100644 --- a/extensions/kubernetes/runtime/src/main/doc/configuration.adoc +++ b/extensions/kubernetes/runtime/src/main/doc/configuration.adoc @@ -18,26 +18,3 @@ quarkus.kubernetes-client.namespace=my-namespace ---- The full set of configuration options are documented in the https://quarkus.io/guides/kubernetes-client#quarkus-kubernetes-client_configuration[Quarkus Kubernetes Client guide]. - -=== Having only a single consumer in a cluster consuming from a given endpoint - -When the same route is deployed on multiple pods, it could be interesting to use this extension in conjunction with the xref:reference/extensions/master.adoc[Master one]. -In such a setup, a single consumer will be active at a time across the whole camel master namespace. - -For instance, having the route below deployed on multiple pods: - -``` -from("master:ns:timer:test?period=100").log("Timer invoked on a single pod at a time"); -``` - -It's possible to enable the kubernetes cluster service with a property like below: - -``` -quarkus.camel.cluster.kubernetes.enabled = true -``` - -As a result, a single consumer will be active across the `ns` camel master namespace. -It means that, at a given time, only a single timer will generate exchanges across the whole cluster. -In other words, messages will be logged every 100ms on a single pod at a time. - -The kubernetes cluster service could further be tuned by tweaking `quarkus.camel.cluster.kubernetes.*` properties. diff --git a/extensions/pom.xml b/extensions/pom.xml index fdf2541c22..dd0e224fc3 100644 --- a/extensions/pom.xml +++ b/extensions/pom.xml @@ -161,6 +161,7 @@ <module>kotlin</module> <module>kotlin-dsl</module> <module>kubernetes</module> + <module>kubernetes-cluster-service</module> <module>kudu</module> <module>language</module> <module>ldap</module> diff --git a/integration-tests/master-openshift/pom.xml b/integration-tests/master-openshift/pom.xml index 7a8d7380ff..560970297c 100644 --- a/integration-tests/master-openshift/pom.xml +++ b/integration-tests/master-openshift/pom.xml @@ -43,6 +43,10 @@ <groupId>org.apache.camel.quarkus</groupId> <artifactId>camel-quarkus-kubernetes</artifactId> </dependency> + <dependency> + <groupId>org.apache.camel.quarkus</groupId> + <artifactId>camel-quarkus-kubernetes-cluster-service</artifactId> + </dependency> <dependency> <groupId>org.apache.camel.quarkus</groupId> <artifactId>camel-quarkus-log</artifactId> diff --git a/integration-tests/master-openshift/src/main/resources/application.properties b/integration-tests/master-openshift/src/main/resources/application.properties index c2751a5943..59c55c7848 100644 --- a/integration-tests/master-openshift/src/main/resources/application.properties +++ b/integration-tests/master-openshift/src/main/resources/application.properties @@ -17,5 +17,4 @@ application.id = leader -quarkus.camel.cluster.kubernetes.enabled = true quarkus.camel.cluster.kubernetes.rebalancing = false diff --git a/poms/bom/pom.xml b/poms/bom/pom.xml index 446911b9ba..4380dc1534 100644 --- a/poms/bom/pom.xml +++ b/poms/bom/pom.xml @@ -4500,6 +4500,16 @@ <artifactId>camel-quarkus-kubernetes-deployment</artifactId> <version>${camel-quarkus.version}</version> </dependency> + <dependency> + <groupId>org.apache.camel.quarkus</groupId> + <artifactId>camel-quarkus-kubernetes-cluster-service</artifactId> + <version>${camel-quarkus.version}</version> + </dependency> + <dependency> + <groupId>org.apache.camel.quarkus</groupId> + <artifactId>camel-quarkus-kubernetes-cluster-service-deployment</artifactId> + <version>${camel-quarkus.version}</version> + </dependency> <dependency> <groupId>org.apache.camel.quarkus</groupId> <artifactId>camel-quarkus-kudu</artifactId>