> For the complete documentation index, see [llms.txt](https://docs.lenses.io/latest/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.lenses.io/latest/devx/5.5/getting-started/connections/kafka-connect.md).

# Kafka Connect

This page describes adding a Kafka Connect Cluster to Lenses.

Lenses integrates with Kafka Connect Clusters to manage connectors.

{% hint style="warning" %}
For documentation about the available Lenses Apache 2.0 Connectors, see the [Stream Reactor documentation](https://docs.lenses.io/kafka-connectors).
{% endhint %}

{% hint style="info" %}
The name of a Kafka Connect *Connections* may only contain alphanumeric characters (`[A-Za-z0-9]`) and dashes (`-`). Valid examples would be `dev`, `Prod1`, `SQLCluster`,`Prod-1`, `SQL-Team-Awesome`.

Multiple Kafka Connect clusters are supported.

If you are using Kafka Connect < 2.6 set the following to ensure you can see Connectors

**`lenses.features.connectors.topics.via.api.enabled=false`**
{% endhint %}

{% hint style="success" %}
See [provisioning](https://github.com/lensesio-dev/docs/blob/master/getting-started/connections/automation/README.md) for automating connections.

Consider [Rate Limiting](https://github.com/lensesio-dev/docs/blob/master/deployment/prepare-your-environment/rate-limiting.md) if you have a high number of connectors.
{% endhint %}

## Adding a connection

To add a connection, go to **Admin->Connections->New Connection->Kafka Connect**.

1. Provide a name for the Connect cluster
2. Add a comma-separated list of the workers in the Connector cluster, including ports
3. Optionally enable Basic Auth and set the username and password
4. Optionally enable SSL and upload the key-store file
5. Optionally upload a trust store
6. Optionally enable the collection of JMX metrics (Simple or Jolokia with SSL and Basic auth support)

## Adding 3rd Party Connector to the Topology

If you have developed your own Connector or are using not using a Lenses connector you can still display the connector instances in the topology. To do this Lenses needs to know the configuration option of the Connector that defines which topic the Connector reads from or writes to. This is set in the `connectors.info` parameter in the `lenses.conf` file.

{% code fullWidth="false" %}

```bash
connectors.info = [
      {
           class.name = "The connector full classpath"
           name = "The name which will be presented in the UI"
           instance = "Details about the instance. Contains the connector configuration field which holds the information. If  a database is involved it would be  the DB connection details, if it is a file it would be the file path, etc"
           sink = true
           extractor.class = "The full classpath for the implementation knowing how to extract the Kafka topics involved. This is only required for a Source"
           icon = "file.png"
           description = "A description for the connector"
           author = "The connector author"
      }

  ]
```

{% endcode %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.lenses.io/latest/devx/5.5/getting-started/connections/kafka-connect.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
