kafka-connect

Charmed Apache Kafka Connect

Channel Revision Published Runs on
latest/edge 28 09 Sep 2025
Ubuntu 22.04
juju deploy kafka-connect --channel edge
Show information

Platform:

Ubuntu
22.04

Learn about configurations >

  • exactly_once_source_support | boolean

    Whether to enable exactly-once support for source connectors in the cluster by using transactions to write source records and their source offsets, and by proactively fencing out old task generations before bringing up new ones.

  • key_converter | string

    Default: org.apache.kafka.connect.json.JsonConverter

    Converter class used to convert between Kafka Connect format and the serialized form that is written to Kafka. This controls the format of the keys in messages written to or read from Kafka, and since this is independent of connectors, it allows any connector to work with any serialization format. Examples of common formats include JSON and Avro.

    Note: For custom converters, the library files should be provided to the charm beforehand using juju attach-resource command. Please refer to the docs for more details.

  • log_level | string

    Default: INFO

    Level of logging for the Apache Kafka Connect service operated by the charm.

    Allowed values are: "ERROR", "WARNING", "INFO", and "DEBUG".

  • profile | string

    Default: production

    Profile representing the scope of deployment, and used to enable high-level customisation of configs, resource checks/allocation, logging levels, etc.

    Allowed values are: "production" and "testing".

  • rest_port | int

    Default: 8083

    Port used for Apache Kafka Connect REST API endpoint.

  • system-users | string

    User-provided secret ID which defines custom username/passwords on the Kafka Connect REST Interface. The secret ID format is like "secret:cvh7kruupa1s46bqvuig" and should not be confused with secret name or label.

    The secret could be defined using juju add-secret <secret-name> admin=<admin-password> command, where admin is the internal user created by the charm. The juju add-secret command will output the secret ID, which can then be granted to the charm and configured using juju config command. The following example shows the complete flow:

    $ juju add-secret my-auth admin=adminpass

    some ID will be printed: e.g. "secret:cvh7kruupa1s46bqvuig". take note of that.

    $ juju grant-secret my-auth kafka-connect $ juju config kafka-connect system-users=secret:cvh7kruupa1s46bqvuig

  • value_converter | string

    Default: org.apache.kafka.connect.json.JsonConverter

    Converter class used to convert between Kafka Connect format and the serialized form that is written to Kafka. This controls the format of the values in messages written to or read from Kafka, and since this is independent of connectors, it allows any connector to work with any serialization format. Examples of common formats include JSON and Avro.

    Note: For custom converters, the library files should be provided to the charm beforehand using juju attach-resource command. Please refer to the docs for more details.