mask field action Mask Fields Action

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

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:

  • github:apache.camel-kamelets:camel-kamelets-utils:main-SNAPSHOT

  • camel:jackson

  • camel:kamelet

  • camel:core

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-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: mask-field-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: 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-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:

    kubectl apply -f mask-field-action-binding.yaml

Procedure for using the Kamel CLI

Configure and run the action by using the following command:

kamel bind mask-field-action -p "step-0.fields=The Fields" -p "step-0.replacement=The Replacement" channel:mychannel

This command creates the KameletBinding 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-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: mask-field-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: 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-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:

    kubectl apply -f mask-field-action-binding.yaml

Procedure for using the Kamel CLI

Configure and run the action by using the following command:

kamel bind mask-field-action -p "step-0.fields=The Fields" -p "step-0.replacement=The Replacement" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

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