Skip to content

Commit 6a4c047

Browse files
committed
Some ideas on how to keep this repo simple
1 parent be14a18 commit 6a4c047

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,12 @@ Transparent Kafka setup that you can grow with.
66
Good for both experiments and production.
77

88
How to use:
9+
* 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.
910
* Run a Kubernetes cluster, [minikube](https://github.com/kubernetes/minikube) or real.
1011
* Quickstart: use the `kubectl apply`s below.
11-
* Kafka for real: fork and have a look at [addon](https://github.com/Yolean/kubernetes-kafka/labels/addon)s.
12+
* Have a look at [addon](https://github.com/Yolean/kubernetes-kafka/labels/addon)s, or the official forks:
13+
- [kubernetes-kafka-small](https://github.com/Reposoft/kubernetes-kafka-small) for single-node clusters like Minikube.
14+
- [StreamingMicroservicesPlatform](https://github.com/StreamingMicroservicesPlatform/kubernetes-kafka) Like Confluent's [platform quickstart](https://docs.confluent.io/current/connect/quickstart.html) but for Kubernetes.
1215
* Join the discussion in issues and PRs.
1316

1417
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
7174

7275
## Tests
7376

77+
Tests are based on the [kube-test](https://github.com/Yolean/kube-test) concept.
78+
Like the rest of this repo they have `kubectl` as the only local dependency.
79+
7480
```
7581
kubectl apply -f test/
7682
# Anything that isn't READY here is a failed test

0 commit comments

Comments
 (0)