mask field action Mask Fields Action

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Mask fields with a constant value in the message in transit

Configuration Options

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

Property Name Description Type Default Example

fields

Fields

Required Comma separated list of fields to mask.

string

replacement

Replacement

Required Replacement for the fields to be masked.

string

Dependencies

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

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

  • camel:jackson

  • camel:kamelet

  • camel:core

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 mask-field-action.

Knative action

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

mask-field-action-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: mask-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: mask-field-action
      properties:
        fields: The Fields
        replacement: The Replacement
  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 mask-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 mask-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.fields=The Fields" -p "step-0.replacement=The Replacement" mask-field-action

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

Kafka action

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

mask-field-action-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: mask-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: mask-field-action
      properties:
        fields: The Fields
        replacement: The Replacement
  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 mask-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 mask-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.fields=The Fields" -p "step-0.replacement=The Replacement" mask-field-action

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