Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/david-yu/docker-kafka

A docker container to run Kafka
https://github.com/david-yu/docker-kafka

kafka

Last synced: 18 days ago
JSON representation

A docker container to run Kafka

Awesome Lists containing this project

README 

        
kafka

============



Dockerfile for [Apache Kafka](http://kafka.apache.org/)



The image is available directly from [Docker Hub](https://hub.docker.com/r/yongshin/docker-kafka/)



## Pre-Requisites



- modify the ```KAFKA_ADVERTISED_HOST_NAME``` in ```docker-compose.yml``` to match your docker host IP (Note: Do not use localhost or 127.0.0.1 as the host ip if you want to run multiple brokers.)

- if you want to customise any Kafka parameters, simply add them as environment variables in ```docker-compose.yml```, e.g. in order to increase the ```message.max.bytes``` parameter set the environment to ```KAFKA_MESSAGE_MAX_BYTES: 2000000```. To turn off automatic topic creation set ```KAFKA_AUTO_CREATE_TOPICS_ENABLE: 'false'```



## Usage



Start a cluster:



- ```docker stack deploy -c docker-compose.yml kafka```



Add more brokers:



- ```docker-compose scale kafka=3```



Destroy a cluster:



- ```docker-compose stop```



##Note



The default ```docker-compose.yml``` should be seen as a starting point. By default each broker will get a new port number and broker id on restart. Depending on your use case this might not be desirable. If you need to use specific ports and broker ids, modify the docker-compose configuration accordingly, e.g. [docker-compose-single-broker.yml](https://github.com/wurstmeister/kafka-docker/blob/master/docker-compose-single-broker.yml):



- ```docker-compose -f docker-compose-single-broker.yml up```



## Broker IDs



If you don't specify a broker id in your docker-compose file, it will automatically be generated (see [https://issues.apache.org/jira/browse/KAFKA-1070](https://issues.apache.org/jira/browse/KAFKA-1070). This allows scaling up and down. In this case it is recommended to use the ```--no-recreate``` option of docker-compose to ensure that containers are not re-created and thus keep their names and ids.



## Automatically create topics



If you want to have kafka-docker automatically create topics in Kafka during

creation, a ```KAFKA_CREATE_TOPICS``` environment variable can be

added in ```docker-compose.yml```.



Here is an example snippet from ```docker-compose.yml```:



        environment:

          KAFKA_CREATE_TOPICS: "Topic1:1:3,Topic2:1:1:compact"



```Topic 1``` will have 1 partition and 3 replicas, ```Topic 2``` will have 1 partition, 1 replica and a `cleanup.policy` set to `compact`.



##Advertised hostname



You can configure the advertised hostname in different ways



1. explicitly, using ```KAFKA_ADVERTISED_HOST_NAME```

2. via a command, using ```HOSTNAME_COMMAND```, e.g. ```HOSTNAME_COMMAND: "route -n | awk '/UG[ \t]/{print $$2}'"```



When using commands, make sure you review the "Variable Substitution" section in [https://docs.docker.com/compose/compose-file/](https://docs.docker.com/compose/compose-file/)



If ```KAFKA_ADVERTISED_HOST_NAME``` is specified, it takes presendence over ```HOSTNAME_COMMAND```



For AWS deployment, you can use the Metadata service to get the container host's IP:

```

HOSTNAME_COMMAND=wget -t3 -T2 -qO-  http://169.254.169.254/latest/meta-data/local-ipv4

```

Reference: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html



## JMX



For monitoring purposes you may wish to configure JMX. Additional to the standard JMX parameters, problems could arise from the underlying RMI protocol used to connect



* java.rmi.server.hostname - interface to bind listening port

* com.sun.management.jmxremote.rmi.port - The port to service RMI requests



For example, to connect to a kafka running locally (assumes exposing port 1099)



      KAFKA_JMX_OPTS: "-Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false -Djava.rmi.server.hostname=127.0.0.1 -Dcom.sun.management.jmxremote.rmi.port=1099"

      JMX_PORT: 1099



Jconsole can now connect at ```jconsole 192.168.99.100:1099```



## Tutorial



[http://wurstmeister.github.io/kafka-docker/](http://wurstmeister.github.io/kafka-docker/)