docs: Added content to README.md

isala404 · May 15, 2022 · 6de08e5 · 6de08e5
1 parent a238382
commit 6de08e5
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,32 @@
-# lazy-koala
-Fault localizer for distributed systems
+# Lazy-Koala
+
+Lazy Koala is a lightweight framework for root cause analysis in distributed systems. This provides all the tooling needed for RCA from instrumentation to storage and real-time processing of telemetry data using deep learning.
+
+# Usage
+
+```sh
+git clone https://github.com/MrSupiri/lazy-koala
+cd charts
+helm install lazy-koala --generate-name -n lazy-koala --create-namespace
+```
+
+## Architecture
+
+![High Level System Diagram](documentation/README/high-level-system-diagram.png)
+
+## Repo Structure
+
+```txt
+./charts/lazy-koala - Helm Chart
+./control-plane     - Kubernetes Operator which binds all the sub-components
+./documentation     - Thesis written by the author about project
+./gazer             - eBPF based telemetry extraction agent
+./inspector         - Simple HTTP proxy to contact kubeAPI from the UI
+./scripts           - Helper Scripts
+./sherlock          - Inference agent to calculate anomaly scores
+./ui                - User dashboard to visualize the system
+```
+
+# Demo
+
+![DEMO](documentation/README/demo.gif)
diff --git a/documentation/README/demo.gif b/documentation/README/demo.gif
diff --git a/documentation/README/high-level-system-diagram.png b/documentation/README/high-level-system-diagram.png