insert field action Insert Field Action

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Adds a custom field with a simple language parsed value to the message in transit.

The insert field action expects an application/json content type.

If for example you have an object like '{ "foo":"John", "bar":30 }' and your action has been configured with field as 'element' and value as 'hello', you’ll get '{ "foo":"John", "bar":30, "element":"hello" }' as a result

Configuration Options

The following table summarizes the configuration options available for the insert-field-action Kamelet:

Property Name Description Type Default Example

field

Field

Required The name of the field to be added.

string

value

Value

Required The value of the field.

string

Dependencies

At runtime, the insert-field-action Kamelet relies upon the presence of the following dependencies:

  • mvn:org.apache.camel.kamelets:camel-kamelets-utils:4.4.2-SNAPSHOT

  • camel:core

  • camel:jackson

  • camel:kamelet

Camel JBang usage

Prerequisites

  • You’ve installed JBang.

  • You have executed the following command:

jbang app install camel@apache/camel

Supposing you have a file named route.yaml with this content:

- route:
    from:
      uri: "kamelet:timer-source"
      parameters:
        period: 10000
        message: 'test'
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml

Camel K Environment Usage

This section describes how you can use the insert-field-action.

Knative action

You can use the insert-field-action Kamelet as an intermediate step in a Knative binding.

insert-field-action-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: insert-field-action-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: kafka-source
      properties:
        bootstrapServers: localhost:9092
        topic: mytopic
        user: kafka
        password: kafka123!
  steps:
    - ref:
        kind: Kamelet
        apiVersion: camel.apache.org/v1
        name: insert-field-action
      properties:
        field: The Field
        value: The Value
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the insert-field-action-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the action by using the following command:

    kubectl apply -f insert-field-action-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the action by using the following command:

kamel bind channel:mychannel -p "step-0.field=The Field" -p "step-0.value=The Value" insert-field-action

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kafka action

You can use the insert-field-action Kamelet as an intermediate step in a Kafka binding.

insert-field-action-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: insert-field-action-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: kafka-source
      properties:
        bootstrapServers: localhost:9092
        topic: mytopic
        user: kafka
        password: kafka123!
  steps:
    - ref:
        kind: Kamelet
        apiVersion: camel.apache.org/v1
        name: insert-field-action
      properties:
        field: The Field
        value: The Value
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic

Prerequisites

  • You’ve installed Strimzi.

  • You’ve created a topic named my-topic in the current namespace.

  • You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the insert-field-action-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the action by using the following command:

    kubectl apply -f insert-field-action-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the action by using the following command:

kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic -p "step-0.field=The Field" -p "step-0.value=The Value" insert-field-action

This command creates the Kamelet Pipe in the current namespace on the cluster.