Chapter 24. Insert Header Action
Adds a header with a constant value to the message in transit.
24.1. Configuration Options
The following table summarizes the configuration options available for the insert-header-action Kamelet:
| Property | Name | Description | Type | Default | Example |
|---|---|---|---|---|---|
| name * | Name |
The name of the header to add. For Knative only, the name of the header requires a CloudEvent ( | string | ||
| value * | Value | The value of the header | string |
Fields marked with an asterisk (*) are mandatory.
24.2. Dependencies
At runtime, the insert-header-action Kamelet relies upon the presence of the following dependencies:
- camel:core
- camel:kamelet
24.3. Usage
This section describes how you can use the insert-header-action.
24.3.1. Knative Action
You can use the insert-header-action Kamelet as an intermediate step in a Knative binding. The following example adds the ce-foo header to the data coming from the timer-source Kamelet. The CloudEvents (ce-) prefix for the header name is required.
insert-header-action-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: insert-header-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: insert-header-action
properties:
name: "ce-foo"
value: "The Value"
sink:
ref:
kind: Channel
apiVersion: messaging.knative.dev/v1
name: mychannel
24.3.1.1. Prerequisite
Make sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.
24.3.1.2. Procedure for using the cluster CLI
-
Save the
insert-header-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-header-action-binding.yaml
24.3.1.3. Procedure for using the Kamel CLI
Configure and run the action by using the following command:
kamel bind timer-source?message=Hello --step insert-header-action -p "step-0.name=ce-foo" -p "step-0.value=The Value" channel:mychannel
This command creates the KameletBinding in the current namespace on the cluster.
24.3.2. Kafka Action
You can use the insert-header-action Kamelet as an intermediate step in a Kafka binding. The following example adds the foo header to the data coming from the timer-source Kamelet.
insert-header-action-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: timer-to-kafka
spec:
source:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: timer-source
properties:
period: "10000"
message: 'msg'
steps:
- ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: insert-header-action
properties:
name: "foo"
value: "The Value"
sink:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: kafka-sink
properties:
bootstrapServers: "my-cluster-kafka-bootstrap.myproject.svc:9092"
password: "XXX"
topic: "my-topic"
user: "XXX"
securityProtocol: "PLAINTEXT"
24.3.2.1. Prerequisites
-
Ensure that you’ve installed the AMQ Streams operator in your OpenShift cluster and created a topic named
my-topicin the current namespace. - Make sure that you have "Red Hat Integration - Camel K" installed on the OpenShift cluster that you’re connected to.
24.3.2.2. Procedure for using the cluster CLI
-
Save the
insert-header-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-header-action-binding.yaml
24.3.2.3. Procedure for using the Kamel CLI
Configure and run the action by using the following command:
kamel bind timer-source?message=Hello --step insert-header-action -p "step-0.name=foo" -p "step-0.value=The Value" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic
This command creates the KameletBinding in the current namespace on the cluster.
