From b43b25dab0e559684a309220dbdabad8f2849f22 Mon Sep 17 00:00:00 2001
From: Ankit Nayan <ankit@signoz.io>
Date: Fri, 8 Jan 2021 00:40:19 +0530
Subject: [PATCH] updates to readme

---
 .gitignore                         |  3 ++-
 deploy/docker/README.md            |  0
 deploy/kubernetes/README.md        |  0
 deploy/kubernetes/config.yaml      |  0
 pkg/README.md                      |  0
 pkg/processors/README.md           |  0
 pkg/processors/flattener/README.md | 24 +++++++++++++++++++++--
 pkg/query-service/README.md        | 31 ++++++++++++++++++++++++++++--
 8 files changed, 53 insertions(+), 5 deletions(-)
 delete mode 100644 deploy/docker/README.md
 delete mode 100644 deploy/kubernetes/README.md
 delete mode 100644 deploy/kubernetes/config.yaml
 delete mode 100644 pkg/README.md
 delete mode 100644 pkg/processors/README.md

diff --git a/.gitignore b/.gitignore
index 9d62e2609f91..35ddcfd52ff9 100644
--- a/.gitignore
+++ b/.gitignore
@@ -21,4 +21,5 @@ frontend/yarn-debug.log*
 frontend/yarn-error.log*
 
 **/.vscode
-*.tgz
\ No newline at end of file
+*.tgz
+**/build
\ No newline at end of file
diff --git a/deploy/docker/README.md b/deploy/docker/README.md
deleted file mode 100644
index e69de29bb2d1..000000000000
diff --git a/deploy/kubernetes/README.md b/deploy/kubernetes/README.md
deleted file mode 100644
index e69de29bb2d1..000000000000
diff --git a/deploy/kubernetes/config.yaml b/deploy/kubernetes/config.yaml
deleted file mode 100644
index e69de29bb2d1..000000000000
diff --git a/pkg/README.md b/pkg/README.md
deleted file mode 100644
index e69de29bb2d1..000000000000
diff --git a/pkg/processors/README.md b/pkg/processors/README.md
deleted file mode 100644
index e69de29bb2d1..000000000000
diff --git a/pkg/processors/flattener/README.md b/pkg/processors/flattener/README.md
index d54194fee720..aaac997e71aa 100644
--- a/pkg/processors/flattener/README.md
+++ b/pkg/processors/flattener/README.md
@@ -1,3 +1,23 @@
-docker build -t signoz/flattener-processor:v0.1.0 .
-docker push signoz/flattener-processor:v0.1.0
+# Flattener Processor
 
+Flattener Processor is a spream processing application that reads spans from topic `otlp_spans` and writes to topic `flattened_spans`. It is written in **Golang**. Flattener Processor is responsible to convert the incoming spans into a flat model that can be ingested to Apache Druid. 
+
+
+#### Configuration
+Flattener Processor needs below `env` variables to run:
+```
+  KAFKA_BROKER: signoz-kafka:9092
+  KAFKA_INPUT_TOPIC: otlp_spans
+  KAFKA_OUTPUT_TOPIC: flattened_spans
+```
+The above values are the default ones used by SigNoz and are kept at `deploy/kubernetes/platform/signoz-charts/flattener-processor/values.yaml`
+
+#### Build and Run locally
+```console
+cd pkg/processors/flattener
+go build -o build/flattener-processor main.go
+KAFKA_BROKER=xxxx KAFKA_INPUT_TOPIC=otlp_spans KAFKA_OUTPUT_TOPIC=flattened_spans build/flattener-processor
+```
+
+#### Docker Images
+The docker images of flattener-processor is available at https://hub.docker.com/r/signoz/flattener-processor
\ No newline at end of file
diff --git a/pkg/query-service/README.md b/pkg/query-service/README.md
index b996df41d40d..c4c96a975740 100644
--- a/pkg/query-service/README.md
+++ b/pkg/query-service/README.md
@@ -1,2 +1,29 @@
-docker build -t signoz/query-service:v0.1.0 .
-docker push signoz/query-service:v0.1.0
\ No newline at end of file
+# Query Service
+
+Query service is the interface between forntend and databases. It is written in **Golang**. It will have modules for all supported databases. Query service is responsible to:
+- parse the request from Frontend
+- create relevant Druid queries (and all other supported database queries)
+- parse response from databases and handle error if any
+- build response in the format accepted by Frontend
+
+
+#### Druid Queries
+Internally we use both native and sql queries to Druid.
+
+#### Configuration
+Query Service needs below `env` variables to run:
+```
+    DruidClientUrl: http://signoz-druid-router:8888
+    DruidDatasource: flattened_spans
+```
+The above values are the default ones used by SigNoz and are kept at `deploy/kubernetes/platform/signoz-charts/query-service/values.yaml`
+
+#### Build and Run locally
+```console
+cd pkg/query-service
+go build -o build/query-service main.go
+DruidClientUrl=xxxx DruidDatasource=flattened_spans build/query-service
+```
+
+#### Docker Images
+The docker images of query-service is available at https://hub.docker.com/r/signoz/query-service
\ No newline at end of file