Use the Redpanda connector to get data from a Redpanda topic into Decodable. If you are looking for information about how to create a connection to get data into Redpanda from Decodable, see Redpanda in the Connect to a data source chapter.

Overview


Connector name	`redpanda`
Types	`source`, `sink`
Delivery guarantee	at least once or exactly once, based on configuration

Create a connection to Redpanda

Prerequisites

If you want to use TLS or mTLS to secure the connection between Decodable and Redpanda, then you must have a self-signed or third-party signed server certificate and a private key associated with that server certificate.

Because Redpanda is fully compatible with Apache Kafka, the configuration required to process data from Redpanda into Decodable is the same as when you process data from Kafka. For detailed instructions on how to create a TLS or mTLS secured connection between Redpanda and Decodable, see the following topics.

Steps

Follow these steps to send data from Decodable into Redpanda.

From the Connections page, select the Redpanda connector and complete the following fields.

UI Field	Property Name in the Decodable CLI	Description
Connection Type	N/A	Select Sink to use this connector to send data into the topic(s) provided.
Bootstrap Servers	`bootstrap.servers`	A comma-separated list of your Redpanda brokers. You must enter at least one broker. Enter each broker in the format: :. For example: `broker-a:9092,broker-b:9092` The broker list cannot contain any spaces.
Topic	`topic`	A semicolon-separated list of one or more topic names to read data from.
Broker Security Protocol	`security.protocol`	Specify the security protocol to use when connecting to a broker. Must be one of the following: -PLAINTEXT -TLS: See TLS Properties for information about the additional fields you need to provide when using TLS. -SASL_SSL: See SASL Properties for information about the additional fields you need to provide when using SASL.　 -SASL_PLAINTEXT: See SASL Properties for information about the additional fields you need to provide when using SASL. For more information about the difference between these protocols, see the Security section.
Value Format	`value.format`	The format of the data that you want to send to Redpanda. You can select one of the following: - JSON - Raw - Avro - Debezium (JSON) If you want to send CDC data through this connector, then you must select Debezium (JSON).

Select the stream that you’d like to connect to this connector. Then, select Next.
Define the connection’s schema. Select New Schema to manually enter the fields and field types present or Import Schema if you want to paste the schema in the form of an Avro or JSON array.
1. The stream's schema must match the schema of the data that you plan on sending through this connection.
2. For more information about creating a stream or defining the stream schema, see Create a Stream.
Select Next when you are finished providing defining the connection’s schema.
Give the newly created connection a Name and Description and select Save.

Security

Redpanda connections may optionally enable TLS, which encrypts all network traffic between Decodable and the brokers. In addition, the Redpanda connector supports mutual TLS (mTLS) which acts as a bidirectional mode of authentication with the brokers. To configure an mTLS connection, Decodable either provides a self-signed certificate or a certificate signing request (CSR) which you can sign to create a certificate for use with your brokers. See the How To guides for more information.

SASL Properties

When configuring a Redpanda connection to use SASL Authentication, the following connection properties are used.

UI Field	Property Name in the Decodable CLI	Description
`sasl.mechanism`	`sasl.mechanism`	Specify the SASL mechanism as configured by the Redpanda broker. Support values are ["PLAIN", "SCRAM-SHA-256", "SCRAM-SHA-512"].
`sasl.username`	`sasl.username`	The provided username or API key for authentication.
`sasl.password`	`sasl.password`	The ID of the secret resource containing the password. If you are using the Decodable CLI, this is the ID of a secret resource in your account. Run `decodable secret list` to view available secrets or `decodable secret --help` for help with creating a new secret. Note: For security purposes, Decodable will never display secret values in plaintext. You can manage which users have permissions to create, delete, or modify secrets in the Access Control management view. See Manage Roles, Groups, and Permissions for more information.

TLS Properties

When configuring a Redpanda connection to use TLS or mTLS, the following connection properties are used.

UI Field	Property Name in the Decodable CLI	Description
Broker Certificate	`tls.broker.certificate`	Broker's public certificate used to encrypt traffic from Decodable to external Redpanda brokers. The property is only used when security.protocol=TLS.
TLS Client Certificate	`tls.client.certificate`	Specify the client certificate used by Decodable to connect to external Redpanda brokers with mTLS.
TLS Client Key	`tls.client.key`	The ID of the secret resource containing the client key. If you are using the Decodable CLI, this is the ID of a secret resource in your account. Run `decodable secret list` to view available secrets or `decodable secret --help` for help with creating a new secret. Note: For security purposes, Decodable will never display secret values in plaintext. You can manage which users have permissions to create, delete, or modify secrets in the Access Control management view. See Manage Roles, Groups, and Permissions for more information.
N/A	`tls.broker.signed_client_certificate`	Specify the client certificate signed by the broker. This property is required when `tls.client.certificate.type=CSR`.

Apache Kafka, Kafka®, Apache® and associated open source project names are either registered trademarks or trademarks of The Apache Software Foundation.