Configuration Options for Cluster Linking

Looking for Confluent Cloud Cluster Linking docs? You are currently viewing Confluent Platform documentation. If you are looking for Confluent Cloud docs, check out Cluster Linking on Confluent Cloud.


This feature is available as a preview feature. A preview feature is a component of Confluent Platform that is being introduced to gain early feedback from developers. This feature can be used for evaluation and non-production testing purposes or to provide feedback to Confluent.

Enabling Cluster Linking

To enable Cluster Linking, add the following line to the broker configuration on the destination cluster (for example $CONFLUENT_HOME/etc/

Cluster Linking is not available as a dynamic configuration. You must either enable it before starting the brokers, or to enable it on a running cluster, set the configuration on the brokers and restart them to perform a rolling update.

Configuration options for the cluster links themselves are available as values for flags on the kafka-cluster-links command. These are documented below.

Using Cluster Linking with Confluent for Kubernetes

You can use Cluster Linking with Confluent Platform deployed with Confluent for Kubernetes.

To configure Cluster Linking on Confluent for Kubernetes, use configOverrides in the Kafka custom resource. See Configuration Overrides in the Confluent for Kubernetes documentation for more information about using configOverrides.

kind: Kafka
  name: kafka
  namespace: confluent
  replicas: 3
    application: confluentinc/cp-server-operator:
    init: confluentinc/cp-init-container-operator:
  dataVolumeCapacity: 10Gi
      - # Enable Cluster Linking

Using Cluster Linking with Ansible

You can use Cluster Linking with Confluent Platform deployed with Ansible .

To configure Cluster Linking with Ansible, add to the kafka_broker_custom_properties section in the inventory as describe in Configure Confluent Platform with Ansible.

For example:

    kafka_broker_custom_properties: "true"

Common Configuration Options

The following subset of common properties, although not specific to Cluster Linking, may be particularly relevant to setting up and managing cluster links. These are common across Confluent Platform for clients, brokers, and security configurations, and are described in their respective sections per the links provided.

Client Configurations

For a full list of AdminClient configurations, see AdminClient Configurations.

  • bootstrap.servers
  • client.dns.lookup

Client SASL and SSL Configurations

  • sasl.client.callback.handler.class
  • sasl.jaas.config
  • sasl.kerberos.kinit.cmd
  • sasl.kerberos.min.time.before.relogin
  • sasl.kerberos.ticket.renew.jitter
  • sasl.kerberos.ticket.renew.window.factor
  • sasl.login.callback.handler.class
  • sasl.login.class
  • sasl.login.refresh.buffer.seconds
  • sasl.login.refresh.min.period.seconds
  • sasl.login.refresh.window.factor
  • sasl.login.refresh.window.jitter
  • sasl.mechanism
  • security.protocol
  • ssl.cipher.suites
  • ssl.enabled.protocols
  • ssl.endpoint.identification.algorithm
  • ssl.engine.factory.class
  • ssl.key.password
  • ssl.keymanager.algorithm
  • ssl.keystore.location
  • ssl.keystore.password
  • ssl.keystore.type
  • ssl.protocol
  • ssl.provider
  • ssl.trustmanager.algorithm
  • ssl.truststore.location
  • ssl.truststore.password
  • ssl.truststore.type