Skip to content

Commit 93ab04e

Browse files
docs(readme): add observability launch instructions
Document --profile observe, Grafana/Prometheus URLs, and fix README layout (description at top, consolidated local runtime section). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent b34d485 commit 93ab04e

1 file changed

Lines changed: 30 additions & 15 deletions

File tree

README.md

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# DevOps Project 2026
22

3-
Repository for team Panic! At the Console
3+
Lightweight incident management system — detect, track, and resolve incidents with an immutable event log and AI-assisted analysis.
44

5-
> TUM DevOps Project — Spring 2026
5+
> TUM DevOps Project — Spring 2026 · Team Panic! At the Console
66
77
## Quick Start
88

@@ -15,13 +15,6 @@ pixi run pre-commit-install
1515
pixi run lint
1616
```
1717

18-
Run local service scaffold with Docker Compose:
19-
20-
```bash
21-
cp .env.example .env
22-
docker compose up --build
23-
```
24-
2518
Equivalent Pixi tasks:
2619

2720
```bash
@@ -30,8 +23,6 @@ pixi run compose-down
3023
pixi run compose-validate
3124
```
3225

33-
Lightweight incident management system — detect, track, and resolve incidents with an immutable event log and AI-assisted analysis.
34-
3526
## Installation
3627

3728
Prerequisites:
@@ -78,7 +69,8 @@ pixi run pre-commit-install
7869
├── infra/
7970
│ ├── helm/
8071
│ ├── k8s/
81-
│ └── monitoring/
72+
│ ├── monitoring/ # Prometheus + Grafana config
73+
│ └── postgres/ # Dev DB init scripts
8274
├── docs/
8375
│ ├── adr/
8476
│ ├── architecture/
@@ -121,9 +113,32 @@ pixi run lint
121113

122114
## Local Runtime
123115

124-
- Local compose file: `docker-compose.yml`
125-
- Production-oriented compose with Traefik + TLS: `docker-compose.prod.yml`
126-
- Images default to GHCR tag `main` and can be overridden with `IMAGE_TAG`.
116+
```bash
117+
cp .env.example .env
118+
docker compose up --build
119+
```
120+
121+
Starts all services plus shared infrastructure (Postgres, NATS). Service env vars (`DATABASE_URL`, `NATS_URL`) are pre-wired.
122+
123+
### Observability
124+
125+
```bash
126+
docker compose --profile observe up --build
127+
```
128+
129+
Adds Prometheus and Grafana to the stack:
130+
131+
| Service | URL | Credentials |
132+
| ---------- | --------------------- | -------------------- |
133+
| Grafana | http://localhost:3001 | admin / admin |
134+
| Prometheus | http://localhost:9090 ||
135+
136+
Grafana auto-provisions Prometheus as its default datasource — no manual setup needed. Once your services expose `/metrics`, they appear in Prometheus and can be graphed in Grafana immediately.
137+
138+
### Other options
139+
140+
- Production compose with Traefik + TLS: `docker-compose.prod.yml`
141+
- Override the image tag: `IMAGE_TAG=v0.1.0 docker compose up`
127142

128143
## Student Responsibilities
129144

0 commit comments

Comments
 (0)