Uploaded image for project: 'Kafka'
  1. Kafka
  2. KAFKA-4260

Improve documentation of configuration listeners=PLAINTEXT://0.0.0.0:9092

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Resolved
    • Minor
    • Resolution: Fixed
    • 0.10.0.1
    • 1.0.0
    • documentation

    Description

      We have just updated our testing Kafka cluster to 0.10 and we were facing one issue with migration of legacy 0.8 configuration to

      listeners=PLAINTEXT://0.0.0.0:9092
      # advertised.listeners=PLAINTEXT://myPublicHostName:9092    # REQUIRED for 0.0.0.0:9092
      

      This configuration will be invalid if advertised.listeners is not set too. Connection string 0.0.0.0:9092 is stored to ZooKeeper according to documentation of advertised.listeners and observed behavior, but it isn't obvious and difficult to analyze. Clients and even other brokers try to communicate with brokers using destination address 0.0.0.0:9092, which is impossible. Specification of advertised.listeners as shown above fixed the issue.

      Please update documentation at http://kafka.apache.org/0100/documentation#brokerconfigs and backport the change to 0.9 and 0.10 branches.

      advertised.listeners

      Listeners to publish to ZooKeeper for clients to use, if different than the `listeners` above. 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 `listeners` will be used.

      listeners

      Listener List - Comma-separated list of URIs we will listen on and their protocols. Specify hostname as 0.0.0.0 to bind to all interfaces (note `advertised.listeners` configuration is required for 0.0.0.0). Leave hostname empty to bind to default interface. Examples of legal listener lists: PLAINTEXT://myhost:9092,TRACE://:9091 PLAINTEXT://0.0.0.0:9092, TRACE://localhost:9093

      Attachments

        Issue Links

          Activity

            People

              tombentley Tom Bentley
              turek@avast.com Michal Turek
              Votes:
              1 Vote for this issue
              Watchers:
              6 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: