Skip to content

Commit 6de08e5

Browse files
committed
docs: Added content to README.md
1 parent a238382 commit 6de08e5

File tree

3 files changed

+32
-2
lines changed

3 files changed

+32
-2
lines changed

README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,32 @@
1-
# lazy-koala
2-
Fault localizer for distributed systems
1+
# Lazy-Koala
2+
3+
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.
4+
5+
# Usage
6+
7+
```sh
8+
git clone https://github.com/MrSupiri/lazy-koala
9+
cd charts
10+
helm install lazy-koala --generate-name -n lazy-koala --create-namespace
11+
```
12+
13+
## Architecture
14+
15+
![High Level System Diagram](documentation/README/high-level-system-diagram.png)
16+
17+
## Repo Structure
18+
19+
```txt
20+
./charts/lazy-koala - Helm Chart
21+
./control-plane - Kubernetes Operator which binds all the sub-components
22+
./documentation - Thesis written by the author about project
23+
./gazer - eBPF based telemetry extraction agent
24+
./inspector - Simple HTTP proxy to contact kubeAPI from the UI
25+
./scripts - Helper Scripts
26+
./sherlock - Inference agent to calculate anomaly scores
27+
./ui - User dashboard to visualize the system
28+
```
29+
30+
# Demo
31+
32+
![DEMO](documentation/README/demo.gif)

documentation/README/demo.gif

5.84 MB
Loading
151 KB
Loading

0 commit comments

Comments
 (0)