aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorStaffan Olsson <staffan@repos.se>2017-10-15 10:33:21 +0200
committerStaffan Olsson <staffan@repos.se>2017-10-15 10:33:21 +0200
commit6a4c04754a9f8e567a128282ade77369ee07c524 (patch)
treefceea6548f8405f0704e5952c8033a14f8334402 /README.md
parentbe14a18f536c3ce04fae89930453e4d0c46553b3 (diff)
downloadkubernetes-kafka-6a4c04754a9f8e567a128282ade77369ee07c524.tar.gz
kubernetes-kafka-6a4c04754a9f8e567a128282ade77369ee07c524.tar.bz2
kubernetes-kafka-6a4c04754a9f8e567a128282ade77369ee07c524.zip
Some ideas on how to keep this repo simple
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index 21733e8..66f329f 100644
--- a/README.md
+++ b/README.md
@@ -6,9 +6,12 @@ Transparent Kafka setup that you can grow with.
Good for both experiments and production.
How to use:
+ * Good to know: you'll likely want to fork this repo. It prioritizes clarity over configurability, using plain manifests and .propeties files; no client side logic.
* Run a Kubernetes cluster, [minikube](https://github.com/kubernetes/minikube) or real.
* Quickstart: use the `kubectl apply`s below.
- * Kafka for real: fork and have a look at [addon](https://github.com/Yolean/kubernetes-kafka/labels/addon)s.
+ * Have a look at [addon](https://github.com/Yolean/kubernetes-kafka/labels/addon)s, or the official forks:
+ - [kubernetes-kafka-small](https://github.com/Reposoft/kubernetes-kafka-small) for single-node clusters like Minikube.
+ - [StreamingMicroservicesPlatform](https://github.com/StreamingMicroservicesPlatform/kubernetes-kafka) Like Confluent's [platform quickstart](https://docs.confluent.io/current/connect/quickstart.html) but for Kubernetes.
* Join the discussion in issues and PRs.
No readable readme can properly introduce both [Kafka](http://kafka.apache.org/) and [Kubernetes](https://kubernetes.io/),
@@ -71,6 +74,9 @@ at least not [until Kubernetes 1.8](https://github.com/kubernetes/features/issue
## Tests
+Tests are based on the [kube-test](https://github.com/Yolean/kube-test) concept.
+Like the rest of this repo they have `kubectl` as the only local dependency.
+
```
kubectl apply -f test/
# Anything that isn't READY here is a failed test