Skip to content
Nexa Platform Docs

Kafka / Message Queue

A Message Queue connection points Nexa at a streaming target so a connector can publish curated data to it. Configure it under Settings > Connection > Message Queue. The fields change with the queue type you pick.

Queue types

Section titled “Queue types”
Type Auth model Streaming platform
Kafka Bootstrap servers + optional SASL Apache Kafka
Event Hubs Bootstrap servers + optional SASL Azure Event Hubs (Kafka-compatible endpoint)
Kinesis Stream name + region + IAM service credential AWS Kinesis

Kafka and Event Hubs share the broker-based form; Kinesis uses a stream-based form.

Kafka and Event Hubs fields

Section titled “Kafka and Event Hubs fields”
Field Required Example Notes
Connection Name Yes events kafka Alphanumerics, spaces, hyphens, underscores. Read-only once saved.
Connection Type Yes Kafka Kafka or Event Hubs.
Bootstrap Servers Yes broker1:9092,broker2:9092 Comma-separated host:port list.
Security Protocol No SASL_SSL One of SASL_SSL, SASL_PLAINTEXT, SSL, or none (plaintext).

SASL/SCRAM authentication: choose SASL_SSL (TLS + SASL) or SASL_PLAINTEXT for a SASL/SCRAM-secured cluster. The bootstrap servers and protocol are non-sensitive and stored in the platform database. The SASL password or JAAS config is a secret — store it in GitHub under the derived name CONN_<UPPER_SNAKE_CASE> shown live in the panel. Use SSL for mutual-TLS clusters without SASL, or leave the protocol empty for an unauthenticated broker.

Kinesis fields

Section titled “Kinesis fields”
Field Required Example Notes
Connection Name Yes orders stream Read-only once saved.
Connection Type Yes Kinesis
Stream Name Yes my-kinesis-stream The Kinesis stream to publish to.
Region Yes ap-south-1 AWS region of the stream.

The IAM service credential is the secret. Nexa renders a ready-to-copy JSON value:

{
  "stream_name": "my-kinesis-stream",
  "region": "ap-south-1",
  "service_credential": "XXXXXXX"
}

Replace XXXXXXX with your service credential before saving the GitHub secret.

Create a Message Queue connection

Section titled “Create a Message Queue connection”

  1. Go to Settings > Connection > Message Queue and click Add.

  2. Enter the Connection Name and choose the Connection Type.

  3. For Kafka/Event Hubs, enter Bootstrap Servers and the Security Protocol. For Kinesis, enter the Stream Name and Region.

  4. Create the GitHub repository secret (Settings > Secrets and variables > Actions) under the name the panel shows. Store the SASL password/JAAS config (Kafka) or the service-credential JSON (Kinesis).

  5. Click Submit to save. The connection is marked Active.

Test reachability

Section titled “Test reachability”

For Kafka and Event Hubs, reachability opens a TCP connection to the first broker in the bootstrap-server list (defaulting to port 9092 if none is given) and reports whether it answers. It does not test SASL credentials. Kinesis connections have no host/port to probe, so reachability does not apply — access is validated at runtime through the IAM credential.

Next step

Section titled “Next step”