avro serialize action Avro Serialize Action

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

Serialize payload to Avro

Configuration Options

The following table summarizes the configuration options available for the avro-serialize-action Kamelet:

Property Name Description Type Default Example

schema *

Schema

The Avro schema to use during serialization (as single-line, using JSON format)

string

"{\"type\": \"record\", \"namespace\": \"com.example\", \"name\": \"FullName\", \"fields\": [{\"name\": \"first\", \"type\": \"string\"},{\"name\": \"last\", \"type\": \"string\"}]}"

validate

Validate

Indicates if the content must be validated against the schema

boolean

true

Fields marked with an asterisk (*) are mandatory.

Dependencies

At runtime, the avro-serialize-action Kamelet relies upon the presence of the following dependencies:

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

  • camel:kamelet

  • camel:core

  • camel:jackson-avro

Usage

This section describes how you can use the avro-serialize-action.

Knative Action

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

avro-serialize-action-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: avro-serialize-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: avro-serialize-action
    properties:
      schema: "{\"type\": \"record\", \"namespace\": \"com.example\", \"name\": \"FullName\", \"fields\": [{\"name\": \"first\", \"type\": \"string\"},{\"name\": \"last\", \"type\": \"string\"}]}"
  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 avro-serialize-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 avro-serialize-action-binding.yaml

Procedure for using the Kamel CLI

Configure and run the action by using the following command:

kamel bind timer-source?message=Hello --step avro-serialize-action -p "step-0.schema={\"type\": \"record\", \"namespace\": \"com.example\", \"name\": \"FullName\", \"fields\": [{\"name\": \"first\", \"type\": \"string\"},{\"name\": \"last\", \"type\": \"string\"}]}" channel:mychannel

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

Kafka Action

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

avro-serialize-action-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: avro-serialize-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: avro-serialize-action
    properties:
      schema: "{\"type\": \"record\", \"namespace\": \"com.example\", \"name\": \"FullName\", \"fields\": [{\"name\": \"first\", \"type\": \"string\"},{\"name\": \"last\", \"type\": \"string\"}]}"
  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 avro-serialize-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 avro-serialize-action-binding.yaml

Procedure for using the Kamel CLI

Configure and run the action by using the following command:

kamel bind timer-source?message=Hello --step avro-serialize-action -p "step-0.schema={\"type\": \"record\", \"namespace\": \"com.example\", \"name\": \"FullName\", \"fields\": [{\"name\": \"first\", \"type\": \"string\"},{\"name\": \"last\", \"type\": \"string\"}]}" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

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