kafka_proxy_config

The kafka_proxy_config section of the YDB configuration file enables and configures Kafka Proxy, which provides access to work with YDB Topics via Kafka API.

Description of parameters

Parameter Type Default value Description
enable_kafka_proxy bool false Enables or disables Kafka Proxy.
listening_port int32 9092 The port on which the Kafka API will be available.
transaction_timeout_ms uint32 300000 (5 minutes) The maximum timeout for Kafka transactions, after which the transaction will be cancelled.
auto_create_topics_enable bool false Enables automatic creation of topics when they are accessed. Analogous to the same option in Apache Kafka.
auto_create_consumers_enable bool true Enables automatic registration of consumers when they are accessed.
topic_creation_default_partitions uint32 1 The number of partitions that will be created if the number of partitions is not specified when adding a topic via the Kafka protocol. Analogous to num.partitions option in Apache Kafka.
ssl_cerificate string — The path to the SSL certificate file, which includes both the certificate file and the key file. When this parameter is specified, Kafka Proxy automatically starts processing requests using the specified SSL certificate.
cert string — The path to the SSL certificate file. When this parameter is specified, Kafka Proxy automatically starts processing requests using the specified SSL certificate.
key string — The path to the SSL key file.

Example of a completed config

kafka_proxy_config:
  enable_kafka_proxy: true
  listening_port: 9092
  transaction_timeout_ms: 300000 # 5 minutes
  auto_create_topics_enable: true
  auto_create_consumers_enable: true
  topic_creation_default_partitions: 1
  cert: /path/to/cert.pem
  key: /path/to/key.pem
Previous
hosts
Next
log_config