From 9c173c8eb3294b08ba842e474b520afc6dc0bd01 Mon Sep 17 00:00:00 2001 From: Prashant Shahi Date: Thu, 12 May 2022 22:46:43 +0530 Subject: [PATCH] =?UTF-8?q?docs(contributing):=20=F0=9F=93=9D=20Update=20C?= =?UTF-8?q?ONTRIBUTING.md=20docs=20(#877)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Prashant Shahi --- CONTRIBUTING.md | 35 +++++++++++++++++++++++------------ 1 file changed, 23 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6205d85884..60aebdab98 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -106,28 +106,39 @@ Need to update [https://github.com/SigNoz/charts](https://github.com/SigNoz/char - [k3d](https://k3d.io/#installation) - [minikube](https://minikube.sigs.k8s.io/docs/start/) - create a k8s cluster and make sure `kubectl` points to the locally created k8s cluster -- run `helm install -n platform --create-namespace my-release charts/signoz` to install SigNoz chart -- run `kubectl -n platform port-forward svc/my-release-frontend 3301:3301` to make SigNoz UI available at [localhost:3301](http://localhost:3301) +- run `make dev-install` to install SigNoz chart with `my-release` release name in `platform` namespace. +- run `kubectl -n platform port-forward svc/my-release-signoz-frontend 3301:3301` to make SigNoz UI available at [localhost:3301](http://localhost:3301) + +**To install HotROD sample app:** + +```bash +curl -sL https://github.com/SigNoz/signoz/raw/main/sample-apps/hotrod/hotrod-install.sh \ + | HELM_RELEASE=my-release SIGNOZ_NAMESPACE=platform bash +``` **To load data with HotROD sample app:** -```sh -kubectl create ns sample-application - -kubectl -n sample-application apply -f https://raw.githubusercontent.com/SigNoz/signoz/main/sample-apps/hotrod/hotrod.yaml - +```bash kubectl -n sample-application run strzal --image=djbingham/curl \ ---restart='OnFailure' -i --tty --rm --command -- curl -X POST -F \ -'locust_count=6' -F 'hatch_rate=2' http://locust-master:8089/swarm + --restart='OnFailure' -i --tty --rm --command -- curl -X POST -F \ + 'locust_count=6' -F 'hatch_rate=2' http://locust-master:8089/swarm ``` **To stop the load generation:** -```sh +```bash kubectl -n sample-application run strzal --image=djbingham/curl \ - --restart='OnFailure' -i --tty --rm --command -- curl \ - http://locust-master:8089/stop + --restart='OnFailure' -i --tty --rm --command -- curl \ + http://locust-master:8089/stop ``` + +**To delete HotROD sample app:** + +```bash +curl -sL https://github.com/SigNoz/signoz/raw/main/sample-apps/hotrod/hotrod-delete.sh \ + | HOTROD_NAMESPACE=sample-application bash +``` + --- ## General Instructions