kafka-jira mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (KAFKA-4260) Improve documentation of configuration listeners=PLAINTEXT://
Date Tue, 20 Jun 2017 11:19:00 GMT

    [ https://issues.apache.org/jira/browse/KAFKA-4260?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16055601#comment-16055601

ASF GitHub Bot commented on KAFKA-4260:

GitHub user tombentley opened a pull request:


    KAFKA-4260: Check for nonroutable address in advertised.listeners

    As described in KAFKA-4260, when `listeners=PLAINTEXT://` (note the
"bind all interfaces" IP address) and `advertised.listeners` is not specified it defaults
to `listeners`, but it makes no sense to advertise as it's not a routable IP address.
    This patch checks for a host in `advertised.listeners` (whether via default or
not) and fails with a meaningful error if it's found.
    This contribution is my original work and I license the work to the project under the
project's open source license.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/tombentley/kafka advertised.listeners

Alternatively you can review and apply these changes as the patch at:


To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #3382
commit 4286adcecbf9de28ffe66ca5afd6626bc9cace1a
Author: Tom Bentley <tbentley@redhat.com>
Date:   2017-06-20T10:40:22Z

    KAFKA-4260: Check for nonroutable address is advertised.listeners


> Improve documentation of configuration listeners=PLAINTEXT://
> -------------------------------------------------------------------------
>                 Key: KAFKA-4260
>                 URL: https://issues.apache.org/jira/browse/KAFKA-4260
>             Project: Kafka
>          Issue Type: Improvement
>          Components: documentation
>    Affects Versions:
>            Reporter: Michal Turek
>            Priority: Minor
> 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
> {noformat}
> listeners=PLAINTEXT://
> # advertised.listeners=PLAINTEXT://myPublicHostName:9092    # REQUIRED for
> {noformat}
> This configuration will be invalid if {{advertised.listeners}} is not set too. Connection
string 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, 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.
> h4. 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.
> h4. listeners
> Listener List - Comma-separated list of URIs we will listen on and their protocols. Specify
hostname as to bind to all interfaces *(note `advertised.listeners` configuration
is required for*. Leave hostname empty to bind to default interface. Examples of
legal listener lists: PLAINTEXT://myhost:9092,TRACE://:9091 PLAINTEXT://, TRACE://localhost:9093

This message was sent by Atlassian JIRA

View raw message