diff --git a/server/src/main/java/org/apache/kafka/network/SocketServerConfigs.java b/server/src/main/java/org/apache/kafka/network/SocketServerConfigs.java index d623090ad8309..ba17a250ef2e9 100644 --- a/server/src/main/java/org/apache/kafka/network/SocketServerConfigs.java +++ b/server/src/main/java/org/apache/kafka/network/SocketServerConfigs.java @@ -78,8 +78,10 @@ public class SocketServerConfigs { " PLAINTEXT://127.0.0.1:9092,SSL://[::1]:9092%n"; public static final String ADVERTISED_LISTENERS_CONFIG = "advertised.listeners"; - public static final String ADVERTISED_LISTENERS_DOC = String.format( - "Listeners to publish to ZooKeeper for clients to use, if different than the %s config property." + + public static final String ADVERTISED_LISTENERS_DOC = String.format("Specifies the listener addresses that the Kafka brokers will advertise to clients and other brokers." + + " The config is useful where the actual listener configuration %s does not represent the addresses that clients should" + + " use to connect, such as in cloud environments. In environments using ZooKeeper, these addresses are published to ZooKeeper." + + " In Kraft mode, the address would be published to and managed by kraft controller, the brokers would pull these data from controller as needed." + " In IaaS environments, this may need to be different from the interface to which the broker binds." + " If this is not set, the value for %1$1s will be used." + " Unlike %1$1s, it is not valid to advertise the 0.0.0.0 meta-address.%n" +