value to key action Value to Key Action

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Replace the Kafka record key with a new key formed from a fields subset coming from the message body

Configuration Options

The following table summarizes the configuration options available for the value-to-key-action Kamelet:

Property Name Description Type Default Example

fields

Fields

Required Comma separated list of fields to be used to form the new key.

string

Dependencies

At runtime, the value-to-key-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 value-to-key-action.

Knative action

You can use the value-to-key-action Kamelet as an intermediate step in a Knative binding.

value-to-key-action-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: value-to-key-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: value-to-key-action
      properties:
        fields: The Fields
  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 value-to-key-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 value-to-key-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.fields=The Fields" value-to-key-action

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

Kafka action

You can use the value-to-key-action Kamelet as an intermediate step in a Kafka binding.

value-to-key-action-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: value-to-key-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: value-to-key-action
      properties:
        fields: The Fields
  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 value-to-key-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 value-to-key-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.fields=The Fields" value-to-key-action

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