| // THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT |
| = image:kamelets/replace-field-action.svg[] Replace Field Action |
| |
| *Provided by: "Apache Software Foundation"* |
| |
| *Support Level for this Kamelet is: "Preview"* |
| |
| Replace field with a different key in the message in transit |
| |
| == Configuration Options |
| |
| The following table summarizes the configuration options available for the `replace-field-action` Kamelet: |
| [width="100%",cols="2,^2,3,^2,^2,^3",options="header"] |
| |=== |
| | Property| Name| Description| Type| Default| Example |
| | *disabled {empty}* *| Disabled| Comma separated list of fields to be disabled| string| | |
| | *enabled {empty}* *| Enabled| Comma separated list of fields to be enabled| string| | |
| | *renames {empty}* *| Renames| Comma separated list of field with new value to be renamed| string| | `"foo:bar,c1:c2"` |
| |=== |
| |
| NOTE: Fields marked with ({empty}*) are mandatory. |
| |
| == Usage |
| |
| This section summarizes how the `replace-field-action` can be used in various contexts. |
| |
| === Knative Action |
| |
| The `replace-field-action` Kamelet can be used as intermediate step in a Knative binding. |
| |
| .replace-field-action-binding.yaml |
| [source,yaml] |
| ---- |
| apiVersion: camel.apache.org/v1alpha1 |
| kind: KameletBinding |
| metadata: |
| name: replace-field-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: replace-field-action |
| properties: |
| disabled: "The Disabled" |
| enabled: "The Enabled" |
| renames: "foo:bar,c1:c2" |
| 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 `replace-field-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 replace-field-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 replace-field-action -p "step-0.disabled=The Disabled" -p "step-0.enabled=The Enabled" -p "step-0.renames=foo:bar,c1:c2" channel/mychannel |
| ---- |
| |
| This will create the KameletBinding under the hood and apply it to the current namespace in the cluster. |
| |
| === Kafka Action |
| |
| The `replace-field-action` Kamelet can be used as intermediate step in a Kafka binding. |
| |
| .replace-field-action-binding.yaml |
| [source,yaml] |
| ---- |
| apiVersion: camel.apache.org/v1alpha1 |
| kind: KameletBinding |
| metadata: |
| name: replace-field-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: replace-field-action |
| properties: |
| disabled: "The Disabled" |
| enabled: "The Enabled" |
| renames: "foo:bar,c1:c2" |
| 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 `replace-field-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 replace-field-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 replace-field-action -p "step-0.disabled=The Disabled" -p "step-0.enabled=The Enabled" -p "step-0.renames=foo:bar,c1:c2" 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 |