Chapter 16. GenericKafkaListenerConfigurationBroker schema reference
Used in: GenericKafkaListenerConfiguration
Full list of GenericKafkaListenerConfigurationBroker schema properties
You can see example configuration for the nodePort, host, loadBalancerIP and annotations properties in the GenericKafkaListenerConfigurationBootstrap schema, which configures bootstrap service overrides.
Advertised addresses for brokers
By default, Streams for Apache Kafka tries to automatically determine the hostnames and ports that your Kafka cluster advertises to its clients. This is not sufficient in all situations, because the infrastructure on which Streams for Apache Kafka is running might not provide the right hostname or port through which Kafka can be accessed.
You can specify a broker ID and customize the advertised hostname and port in the configuration property of the listener. Streams for Apache Kafka will then automatically configure the advertised address in the Kafka brokers and add it to the broker certificates so it can be used for TLS hostname verification. Overriding the advertised host and ports is available for all types of listeners.
Example of an external route listener configured with overrides for advertised addresses
listeners:
#...
- name: external1
port: 9094
type: route
tls: true
authentication:
type: tls
configuration:
brokers:
- broker: 0
advertisedHost: example.hostname.0
advertisedPort: 12340
- broker: 1
advertisedHost: example.hostname.1
advertisedPort: 12341
- broker: 2
advertisedHost: example.hostname.2
advertisedPort: 12342
# ...
16.1. GenericKafkaListenerConfigurationBroker schema properties
| Property | Property type | Description |
|---|---|---|
| broker | integer | ID of the kafka broker (broker identifier). Broker IDs start from 0 and correspond to the number of broker replicas. |
| advertisedHost | string |
The host name used in the brokers' |
| advertisedPort | integer |
The port number used in the brokers' |
| host | string |
The broker host. This field will be used in the Ingress resource or in the Route resource to specify the desired hostname. This field can be used only with |
| nodePort | integer |
Node port for the per-broker service. This field can be used only with |
| loadBalancerIP | string |
The loadbalancer is requested with the IP address specified in this field. This feature depends on whether the underlying cloud provider supports specifying the |
| annotations | map |
Annotations that will be added to the |
| labels | map |
Labels that will be added to the |
