mirror of
				https://github.com/optim-enterprises-bv/siembol.git
				synced 2025-10-31 18:37:49 +00:00 
			
		
		
		
	 132f07d873
			
		
	
	132f07d873
	
	
	
		
			
			* added dependency install script, and clean up * kafka ui instructions * added ps scripts for install * update to support folder change and powershell scripts * removed unneccessary file * small fix * added cm and secret to cleanup script * change to reflect cleanup script Co-authored-by: Yassin Raman <yassin@gmail.co> Co-authored-by: yasram1 <yasram1@github.com>
		
			
				
	
	
	
		
			2.7 KiB
		
	
	
	
	
	
	
	
			
		
		
	
	
			2.7 KiB
		
	
	
	
	
	
	
	
Quickstart Guide
Local Install
1. Run minikube.sh
deployment/helm-k8s/quickstart_install/sh-scripts/minikube.sh
or
deployment/helm-k8s/quickstart_install/ps-scripts/minikube.ps1
2. Install dependencies
1. Run dependencies.sh
deployment/helm-k8s/quickstart_install/sh-scripts/dependencies.sh
or
deployment/helm-k8s/quickstart_install/ps-scripts/dependencies.ps1
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/sh-scripts/demoInstall.sh
or
deployment/helm-k8s/quickstart_install/ps-scripts/demoInstall.ps1
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/sh-scripts/kafkaExtra.sh
or
deployment/helm-k8s/quickstart_install/ps-scripts/kafkaExtra.ps1
- 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/sh-scripts/cleanUp.sh
or
deployment/helm-k8s/quickstart_install/ps-scripts/cleanUp.ps1
- For deleting everything; delete the siembol minikube profile:
minikube delete -p siembol
sudo rm /etc/resolver/minikube-*