mirror of
https://github.com/optim-enterprises-bv/siembol.git
synced 2025-11-01 02:47:54 +00:00
* added dependency install script, and clean up * kafka ui instructions * adding kafka helpers to quickstart * adding kafka helpers to quickstart * removed file, not needed * improvement Co-authored-by: Yassin Raman <yassin@gmail.co>
2.3 KiB
2.3 KiB
Quickstart Guide
Local Install
1. Run minikube.sh
deployment/helm-k8s/quickstart_install/minikube.sh
2. Install dependencies
1. Run dependencies.sh
deployment/helm-k8s/quickstart_install/dependencies.sh
3. Prepare GitHub
1. Prepare Siembol Config Repository
- Go to https://github.com/G-Research/siembol-config
- Fork into your own organization or personal account
2. Create GitHub token
- Go to https://github.com/settings/tokens
- Click Generate new token
- Select "repo - Full control of private repositories" scope
- Hit "Generate token"
- Keep this token value as you will need it for the next step.
3. Run demoInstall.sh
- This will ask for your github details related to the Siembol Config repository and the token created in previous step.
- This will also initialise Zookeeper nodes.
deployment/helm-k8s/quickstart_install/demoInstall.sh
4. Siembol install
To install Siembol in the cluster
helm install siembol deployment/helm-k8s/ -f deployment/helm-k8s/values.yaml -n=siembol
This step might take a few minutes depending on the specs of your development machine.
Check it out!
In a browser, go to:
You should now see the Siembol UI homepage. You can also try Storm UI to see running topologies:
Kafka UI
We are using Kafdrop UI to view topics and messages. You can send messages to parsing topics and to test siembol configs.
- To install this and create a kafka client pod:
deployment/helm-k8s/quickstart_install/kafkaExtra.sh
- Exec into the kafka client pod:
kubectl exec --tty -i kafka-client --namespace siembol -- bash
- Connect to the broker:
kafka-console-producer.sh \
--broker-list kafka-0.kafka-headless.siembol.svc.cluster.local:9092 \
--topic <your-topic>
- Produce your message in terminal window
Cleaning up
If you're done poking about on a local instance, you can clean up with:
- For cleaning up siembol resources and dependencies:
deployment/helm-k8s/quickstart_install/cleanUp.sh
- For deleting everything siembol related incl. config maps, secrets, certs and namespace:
minikube delete -p siembol
sudo rm /etc/resolver/minikube-*