Skip to content

Commit 636f7ab

Browse files
committed
update documentation files
1 parent a4dc42c commit 636f7ab

5 files changed

Lines changed: 18 additions & 4 deletions

File tree

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
1-
# ChaosLabs
1+
<h1 align="center">ChaosLabs</h1>
22

3-
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
4-
[![Go](https://img.shields.io/badge/Go-1.23+-00ADD8?logo=go&logoColor=white)](https://go.dev/dl/)
5-
[![Node](https://img.shields.io/badge/Node-20+-339933?logo=nodedotjs&logoColor=white)](https://nodejs.org/)
3+
<p align="center">
4+
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT" /></a>
5+
<a href="https://go.dev/dl/"><img src="https://img.shields.io/badge/Go-1.23+-00ADD8?logo=go&logoColor=white" alt="Go 1.23+" /></a>
6+
<a href="https://nodejs.org/"><img src="https://img.shields.io/badge/Node-20+-339933?logo=nodedotjs&logoColor=white" alt="Node 20+" /></a>
7+
</p>
8+
9+
<p align="center">
10+
<img src="docs/assets/logo.png" alt="ChaosLabs logo" width="240" />
11+
</p>
12+
---
613

714
**ChaosLabs** is an open-source chaos engineering toolkit for distributed systems. Run controlled fault injection—network impairment, CPU and memory stress, process kills—and coordinate experiments across agents from a single controller, with a live dashboard and first-class observability hooks.
815

@@ -85,6 +92,10 @@ flowchart LR
8592
C --> A2
8693
```
8794

95+
<p align="center">
96+
<img src="docs/assets/architecture.png" alt="ChaosLabs architecture: Controller, Agent, and Dashboard" width="720" />
97+
</p>
98+
8899
Deeper detail: [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) · Kubernetes: [docs/KUBERNETES.md](docs/KUBERNETES.md) · manifests: `infrastructure/k8s/`
89100

90101
---

docs/ARCHITECTURE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
ChaosLabs is a small distributed system for running controlled fault-injection experiments.
44

5+
![High-level architecture: Controller, Agent, and Dashboard](assets/architecture.png)
6+
57
## Components
68

79
| Component | Role |

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
| Document | Description |
44
|----------|-------------|
55
| [../README.md](../README.md) | Project overview, quick start, usage |
6+
| [assets/architecture.png](assets/architecture.png) | High-level system diagram (Controller, Agent, Dashboard) |
67
| [ARCHITECTURE.md](ARCHITECTURE.md) | Components, repo layout, observability |
78
| [KUBERNETES.md](KUBERNETES.md) | Deploying on Kubernetes |
89
| [TUTORIAL.md](TUTORIAL.md) | Step-by-step experiment examples |

docs/assets/logo.png

2.12 MB
Loading

0 commit comments

Comments
 (0)