header matches filter action Header Matches Filter Action

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Filter based on header value compared to regex

Configuration Options

The following table summarizes the configuration options available for the header-matches-filter-action Kamelet:

Property Name Description Type Default Example

regex

Regex

Required The Regex to Evaluate against the Kafka topic name.

string

headerName

Header Name

The header name to get the value to compare.

string

headerName

Dependencies

At runtime, the header-matches-filter-action Kamelet relies upon the presence of the following dependencies:

  • camel:core

  • 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 header-matches-filter-action.

Knative action

You can use the header-matches-filter-action Kamelet as an intermediate step in a Knative binding.

header-matches-filter-action-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: header-matches-filter-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: header-matches-filter-action
      properties:
        regex: The Regex
  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 header-matches-filter-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 header-matches-filter-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.regex=The Regex" header-matches-filter-action

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

Kafka action

You can use the header-matches-filter-action Kamelet as an intermediate step in a Kafka binding.

header-matches-filter-action-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: header-matches-filter-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: header-matches-filter-action
      properties:
        regex: The Regex
  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 header-matches-filter-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 header-matches-filter-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.regex=The Regex" header-matches-filter-action

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

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/header-matches-filter-action.kamelet.yaml

Back to top