(camel) branch main updated: chore(doc): adding a note to explain a Kamelet calling another Kamelet

[pc...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

pcongiusti 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 b3faca57e5c chore(doc): adding a note to explain a Kamelet calling another Kamelet
b3faca57e5c is described below

commit b3faca57e5c421cde65d1dafd0ccd5f16c92c88f
Author: Pasquale Congiusti <pa...@gmail.com>
AuthorDate: Wed Feb 19 11:33:33 2025 +0100

    chore(doc): adding a note to explain a Kamelet calling another Kamelet
---
 .../src/main/docs/kamelet-component.adoc           | 54 ++++++++++++++++++++++
 1 file changed, 54 insertions(+)

diff --git a/components/camel-kamelet/src/main/docs/kamelet-component.adoc b/components/camel-kamelet/src/main/docs/kamelet-component.adoc
index f00bde4d287..d958bd83756 100644
--- a/components/camel-kamelet/src/main/docs/kamelet-component.adoc
+++ b/components/camel-kamelet/src/main/docs/kamelet-component.adoc
@@ -97,6 +97,60 @@ Then notice the error handler has been configured to do redeliveries up till 5 t
 Suppose the sink kamelet is throwing an exception, then Camel will now perform the redelivery attempt
 at the point of origin, which means inside the Kamelet.
 
+=== Calling a Kamelet from another Kamelet
+
+NOTE: this feature is available since version 4.10.0 onward
+
+As a Kamelet behave as any other regular component, you will be able to use it in a nested way. The definition of a Kamelet can contains the reference to another Kamelet which will give you a high level of flexibility when constructing your abstraction.
+
+In the following example, we are creating a Kamelet which is calling a bundled catalog Kamelet `log-sink`:
+
+[source,yaml]
+----
+apiVersion: camel.apache.org/v1
+kind: Kamelet
+metadata:
+  name: nested-sink
+spec:
+  definition:
+    title: "Kamelet in a Kamelet"
+    description: A Kamelet calling another Kamelet
+    required:
+      - log-level
+    properties:
+      log-level:
+        title: The Kamelet log-sink log level
+        description: The Kamelet log-sink log level
+        type: string
+        example: DEBUG
+  dependencies:
+  - "camel:core"
+  - "camel:kamelet"
+  template:
+    from:
+      uri: "kamelet:source"
+      steps:
+      - to: "kamelet:log-sink?level={{log-level}}"
+----
+
+According to the specification, this Kamelet expects a parameter, _log-level_ which we will use as a further parameter for the downstream call to the `log-sink` Kamelet.
+
+The usage of this Kamelet into a Camel route is going to be the same as any other Kamelet:
+
+[source,yaml]
+----
+- from:
+    uri: "timer:yaml"
+    parameters:
+      period: "5000"
+    steps:
+      - setBody:
+          simple: "Hello Camel from ${routeId}"
+      - to: "kamelet:nested-sink?log-level=INFO"
+----
+
+WARNING: beware of any potential circular reference you may introduce when using chain of Kamelets, in which case, the runtime will likely be idle consuming a high amount of resources.
+
 == Examples
 
 _Kamelets_ can be used as if they were standard Camel components.