Skip to content

Kafka Configuration

The Kafka environment must be configured using the Kafka property in MasterConfig.json.

Kafka Configuration
{
 "Kafka": {
  "Brokers": [
   {
    "Host": "10.10.106.31",
    "Port": 9092
   },
   {
    "Host": "10.10.106.32",
    "Port": 9092
   },  {
    "Host": "10.10.106.33",
    "Port": 9092
   }
  ],
  "ConsoleURL": "http://10.10.106.31:8084",
  "CDC": {
   "Topic": "DEFAULT_REPLICATOR",
   "Partition": 0
  },
  "Snapshots": {
   "Request": {
    "Topic": "DEFAULT_REQUEST_SNAPSHOT",
    "Partition": 0
   },
   "Response": {
    "Topic": "DEFAULT_SNAPSHOT",
    "Partition": 0
   }
  },
  "StaleAfterHours": 336,
  "ClientConnectRetrySeconds": 30,
  "TransportSecurity": "None",
  "SaslAuthMechanism": "None"
 }
}

Configuration Properties

Property Type Description
Brokers Object array Defines one or more Kafka brokers active in the environment. Each broker object has the following properties: Host (string): The DNS name of the IP address of the system hosting the broker. Port (integer): The TCP/IP port number that the broker listens on (default 9092).
CDC Object array Provides information about the topic that records change data. The object has two properties: Topic (string): The name of the topic. Partition (integer): The partition number associated with the topic (default 0).
ClientConnectRetrySeconds Integer If a client connection fails, how long should the agent wait before retrying the connection (default 30 seconds)
ConsoleURL String If the Kafka environment has a browser-based console available (e.g., Redpanda Console), this property defines the URL used to access that console.
Snapshots Object Provides information about the topic used to request a new snapshot (the snapshot request topic) and the topic used to record available snapshots (the snapshot response topic). The object has two properties: Request (object) Response (object). Both the Request and Response properties are objects with two properties: Topic (string): The topic name. Partition (int): The partition number associated with the topic (default 0).
SaslAuthMechanism Enum The SASL authentication mechanism configured by the Kafka server. Value is one of None, Plain, ScramSha256, ScramSha512, OAuthBearer or Gssapi. SASL mechanisms other than None are not currently supported by clients.
StaleAfterHours Integer The number of hours after which snapshot data is considered stale (default 336, which is two weeks).
TransportSecurity Enum The transport security configured by the Kafka server: Value is one of None (all servers accepted), Tls (server certificate validation), or MutualTls (client and server certificate validation)