Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 62 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,22 @@ None of it is versioned. None of it is reviewable. None of it executes itself at

---

## See it in action

**`burnless init` — interactive wizard generates your sre.yaml in 60 seconds**

<img width="968" height="559" alt="burnless init interactive wizard" src="https://github.com/user-attachments/assets/e3fd692a-5217-4729-be01-f508bc447645" />

**`burnless status` — see your full SLO config at a glance**

<img width="1010" height="664" alt="burnless status output" src="https://github.com/user-attachments/assets/2a9bb494-b4d8-4cf7-960b-6c25d109e1cb" />

**`burnless toil report` — convert manual toil to dollar cost for your manager**

<img width="1704" height="1069" alt="burnless toil report output" src="https://github.com/user-attachments/assets/2085007f-5355-4769-afd0-02358e9752c1" />

---

## Installation

### macOS — Homebrew (recommended)
Expand Down Expand Up @@ -72,31 +88,34 @@ Download the latest binary for your platform from

```bash
burnless version
# burnless 0.2.0
# burnless v0.3.0
```

---

## Quick start

```bash
# Install
curl -fsSL https://burnless.dev/install.sh | sh

# Scaffold a new sre.yaml
# Create your sre.yaml interactively
burnless init

# Validate
burnless validate sre.yaml
# Validate your config
burnless validate

# Deploy to Prometheus + Grafana + PagerDuty
burnless apply sre.yaml
# Preview what apply will create
burnless diff

# Watch live burn rate
burnless status payments-api
# Check your SLO config summary
burnless status

# Start the auto-remediation agent
burnless agent start
# Log a toil event
burnless toil log --service payments-api --task manual-rollback --duration 45m --automatable

# Generate a cost report
burnless toil report --month 2026-07

# Export for your manager
burnless toil export --output toil.csv
```

---
Expand All @@ -112,7 +131,7 @@ team: platform-engineering

slos:
- name: availability
target: 99.9%
target: 99.9
window: 30d
indicator:
metric: http_requests_total
Expand All @@ -121,27 +140,23 @@ slos:
error_budget:
burn_rate_alerts:
- severity: critical
rate: 14.4x
rate: 14.4
window: 1h
remediate: scale-up

- severity: warning
rate: 6x
rate: 6
window: 6h
remediate: restart-pods

runbooks:
scale-up:
mode: auto
steps:
- kubectl scale deploy/payments --replicas=+2
- wait 60s
- assert slo.availability > 99.5%

- kubectl scale deploy/payments-api --replicas=+2
restart-pods:
mode: semi-auto
steps:
- kubectl rollout restart deploy/payments
- kubectl rollout restart deploy/payments-api

oncall:
provider: pagerduty
Expand All @@ -159,25 +174,45 @@ dashboards:

---

## What's built today

| Command | What it does |
|---|---|
| `burnless init` | Interactive wizard — generates a complete `sre.yaml` |
| `burnless validate` | Validates `sre.yaml` — exits 1 on failure, CI/CD safe |
| `burnless diff` | Previews what `apply` would create |
| `burnless status` | Displays SLO config, alerts, runbooks, on-call summary |
| `burnless toil log` | Logs a manual toil event |
| `burnless toil report` | Generates monthly cost report with automation priority |
| `burnless toil export` | Exports toil data as CSV or JSON |

## Coming soon (Phase 2)

- `burnless apply` — deploy SLO config to Prometheus + Grafana
- Burn rate agent — watches Prometheus every 60s, triggers runbooks automatically
- PagerDuty + Slack integrations
- Kubernetes operator + Helm chart

---

## Documentation

- [Getting started](docs/getting-started.md)
- [sre.yaml reference](docs/reference/sre-yaml.md)
- [CLI reference](docs/reference/cli.md)
- [Integrations](docs/integrations.md)
- [Security & Data Handling](docs/security.md)
- [Data Flow Diagram](docs/data-flow.html)
- [Contributing](CONTRIBUTING.md)

---

## Community

- [Discord](https://discord.gg/burnless)
- [Twitter / X](https://twitter.com/burnlessdev)
- [Blog](https://burnless.dev/blog)
- [GitHub Discussions](https://github.com/Custos-com/Burnless/discussions)

## License

Apache 2.0 — see [LICENSE](LICENSE).
---

## License

Expand Down
Loading