Chapter 23. Insert Field Action
Adds a custom field with a constant value to the message in transit
23.1. Configuration Options
The following table summarizes the configuration options available for the insert-field-action Kamelet:
| Property | Name | Description | Type | Default | Example |
|---|---|---|---|---|---|
| field * | Field | The name of the field to be added | string | ||
| value * | Value | The value of the field | string |
Fields marked with an asterisk (*) are mandatory.
23.2. Dependencies
At runtime, the insert-field-action Kamelet relies upon the presence of the following dependencies:
- github:openshift-integration.kamelet-catalog:camel-kamelets-utils:kamelet-catalog-1.6-SNAPSHOT
- camel:core
- camel:jackson
- camel:kamelet
23.3. Usage
This section describes how you can use the insert-field-action.
23.3.1. Knative Action
You can use the insert-field-action Kamelet as an intermediate step in a Knative binding.
insert-field-action-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: insert-field-action-binding
spec:
source:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: timer-source
properties:
message: '{"foo":"John"}'
steps:
- ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: json-deserialize-action
- ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: insert-field-action
properties:
field: "The Field"
value: "The Value"
sink:
ref:
kind: Channel
apiVersion: messaging.knative.dev/v1
name: mychannel
23.3.1.1. Prerequisite
Make sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.
23.3.1.2. Procedure for using the cluster CLI
-
Save the
insert-field-action-binding.yamlfile to your local drive, and then edit it as needed for your configuration. Run the action by using the following command:
oc apply -f insert-field-action-binding.yaml
23.3.1.3. Procedure for using the Kamel CLI
Configure and run the action by using the following command:
kamel bind --name insert-field-action-binding timer-source?message='{"foo":"John"}' --step json-deserialize-action --step insert-field-action -p step-1.field='The Field' -p step-1.value='The Value' channel:mychannelThis command creates the KameletBinding in the current namespace on the cluster.
23.3.2. Kafka Action
You can use the insert-field-action Kamelet as an intermediate step in a Kafka binding.
insert-field-action-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: insert-field-action-binding
spec:
source:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: timer-source
properties:
message: '{"foo":"John"}'
steps:
- ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: json-deserialize-action
- ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: insert-field-action
properties:
field: "The Field"
value: "The Value"
sink:
ref:
kind: KafkaTopic
apiVersion: kafka.strimzi.io/v1beta1
name: my-topic
23.3.2.1. Prerequisites
Ensure that you’ve installed the AMQ Streams operator in your OpenShift cluster and created a topic named my-topic in the current namespace. Make also sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.
23.3.2.2. Procedure for using the cluster CLI
-
Save the
insert-field-action-binding.yamlfile to your local drive, and then edit it as needed for your configuration. Run the action by using the following command:
oc apply -f insert-field-action-binding.yaml
23.3.2.3. Procedure for using the Kamel CLI
Configure and run the action by using the following command:
kamel bind --name insert-field-action-binding timer-source?message='{"foo":"John"}' --step json-deserialize-action --step insert-field-action -p step-1.field='The Field' -p step-1.value='The Value' kafka.strimzi.io/v1beta1:KafkaTopic:my-topicThis command creates the KameletBinding in the current namespace on the cluster.
