From 36a36032acac13aa4b340557fcf4c1d1a9c053ee Mon Sep 17 00:00:00 2001 From: Staffan Olsson Date: Fri, 28 Jul 2017 09:31:39 +0200 Subject: Could be the motivation --- README.md | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7841df0..dd16bc7 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,32 @@ -# Kafka as Kubernetes StatefulSet -Transparent Kafka setup that you can grow with, -extendable through [addon](https://github.com/Yolean/kubernetes-kafka/labels/addon)s. +# Kafka on Kubernetes +Transparent Kafka setup that you can grow with. +Good for both experiments and production. -Example of three Kafka brokers depending on five Zookeeper instances. +How to use: + * Run a Kubernetes cluster, [minikube](https://github.com/kubernetes/minikube) or real. + * To quickly get a small Kafka cluster running, use the `kubectl apply`s below. + * To start using Kafka for real, fork and have a look at [addon](https://github.com/Yolean/kubernetes-kafka/labels/addon)s. + * Join the discussion here in issues and PRs. -To get consistent service DNS names `kafka-N.broker.kafka`(`.svc.cluster.local`), run everything in a [namespace](http://kubernetes.io/docs/admin/namespaces/walkthrough/): +Why? +No single readable readme can properly introduce both Kafka and Kubernets. +We started this project as beginners with both, +and by now our microservices enjoy lock-in with this "Streaming Platform" :smile:. +We read [Designing Data-Intensive Applications](http://dataintensive.net/) +and the [Confluent blog](https://www.confluent.io/blog/). + +## What you get + +[Bootstrap servers](http://kafka.apache.org/documentation/#producerconfigs): ``` -kubectl create -f 00namespace.yml +kafka-0.broker.kafka.svc.cluster.local:9092,kafka-1.broker.kafka.svc.cluster.local:9092,kafka-2.broker.kafka.svc.cluster.local:9092` ``` +Zookeeper at `zookeeper.kafka.svc.cluster.local:2181`. + ## Set up Zookeeper The Kafka book (Definitive Guide, O'Reilly 2016) recommends that Kafka has its own Zookeeper cluster with at least 5 instances. -- cgit v1.2.3