@itentialopensource/kafka-producer v0.0.7-2022.1.1

Kafka Producer

Table of Contents

• Overview
• Installation Prerequisites
• Requirements
• Features
• How to Install
• How to Run
• How to send encrypted messages using Avro

Overview

This Pre-Built Automation contains a workflow designed to send non-encrypted messages to a specific Kafka topic.

Estimated Run Time: < 1 min

Installation Prerequisites

Users must satisfy the following pre-requisites:

• Itential Automation Platform: ^2022.1
• Kafka Adapter

* If using Avro, please follow this guide.

Requirements

This artifact requires the following:

• Kafka Server

Features

The main benefits and features of the artifact are outlined below.

• Reusable workflow that can be altered according to one need.
• Allows zero-touch mode of operation.

How to Install

To install the artifact:

• Verify you are running a supported version of the Itential Automation Platform (IAP) as listed above in the Requirements section.

• The artifact can be installed from within App-Admin_Essential. Simply search for the name of your desired artifact and click the install button (as shown below).

How to Run

To run the artifact:

• Navigate to Operations Manager in IAP and select the Kafka Producer Pre-Built.

• Select the existing manual trigger and complete the form that displays with the following details.

  Form Element	Description
  Zero Touch	Select checkbox to eliminate user interactions.
  Kafka Adapter Id	Name of your Kafka adapter.
  Topic	Kafka topic name to which messages should be sent.
  Messages	The messages that will be sent to the specified Kafka topic name. Message can be a string or a JSON object. For example: hello, world or {"foo": "bar"}.

How to Send Encrypted Messages Using Avro

To encrypt messages using Avro:

• Make sure your Kafka server has a Schema Registry setup.

• Modify the reusable Kafka Producer workflow by clicking the Merge operation task and then adding the following keys.

  Key	Description
  simple	Can be either YES(send message without encrypting) or NO (encrypt messages).
  key_version	Version number of the Schema key specified in the Schema registry.
  value_version	Version number of the Schema value specified in the Schema registry.

• Specify the port address for the "registry_url" property in your your Kafka adapter configuration (required).

  registry_url: <schema_registry_addr:port>

Additional Information

To learn more about Kafka Avro, use this document.