On this page:
   28.12    Cluster Manager Message Broker 28.14    Credentials   

28.13Kafka

 

The Kafka configuration category includes the following configurable options:

  • Kafka Bootstrap Address

  • Kafka Subscription Matcher Consumer Group Id

  • Validate Kafka Topics Exist Before Use

  • Kafka Consumer Auto Commit Enabled

  • Kafka Consumer Ack Mode

  • Kafka Broker SSL Enabled

  • Kafka SSL TrustStore File Location

  • Kafka SSL Truststore Password

  • Kafka SSL Keystore Location

  • Kafka Keystore Password

  • Kafka SSL Key Password

  • Kafka Security Protocol

  • Kafka SASL Mechanism

  • Kafka SASL JAAS Config

  • Kafka Producer Config Properties (Text)

  • Kafka Producer Config Properties (File)

  • Kafka Consumer Config Properties (Text)

  • Kafka Consumer Config Properties (File)

28.13.1Property: Kafka Bootstrap Address

 
Property Name Kafka Bootstrap Address
Property Key
Property Type STRING
Description This is a comma-separated list of host and port pairs that are the addresses of the Kafka brokers in a "bootstrap" Kafka cluster that a Kafka client connects to initially to bootstrap itself.
Default Value localhost:9092
Example Property
module.[MODULE_ID].config.kafka.bootstrap_address = localhost:9092

28.13.2Property: Kafka Subscription Matcher Consumer Group Id

 
Property Name Kafka Subscription Matcher Consumer Group Id
Property Key
Property Type STRING
Description The name of the kafka consumer group id used by all Kafka subscription consumers.
Default Value smilecdr
Example Property
module.[MODULE_ID].config.kafka.group_id = smilecdr

28.13.3Property: Validate Kafka Topics Exist Before Use

 
Property Name Validate Kafka Topics Exist Before Use
Property Key
Property Type BOOLEAN
Description Set this to true if your Kafka broker is configured to prevent new topics from being automatically created (e.g. if 'auto.create.topics.enable' is set to false on the broker). When this property is set to true, Smile will prevent subscriptions from being created or updated if the delivery topic they depend on doesn't exist yet.
Default Value false
Example Property
module.[MODULE_ID].config.kafka.validate_topics_exist_before_use = false

28.13.4Property: Kafka Consumer Auto Commit Enabled

 
Property Name Kafka Consumer Auto Commit Enabled
Property Key
Property Type BOOLEAN
Description If this property is set to true, Kafka auto-commits the offsets according to its configuration. If it is false, the Kafka Consumer Ack Mode is used to determine commit behavior. See Committing Offsets
Default Value false
Example Property
module.[MODULE_ID].config.kafka.auto_commit = false

28.13.5Property: Kafka Consumer Ack Mode

 
Property Name Kafka Consumer Ack Mode
Property Key
Property Type ENUM
Values
  • RECORD
  • BATCH
  • TIME
  • COUNT
  • COUNT_TIME
  • MANUAL
  • MANUAL_IMMEDIATE
Description Kafka consumer listener container offset commit behavior. This value is only used if Kafka Auto Commit is false. By default, cdr kafka consumers manually acknowledge every successful message processing back to the Kafka broker. This ensures that no message is ever processed twice. However it adds processing overhead. If downstream consumers can process the same message twice, then it is recommended to set kafka.auto_commit to true (in which case the kafka.ack_mode property will be ignored). See Committing Offsets for a list of options.
Default Value MANUAL
Example Property
module.[MODULE_ID].config.kafka.ack_mode = MANUAL

28.13.6Property: Kafka Broker SSL Enabled

 
Property Name Kafka Broker SSL Enabled
Property Key
Property Type BOOLEAN
Description Enable this if your Kafka Broker requires SSL
Default Value false
Example Property
module.[MODULE_ID].config.kafka.ssl.enabled = false

