-
Notifications
You must be signed in to change notification settings - Fork 71
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added String Template Kamelet Action
- Loading branch information
Showing
2 changed files
with
199 additions
and
0 deletions.
There are no files selected for viewing
59 changes: 59 additions & 0 deletions
59
docs/modules/ROOT/assets/images/kamelets/string-template-action.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,140 @@ | ||
// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT | ||
= image:kamelets/string-template-action.svg[] String Template Action | ||
|
||
*Provided by: "Apache Software Foundation"* | ||
|
||
*Support Level for this Kamelet is: "Preview"* | ||
|
||
Apply a String Template. | ||
|
||
The template property needs to be encoded in base64, so when you pass it as parameter, don't forget to encode it. | ||
|
||
== Configuration Options | ||
|
||
The following table summarizes the configuration options available for the `string-template-action` Kamelet: | ||
[width="100%",cols="2,^2,3,^2,^2,^3",options="header"] | ||
|=== | ||
| Property| Name| Description| Type| Default| Example | ||
| *template {empty}* *| Template| The inline template| binary| | | ||
|=== | ||
|
||
NOTE: Fields marked with ({empty}*) are mandatory. | ||
|
||
== Usage | ||
|
||
This section summarizes how the `string-template-action` can be used in various contexts. | ||
|
||
=== Knative Action | ||
|
||
The `string-template-action` Kamelet can be used as intermediate step in a Knative binding. | ||
|
||
.string-template-action-binding.yaml | ||
[source,yaml] | ||
---- | ||
apiVersion: camel.apache.org/v1alpha1 | ||
kind: KameletBinding | ||
metadata: | ||
name: string-template-action-binding | ||
spec: | ||
source: | ||
ref: | ||
kind: Kamelet | ||
apiVersion: camel.apache.org/v1alpha1 | ||
name: timer-source | ||
properties: | ||
message: "Hello" | ||
steps: | ||
- ref: | ||
kind: Kamelet | ||
apiVersion: camel.apache.org/v1alpha1 | ||
name: string-template-action | ||
properties: | ||
template: "The Template" | ||
sink: | ||
ref: | ||
kind: InMemoryChannel | ||
apiVersion: messaging.knative.dev/v1 | ||
name: mychannel | ||
---- | ||
|
||
Make sure you have xref:latest@camel-k::installation/installation.adoc[Camel K installed] into the Kubernetes cluster you're connected to. | ||
|
||
Save the `string-template-action-binding.yaml` file into your hard drive, then configure it according to your needs. | ||
|
||
You can run the action using the following command: | ||
|
||
[source,shell] | ||
---- | ||
kubectl apply -f string-template-action-binding.yaml | ||
---- | ||
|
||
==== *Binding to Knative using the Kamel CLI:* | ||
|
||
The procedure described above can be simplified into a single execution of the `kamel bind` command: | ||
|
||
[source,shell] | ||
---- | ||
kamel bind timer-source?message=Hello --step string-template-action -p "step-0.template=The Template" channel/mychannel | ||
---- | ||
|
||
This will create the KameletBinding under the hood and apply it to the current namespace in the cluster. | ||
|
||
=== Kafka Action | ||
|
||
The `string-template-action` Kamelet can be used as intermediate step in a Kafka binding. | ||
|
||
.string-template-action-binding.yaml | ||
[source,yaml] | ||
---- | ||
apiVersion: camel.apache.org/v1alpha1 | ||
kind: KameletBinding | ||
metadata: | ||
name: string-template-action-binding | ||
spec: | ||
source: | ||
ref: | ||
kind: Kamelet | ||
apiVersion: camel.apache.org/v1alpha1 | ||
name: timer-source | ||
properties: | ||
message: "Hello" | ||
steps: | ||
- ref: | ||
kind: Kamelet | ||
apiVersion: camel.apache.org/v1alpha1 | ||
name: string-template-action | ||
properties: | ||
template: "The Template" | ||
sink: | ||
ref: | ||
kind: KafkaTopic | ||
apiVersion: kafka.strimzi.io/v1beta1 | ||
name: my-topic | ||
---- | ||
|
||
Ensure that you've installed https://strimzi.io/[Strimzi] and created a topic named `my-topic` in the current namespace. | ||
Make also sure you have xref:latest@camel-k::installation/installation.adoc[Camel K installed] into the Kubernetes cluster you're connected to. | ||
|
||
Save the `string-template-action-binding.yaml` file into your hard drive, then configure it according to your needs. | ||
|
||
You can run the action using the following command: | ||
|
||
[source,shell] | ||
---- | ||
kubectl apply -f string-template-action-binding.yaml | ||
---- | ||
|
||
==== *Binding to Kafka using the Kamel CLI:* | ||
|
||
The procedure described above can be simplified into a single execution of the `kamel bind` command: | ||
|
||
[source,shell] | ||
---- | ||
kamel bind timer-source?message=Hello --step string-template-action -p "step-0.template=The Template" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic | ||
---- | ||
|
||
This will create the KameletBinding under the hood and apply it to the current namespace in the cluster. | ||
|
||
// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT |