ijuma / configuration-templates

Central location for template configurations for Apache Kafka and Confluent Platform components

About

Template configuration files for Apache Kafka® clients and Confluent Platform components.

How to use these template files

With Confluent Cloud

These instructions are for users who need template files with client application configurations for Confluent Cloud.

1. Select which file you need based on the client type:

   • Java-based client or Java-based client with Confluent Cloud Schema Registry: e.g., Java, Groovy, Kotlin, Scala, Clojure
   • librdkafka-based client or librdkafka-based client with Confluent Cloud Schema Registry: e.g., Python, Go, Ruby, Node, kafkacat, .NET, C
   • Springboot client or Springboot client with Confluent Cloud Schema Registry
   • Confluent Platform component or Confluent Platform component with Confluent Cloud Schema Registry: e.g., Confluent CLI, Apache Kafka commands, kafka-connect-datagen, ksql-datagen

2. Copy the file locally.

3. Customize the file with connection information to your Kafka cluster. Notice that the file cannot be used as-is because it has parameters that need to be substituted with real values. You need to modify the file to provide the real values for the following parameters. (Here is how to create or find those values)

• Required:

  • {{ BROKER_ENDPOINT }}
  • {{ CLUSTER_API_KEY }}
  • {{ CLUSTER_API_SECRET }}

• Required if using Confluent Cloud Schema Registry:

  • {{ SR_API_KEY }}
  • {{ SR_API_SECRET }}
  • {{ SR_ENDPOINT }}

4. (optional) If you are using a librdkafka-based client, additional configuration properties are supported. See CONFIGURATION.md for the full list.

With Confluent Platform running on localhost

These instructions are for users who need template files with client application configurations for Confluent Platform running on their local machines, often started with confluent start.

1. Select which file you need based on the client type:

   • Java-based client or Java-based client with Confluent Schema Registry: e.g., Java, Groovy, Kotlin, Scala, Clojure
   • librdkafka-based client or librdkafka-based client with Confluent Schema Registry: e.g., Python, Go, Ruby, Node, kafkacat, .NET, C
   • Springboot client or Springboot client with Confluent Schema Registry
   • Confluent Platform component or Confluent Platform component with Confluent Schema Registry: e.g., Confluent CLI, Apache Kafka commands, kafka-connect-datagen, ksql-datagen

2. Copy the file locally.

3. (optional) If you are using a librdkafka-based client, additional configuration properties are supported. See CONFIGURATION.md for the full list.