28.13.7Property: Kafka SSL TrustStore File Location

 
Property Name Kafka SSL TrustStore File Location
Property Key
Property Type STRING
Description The location on disk of your kafka TrustStore file
Default Value keystore/server.truststore.jks
Example Property
module.[MODULE_ID].config.kafka.ssl.truststore.location = keystore/server.truststore.jks

28.13.8Property: Kafka SSL Truststore Password

 
Property Name Kafka SSL Truststore Password
Property Key
Property Type PASSWORD
Description The password of your SSL Truststore file
Default Value (no default)
Example Property
module.[MODULE_ID].config.kafka.ssl.truststore.password = 

28.13.9Property: Kafka SSL Keystore Location

 
Property Name Kafka SSL Keystore Location
Property Key
Property Type STRING
Description The location on disk of your Kafka keystore file
Default Value keystore/server.keystore.jks
Example Property
module.[MODULE_ID].config.kafka.ssl.keystore.location = keystore/server.keystore.jks

28.13.10Property: Kafka Keystore Password

 
Property Name Kafka Keystore Password
Property Key
Property Type PASSWORD
Description The password of your SSL Keystore file
Default Value (no default)
Example Property
module.[MODULE_ID].config.kafka.ssl.keystore.password = 

28.13.11Property: Kafka SSL Key Password

 
Property Name Kafka SSL Key Password
Property Key
Property Type STRING
Description The Password for your SSL Key
Default Value (no default)
Example Property
module.[MODULE_ID].config.kafka.ssl.key.password = 

28.13.12Property: Kafka Security Protocol

 
Property Name Kafka Security Protocol
Property Key
Property Type ENUM
Values
  • PLAINTEXT
  • SSL
  • SASL_PLAINTEXT
  • SASL_SSL
Description The Kafka Security Protocol to use.
Default Value PLAINTEXT
Example Property
module.[MODULE_ID].config.kafka.security.protocol = PLAINTEXT

28.13.13Property: Kafka SASL Mechanism

 
Property Name Kafka SASL Mechanism
Property Key
Property Type STRING
Description If the Kafka Security Protocol is set to use SASL, specifies the associated mechanism to use.
Default Value (no default)
Example Property
module.[MODULE_ID].config.kafka.sasl.mechanism = 

28.13.14Property: Kafka SASL JAAS Config

 
Property Name Kafka SASL JAAS Config
Property Key
Property Type STRING
Description If the Kafka Security Protocol is set to use SASL, specifies the associated JAAS configuration string.
Default Value (no default)
Example Property
module.[MODULE_ID].config.kafka.sasl.jaas.config = 

28.13.15Property: Kafka Producer Config Properties (Text)

 
Property Name Kafka Producer Config Properties (Text)
Property Key
Property Type PROPERTIES
Description If set, the Kafka Producer Config properties provided here are used by all Kafka Producers
Default Value (no default)
Example Property
module.[MODULE_ID].config.kafka.producer.properties.text = 

28.13.16Property: Kafka Producer Config Properties (File)

 
Property Name Kafka Producer Config Properties (File)
Property Key
Property Type Resource Path
Description If set, the Kafka Producer Config properties listed in this file are used by all Kafka Producers
Default Value (no default)
Example Property
module.[MODULE_ID].config.kafka.producer.properties.file = 

28.13.17Property: Kafka Consumer Config Properties (Text)

 
Property Name Kafka Consumer Config Properties (Text)
Property Key
Property Type PROPERTIES
Description If set, the Kafka Consumer Config properties provided here are used by all Kafka Consumers
Default Value (no default)
Example Property
module.[MODULE_ID].config.kafka.consumer.properties.text = 

28.13.18Property: Kafka Consumer Config Properties (File)

 
Property Name Kafka Consumer Config Properties (File)
Property Key
Property Type Resource Path
Description If set, the Kafka Consumer Config properties listed in this file are used by all Kafka Consumers
Default Value (no default)
Example Property
module.[MODULE_ID].config.kafka.consumer.properties.file = 
   28.12    Cluster Manager Message Broker 28.14    Credentials