Chapter 55. Value to Key Action


Replace the Kafka record key with a new key formed from a subset of fields in the body

55.1. Configuration Options

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

PropertyNameDescriptionTypeDefaultExample

fields *

Fields

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

string

  
Note

Fields marked with an asterisk (*) are mandatory.

55.2. 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:1.0.0.fuse-800048-redhat-00001
  • camel:core
  • camel:jackson
  • camel:kamelet

55.3. Usage

This section describes how you can use the value-to-key-action.

55.3.1. Knative Action

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

value-to-key-action-binding.yaml

apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: value-to-key-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: value-to-key-action
    properties:
      fields: "The Fields"
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

55.3.1.1. Prerequisite

Make sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.

55.3.1.2. Procedure for using the cluster CLI

  1. Save the value-to-key-action-binding.yaml file to your local drive, and then edit it as needed for your configuration.
  2. Run the action by using the following command:

    oc apply -f value-to-key-action-binding.yaml

55.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 value-to-key-action -p "step-0.fields=The Fields" channel:mychannel

This command creates the KameletBinding in the current namespace on the cluster.

55.3.2. Kafka Action

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

value-to-key-action-binding.yaml

apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: value-to-key-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: value-to-key-action
    properties:
      fields: "The Fields"
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic

55.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.

55.3.2.2. Procedure for using the cluster CLI

  1. Save the value-to-key-action-binding.yaml file to your local drive, and then edit it as needed for your configuration.
  2. Run the action by using the following command:

    oc apply -f value-to-key-action-binding.yaml

55.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 value-to-key-action -p "step-0.fields=The Fields" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

This command creates the KameletBinding in the current namespace on the cluster.

55.4. Kamelet source file

https://github.com/openshift-integration/kamelet-catalog/blob/kamelet-catalog-1.6/value-to-key-action.kamelet.yaml

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.