From 6342e1cebc1b219a54d2734ca970823545fb455c Mon Sep 17 00:00:00 2001
From: Prashant Shahi <prashant@signoz.io>
Date: Tue, 8 Feb 2022 17:50:02 +0530
Subject: [PATCH] =?UTF-8?q?docs(deploy):=20=F0=9F=93=9D=20Add=20README=20d?=
 =?UTF-8?q?ocs=20for=20deploy=20(#669)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Prashant Shahi <prashant@signoz.io>
---
 deploy/README.md | 88 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 88 insertions(+)
 create mode 100644 deploy/README.md

diff --git a/deploy/README.md b/deploy/README.md
new file mode 100644
index 0000000000..cbd7d8a63a
--- /dev/null
+++ b/deploy/README.md
@@ -0,0 +1,88 @@
+# Deploy
+
+Check that you have cloned [signoz/signoz](https://github.com/signoz/signoz)
+and currently are in `signoz/deploy` folder.
+
+## Docker
+
+If you don't have docker set up, please follow [this guide](https://docs.docker.com/engine/install/)
+to set up docker before proceeding with the next steps.
+
+### Using Install Script
+
+Now run the following command to install:
+
+```sh
+./install.sh
+```
+
+### Using Docker Compose
+
+If you don't have docker-compose set up, please follow [this guide](https://docs.docker.com/compose/install/)
+to set up docker compose before proceeding with the next steps.
+
+For x86 chip (amd):
+
+```sh
+docker-compose -f docker/clickhouse-setup/docker-compose.yaml up -d
+```
+
+For Mac with Apple chip (arm):
+
+```sh
+docker-compose -f docker/clickhouse-setup/docker-compose.arm.yaml up -d
+```
+
+Open http://localhost:3000 in your favourite browser. In couple of minutes, you should see
+the data generated from hotrod in SigNoz UI.
+
+## Kubernetes
+
+### Using Helm
+
+#### Bring up SigNoz cluster
+
+```sh
+helm repo add signoz https://charts.signoz.io
+
+kubectl create ns platform
+
+helm -n platform install my-release signoz/signoz
+```
+
+To access the UI, you can `port-forward` the frontend service:
+
+```sh
+kubectl -n platform port-forward svc/my-release-frontend 3000:3000
+```
+
+Open http://localhost:3000 in your favourite browser. Few minutes after you generate load
+from the HotROD application, you should see the data generated from hotrod in SigNoz UI.
+
+#### Test HotROD application with SigNoz
+
+```sh
+kubectl create ns sample-application
+
+kubectl -n sample-application apply -f https://raw.githubusercontent.com/SigNoz/signoz/main/sample-apps/hotrod/hotrod.yaml
+```
+
+To generate load:
+
+```sh
+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
+```
+
+To stop load:
+
+```sh
+kubectl -n sample-application run strzal --image=djbingham/curl \
+ --restart='OnFailure' -i --tty --rm --command -- curl \
+ http://locust-master:8089/stop
+```
+
+## Uninstall/Troubleshoot?
+
+Go to our official documentation site [signoz.io/docs](https://signoz.io/docs) for more.