Skip to content

Commit fc900cf

Browse files
committed
docs: remove narrow Sheaft framing and canonical model wording
1 parent e78f023 commit fc900cf

2 files changed

Lines changed: 19 additions & 17 deletions

File tree

README.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
# Bering
22

3-
Bering is a model discovery and contract-producing tool for resilience analysis.
4-
It consumes trace artifacts and produces canonical `bering-model.json` in
5-
`BeringResilienceModel` v1.0.0 format for any downstream consumer.
6-
Sheaft is a reference consumer, not an exclusive target.
3+
Bering builds a resilience model artifact from trace artifacts. The output artifact is `bering-model.json` in `BeringResilienceModel` v1.0.0 format. Use it in any downstream tooling or analytics pipeline.
74

8-
## Contract (strict)
5+
## Contract
96

107
Bering pins `metadata.schema` exactly:
118

@@ -26,7 +23,7 @@ internal/discovery model inference from normalized spans
2623
internal/model model structs, semantic checks, canonical IO
2724
internal/schema pinned contract constants + JSON Schema validation
2825
internal/jsoncanon deterministic recursive JSON encoder
29-
api/schema canonical public schema
26+
api/schema versioned public schema
3027
configs sample configs (replicas override)
3128
examples trace fixtures + expected output artifacts
3229
docs format, heuristic, and MVP limits
@@ -58,16 +55,21 @@ go run ./cmd/bering validate \
5855
--input examples/outputs/bering-model.normalized.sample.json
5956
```
6057

61-
### 3) Optional: run Sheaft on generated model (reference consumer)
62-
63-
```bash
64-
# from sibling Sheaft repository
65-
go run ./cmd/sheaft run \
66-
--model ../Bering/examples/outputs/bering-model.normalized.sample.json \
67-
--policy configs/gate.policy.example.yaml \
68-
--out-dir out \
69-
--seed 42
70-
```
58+
### 3) Use the model in any downstream tool
59+
60+
Examples:
61+
62+
- run your own analytics (topology checks, risk scoring, SLO diagnostics)
63+
- feed the model into simulation tooling
64+
- simulate failures with [Sheaft](https://github.com/MB3R-Lab/Sheaft) (one possible consumer), for example:
65+
```bash
66+
# from sibling Sheaft repository
67+
go run ./cmd/sheaft run \
68+
--model ../Bering/examples/outputs/bering-model.normalized.sample.json \
69+
--policy configs/gate.policy.example.yaml \
70+
--out-dir out \
71+
--seed 42
72+
```
7173

7274
## Deterministic output
7375

docs/mvp-scope-and-limits.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## In scope
44

55
- Discover model from trace files/directories.
6-
- Emit canonical `bering-model.json` (v1.0.0 contract) compatible with Sheaft and other downstream analytics tools.
6+
- Emit contract-compliant `bering-model.json` (v1.0.0) compatible with Sheaft and other downstream analytics tools.
77
- Validate artifact with strict `metadata.schema` match.
88
- Deterministic output ordering and canonical JSON serialization.
99

0 commit comments

Comments
 (0)