Merge pull request #234 from cuebook/main

Updated Documentation

README.md

@@ -16,14 +16,20 @@ CueObserve works with data in your SQL data warehouses and databases. It current
 
 ### Getting Started
 
-Install via Docker
+Install via docker-compose
 
 ```
-wget https://raw.githubusercontent.com/cuebook/CueObserve/latest_release/docker-compose.yml -q -O cueobserve-docker-compose.yml
-docker-compose -f cueobserve-docker-compose.yml up -d
+mkdir -p ~/cuebook
+wget https://raw.githubusercontent.com/cuebook/CueObserve/latest_release/docker-compose-prod.yml -q -O ~/cuebook/docker-compose-prod.yml
+wget https://raw.githubusercontent.com/cuebook/CueObserve/latest_release/.env -q -O ~/cuebook/.env
+cd ~/cuebook
 ```
 
-Now visit [http://localhost:3000](http://localhost:3000) in your browser.
+```
+docker-compose -f docker-compose-prod.yml --env-file .env up -d
+```
+
+Now visit [localhost:3000](http://localhost:3000) in your browser. 
 
 ### Demo Video
 

SUMMARY.md

@@ -12,4 +12,3 @@
 * [Data Sources](sources.md)
 * [Development](development.md)
 * [Settings](settings.md)
-

installation.md

@@ -105,6 +105,28 @@ DETECTION_SERVICE_PLATFORM=AWS
 AWS_LAMBDA_URL=<lambda function API gateway endpoint>
 ```
 
+## Install on Kubernetes&#x20;
+
+To install CueObserve on [kubernetes](https://kubernetes.io) you need [helm](https://helm.sh) installed. To install follow these steps
+
+```
+git clone https://github.com/cuebook/cueobserve
+cd cueobserve/k8s/
+kubectl create namespace cue-observe
+helm install cue-observe cue-observe -n cue-observe
+```
+
+## Scaling Application
+
+Scaling is only supported only in [Kubernetes](installation.md#install-on-kubernetes) deployment and you need [Keda 2.0.0](https://keda.sh/docs/2.0/deploy/) installed. It is enabled by default, to disable scaling, update following variables in `k8s/cue-observe/values.yml` before [installing CueObserve](installation.md#install-on-kubernetes) on kubernetes.
+
+```
+autoscaling:
+    enabled: false
+```
+
+Whenever an anomaly detection is ran it scales up celery-workers & scales down in [some time](https://keda.sh/docs/1.4/concepts/scaling-deployments/#long-running-executions) when finished.
+
 ## Infra Requirements
 
 The minimum infrastructure requirement for CueObserve is _1 GB RAM/ 1 CPU_. If Multiple CPUs(cores) are provided, they can be utilized by tasks like Anomaly Detection & Root Cause Analysis for faster processing.