Setting up a connection to Kafka
Adding a Cluster
To add a cluster, please click on the "Add new cluster" button
This will open up a list of configurations you can set for Conduktor
this tab is the most important tab, and you have the following options:
- integration: in case you are using Aiven, Confluent Cloud or Redhat Openshift, you have the possibility to quickly integrate with them through a dialog. In case you're not using those, rest assured you can connect to your cluster!
- cluster name: this will be the name of your cluster when navigating the list of clusters on the right-hand side of the Conduktor splash screen
- bootstrap servers: list of Kafka brokers to connect to, usually providing two or three brokers is enough. In the form of
- zookeeper (optional): providing a Zookeeper URL will allow you to access more features through Conduktor, for example partition reassignment. Over time, as Kafka migrates away from using Zookeeper, this configuration will become less and less necessary to provide. In the form of
- additional properties: this is one of the most important section, especially if you have a secure Kafka cluster. Any additional properties you usually provide to your CLI or your Java clients should be inserted here. For more information, please read the secure Kafka cluster section.
You can use the two buttons to test the Kafka and Zookeeper connectivity to ensure you connection details are accurate.
If using Aiven, you can use our integration to setup the configuration:
Download the 3 necessary files on Aiven's interface (service.key, service.cert, ca.pem). Conduktor will generate files out of them in the folder you chose (don't remove them!).
Please be careful to check that the files you are downloading from Aiven contain a proper key, and not <hidden>, which happens when you don't have the permissions.
If using Redhat, you can click on the Redhat button and follow the guide to create a service account and retrieve your Redhat Kafka cluster information. Then fill the form with the required information:
If you are using the SASL/OAUTHBEARER authentication with a custom token endpoint, do not forget to change the token endpoint URL.
Click on create to go back to the cluster configuration page, it will be automatically filled with the provided information.
In case you are using the Confluent Schema Registry and usually Avro data, you should use this tab to setup the connection details to your registry. These detail are necessary to activate the "Schema Registry" tab in Conduktor, as well as consume and produce data in Avro format.
- URL: HTTP or HTTPS endpoint of your schema registry.
- Security: Choose the security type (None, Basic Auth, Bearer Token)
- Additional Properties: any key value pair needed to make the connection work
After entering the necessary details, you can test the connectivity to your schema registry.
How to Connect to a secured Schema Registry?
Add this in the additional properties (notice the
Here you can add a list of Kafka Connect clusters that are linked to this Kafka cluster.
Each Kafka Connect cluster will have
- Name: unique name to identify a connect cluster
- URL: HTTP or HTTPS endpoint of your connect cluster
- Security: basic authentication (if secure connect cluster), as well as key and trust store locations in case of TLS encryption.
You can also test the connectivity to your Connect clusters from there.
Enabling metrics allows Conduktor to get real-time features, statistics, monitoring over your cluster, as well as the rolling restart feature.
We current support Jolokia and JMX to extract metrics.
- Jolokia: please provide the protocol as well as the Jolokia port. The Jolokia agent should be installed on all your Kafka brokers.
- JMX: if you have started the JMX utility on your Kafka brokers, please provide the JMX port for Conduktor to connect to.
Please contact us in case you need other metrics mechanisms.
SSH (note: not a connection setting)
The SSH configuration is quite powerful and should only be allowed to be set-up for your Kafka administrators. Average Kafka users should not need to fill up the details of that tab.
The SSH configuration enables Conduktor to directly access your brokers machines, enabling features like the rolling restart feature.
Please provide the port, user, authentication method (password or SSH key pair) and test the SSH configuration.
Plugins (aka "custom jars")
The Plugins configuration allows you to load your custom jars into Conduktor.\ These customs jars are useful to extend the capabilities of our internal Kakfa clients.
The plugins have two main usages:
- Authentication of Conduktor requests to your Kafka cluster(s) if you're using an authentication mechanism not natively supported by Kafka.
- Deserializing your topics messages with a custom Kafka deserializer. (MessagePack, etc.)
For example, if you're using OAuth2 to authenticate the connections to your Kafka cluster, to allow Conduktor to connect to your cluster, you'll need to:
- Configure your cluster with an additional property:
- Load your jar containing the
io.example.client.MyCustomLoginCallbackHandlerclass in Conduktor plugins
With this additional property and this jar configured, Conduktor will be able to configure its internal Kafka client to successfully connect to your Kafka cluster.
To learn more about custom Kafka deserializers and how to use them in Conduktor, please the dedicated documentation: Custom deserializers
⚠️ When adding a plugin to a cluster configuration, this plugin is only available for this cluster.\ If you want to use this same plugin with a second cluster configured in Conduktor, you'll need to add this plugin in this second cluster configuration too.
Current limitations of the "Plugins" feature
- For now, a plugin can only be composed of one jar (Coming soon)
Scala support & limitation
As Conduktor is powered by Scala 2.13, it natively supports the plugins compiled with Scala 2.13.\ If your plugin is using a different version of Scala, it may not work in Conduktor.\ If your plugin is compiled with another version of Scala and doesn't work in Conduktor, you have two solutions:
- Recompile your plugin with Scala 2.13
- Build a
fatjarout of your plugin code that will contain your Scala version code.\ However, for this solution to work, you'll have to shadow your Scala version code by renaming all the
yourorganisation.scala.*, for example.
Don't hesitate to contact our support if you meet any issue with your plugins and Conduktor.
Testing the Connection to a Cluster
Conduktor has utilities to test the connectivity to your Kafka clusters. In case you cannot establish a connectivity to your clusters, please make sure to read the following two pages:
Multi Cluster Management
Conduktor allows you to manage and save the configuration and connection details to multiple Kafka clusters for easy and quick connections. The clusters you have used last will appear at the top of your cluster list.
To edit the configuration of a cluster, hover your mouse over a cluster, and the "config button" will appear.
The ability to export, backup and share Kafka cluster configurations is an upcoming feature of the Enterprise License.
Secure Kafka Clusters
Setting up Conduktor with secure clusters is possible but requires you to have the exact properties. We have setup a longer guide here to help you out:
Having connectivity issues? Be sure that you're not in a case of "impossible connection setup". Read more here: