Skip to content

Commit 373165f

Browse files
authored
Merge pull request #17 from MB3R-Lab/feat/mvp-bootstrap-contract
docs: position Bering as general model producer
2 parents aab415c + fc900cf commit 373165f

2 files changed

Lines changed: 19 additions & 17 deletions

File tree

README.md

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

3-
Bering is the upstream model discovery tool for Sheaft.
4-
It consumes trace artifacts and produces canonical `bering-model.json` in
5-
`BeringResilienceModel` v1.0.0 contract format.
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.
64

7-
## Contract (strict)
5+
## Contract
86

97
Bering pins `metadata.schema` exactly:
108

@@ -25,7 +23,7 @@ internal/discovery model inference from normalized spans
2523
internal/model model structs, semantic checks, canonical IO
2624
internal/schema pinned contract constants + JSON Schema validation
2725
internal/jsoncanon deterministic recursive JSON encoder
28-
api/schema canonical public schema
26+
api/schema versioned public schema
2927
configs sample configs (replicas override)
3028
examples trace fixtures + expected output artifacts
3129
docs format, heuristic, and MVP limits
@@ -57,16 +55,21 @@ go run ./cmd/bering validate \
5755
--input examples/outputs/bering-model.normalized.sample.json
5856
```
5957

60-
### 3) Run Sheaft manually on generated model
61-
62-
```bash
63-
# from sibling Sheaft repository
64-
go run ./cmd/sheaft run \
65-
--model ../Bering/examples/outputs/bering-model.normalized.sample.json \
66-
--policy configs/gate.policy.example.yaml \
67-
--out-dir out \
68-
--seed 42
69-
```
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+
```
7073

7174
## Deterministic output
7275

docs/mvp-scope-and-limits.md

Lines changed: 1 addition & 2 deletions
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 Sheaft-compatible `bering-model.json` (v1.0.0 contract).
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

@@ -28,4 +28,3 @@ Result is clamped to `[0,1]` and rounded to 2 decimals.
2828

2929
This score is informational in MVP and should not be interpreted as a calibrated
3030
probability of correctness.
31-

0 commit comments

Comments
 (0)