Current state: Adopted
Discussion thread: here
Please keep the discussion on the mailing list rather than commenting on the wiki (wiki discussions get unwieldy fast).
During the 0.9.0.0 release cycle, support for multiple listeners per broker was introduced. Each listener is associated with a security protocol, ip/host and port. When combined with the advertised listeners mechanism, there is a fair amount of flexibility with one limitation: at most one listener per security protocol in each of the two configs (
In some environments, one may want to differentiate between external clients, internal clients and replication traffic independently of the security protocol for cost, performance and security reasons. A few examples that illustrate this:
- Replication traffic is assigned to a separate network interface so that it does not interfere with client traffic.
- External traffic goes through a proxy/load-balancer (security, flexibility) while internal traffic hits the brokers directly (performance, cost).
- Different security settings for external versus internal traffic even though the security protocol is the same (e.g. different set of enabled SASL mechanisms, authentication servers, different keystores, etc.)
As such, we propose that Kafka brokers should be able to define multiple listeners for the same security protocol for binding (i.e.
listeners) and sharing (i.e.
advertised.listeners) so that internal, external and replication traffic can be separated if required.
A new broker config
listener.security.protocol.map will be introduced so that we can map a listener name to a security protocol. The config value should be in the CSV Map format that is currently used by
max.connections.per.ip.overrides. The config value should follow map semantics: each key should only appear once, but values may appear multiple times. For example, the config could be defined in the following way to match the existing behaviour:
To ensure compatibility with existing configs, we propose the above as the default value for the new config.
The next step is to change the validation of
listeners so that the listener name has to be one of the keys in
listener.security.protocol.map (only security protocols are allowed currently). For example, the following would configure a broker with two different host:port pairs mapped to the same security protocol in two cases:
We then introduce a second broker config as an alternative to
It is an error to set both
inter.broker.listener.name at the same time.
inter.broker.listener.name will be
null by default, which means that the
PLAINTEXT protocol will be used by default (as is currently the case).
Finally, we make it possible to provide different security (SSL and SASL) settings for each listener name by adding a normalised prefix (the listener name is lowercased) to the config name. For example, if we wanted to set a different keystore for the CLIENT listener, we would set a config with name
. If the config for the listener name is not set, we will fallback to the generic config (i.e.
ssl.keystore.location) for compatibility and convenience. For the SASL case, some configs are provided via a JAAS file, which consists of one or more entries. The broker currently looks for an entry named
KafkaServer. We will extend this so that the broker first looks for an entry with a lowercased listener name followed by a dot as a prefix to the existing name. For the CLIENT listener example, the broker would first look for
client.KafkaServer with a fallback to
KafkaServer, if necessary
Version 4 of the broker registration data stored in ZooKeeper will have listener names instead of security protocols in the elements of the
endpoints array and an additional
listener.security.protocol.map field. The latter is not strictly needed if we assume that all brokers have the same config, but it would make config updates trickier (e.g. two rolling bounces would be required to add a new mapping from listener name to security protocol). Also, we add an additional field instead of changing the
endpoints schema to allow for rolling upgrades.
Version 3 of UpdateMetadataRequest will be introduced and the elements of the
end_points array would also have a listener_name field.
Listener names only exist in the brokers, clients never see them.
We would have to change a number of places in the code that currently use
SecurityProtocol as a key to use the listener name instead. A few examples:
- Acceptor thread
- Metadata request handler
- Broker class
The changes are mostly mechanical and don't affect public API.
We would also have to change the various authenticator classes to look for security configs for the relevant listener name before falling back to the generic ones.
As stated previously, clients never see listener names and will make metadata requests exactly as before. The difference is that the list of endpoints they get back is restricted to the listener name of the endpoint where they made the request. In the example above, let's assume that all brokers are configured similarly and that a client sends a metadata request to
cluster1.foo.com:9092 and it reaches broker1's 22.214.171.124:9092 interface via a load balancer. The security protocol would be
SASL_PLAINTEXT and the metadata response would contain
host=cluster1.foo.com,port=9092 for each broker returned.
The exception is ZooKeeper-based consumers. These consumers retrieve the broker registration information directly from ZooKeeper and will choose the first listener with PLAINTEXT as the security protocol (the only security protocol they support).
Compatibility, Deprecation, and Migration Plan
As mentioned previously, the default value of
listener.security.protocol.map maps the existing security protocols to a listener with the same name to maintain compatibility:
For users upgrading, they should only use listener names once all the brokers have been upgraded to a version that supports listener names. ZooKeeper-based consumers will use the first listener with PLAINTEXT as the security protocol, so listener ordering is important in such cases.
- Instead of adding the
listener.security.protocol.mapconfig, we could extend the protocol part of the listener definition to include both the listener name and security protocol. For example,
CLIENT+SASL_PLAINTEXT://126.96.36.199:9092.This is appealing from a clarity perspective (the listeners are fully defined in a single config value), but it may lead to duplication between
advertised.listeners. A way to avoid that issue (at the cost of loss of symmetry) would be for
advertised.listenersto only include the listener name (we can infer the security protocol by looking at the
listenersentry with the same name).
- Assume that
listener.security.protocol.mapis the same in every broker. The slight benefit in terms of smaller broker registration JSON is not worth the additional operational complexity when it comes to changing the config values in a running cluster (two rolling upgrades would be needed in some simple cases).
- Using hard-coded listener domains for internal and replication traffic. The config format is simpler and there's less scope for hard to understand configs. The main disadvantage is that it's a bit too specific and may need to be extended again as more sophisticated use cases appear. The current proposal is more general and it seems like a natural evolution of the existing system.