mirror of
https://github.com/rustfs/rustfs.git
synced 2026-08-05 21:07:43 +00:00
Zhengchao An
f63af3df63
The ecstore/global-state migrations are done (backlog#815, #939, #1052 all closed). Review of every migration-era test/gate measure found three things actually retirable or broken — everything else is a live anti-regression guard and stays. Remove: - scripts/check_metrics_migration_refs.sh — guards a migration that finished: rustfs_metrics:: has zero hits, the metrics crate no longer exists, and the script was never wired into CI or make (only reference was one line in config-model-boundary-adr.md, also removed). - crates/obs init_metrics_collectors — the "backward-compatible alias kept during migration" the removed script was guarding. Zero callers; pure delegate to init_metrics_runtime. Archive (docs/superpowers/plans/, continuing the 2026-07 convention, with the standard archived banner): - startup-timeline.md, scheduler-baseline.md, profiling-numa-capability-inventory.md, kms-development-defaults-inventory.md — one-shot snapshots whose only consumer is the already-archived migration-progress ledger (their same-dir links there start resolving again after the move); zero script pins; fed the closed backlog#660/#665 architecture-review ledger. Fixed the one outbound link (startup-timeline -> readiness-matrix) that the move would have broken — check_doc_paths.sh deliberately does not scan plans/, so nothing else would have caught it. Wire (found orphaned by the same review): - scripts/check_extension_schema_boundaries.sh guards a live contract crate but was never invoked anywhere. Add lint-fmt.mak target, include in pre-commit/pre-pr/dev-check, add ci.yml Quick Checks step (job already installs ripgrep), sync the CONTRIBUTING.md enumerated list, and harden the script against a silently-passing rg probe when src/ is missing. Keep (verified live, documented so the next cleanup pass does not repeat this analysis): - scripts/check_architecture_migration_rules.sh — added a header stating it is a permanent boundary guard, not retirable migration scaffolding; 'migration' in the name is historical. - check_migration_gate_count.sh + floor, delete-marker e2e proof, all pinned docs, compat-cleanup-register sync, remaining inventories (referenced by live docs). Verification: all 7 guard scripts pass, actionlint clean, cargo check --workspace (excl e2e) clean, cargo fmt --check clean. Adversarially reviewed by two independent skeptic passes; their 7 findings (alias left behind, broken outbound link, missing banners, wrong backlog attribution, CONTRIBUTING drift, rg exit-2 hole, missing header rationale) are all folded in.
63 lines
3.2 KiB
Markdown
63 lines
3.2 KiB
Markdown
# Architecture Documentation
|
|
|
|
Durable architecture reference for RustFS: migration guardrails, runtime
|
|
contracts, boundary rules, and support matrices.
|
|
|
|
Two rules keep this directory healthy:
|
|
|
|
1. **Durable reference only.** One-shot implementation plans, task trackers,
|
|
and PR templates live in [`docs/superpowers/plans/`](../superpowers/plans/)
|
|
and are archived there when their work closes.
|
|
2. **No copies of other sources of truth.** Crate lists come from
|
|
`Cargo.toml`, CI steps from `.github/workflows/ci.yml`, code structure from
|
|
the code. `scripts/check_doc_paths.sh` fails the pre-commit gate when a
|
|
doc here references a file path that no longer exists.
|
|
|
|
## Start here
|
|
|
|
- [overview.md](overview.md) — migration baseline, phase order, core principles
|
|
|
|
## CI-enforced core (required by `scripts/check_architecture_migration_rules.sh`)
|
|
|
|
- [crate-boundaries.md](crate-boundaries.md) — dependency direction, PR types, re-export contracts
|
|
- [runtime-lifecycle.md](runtime-lifecycle.md) — startup/shutdown sequencing, readiness guarantees
|
|
- [readiness-matrix.md](readiness-matrix.md) — request/dependency behavior, probe semantics
|
|
- [storage-control-data-plane.md](storage-control-data-plane.md) — storage API contracts, control-plane boundaries
|
|
- [global-state-crate-split-plan.md](global-state-crate-split-plan.md) — remaining global-state owners and split evaluation
|
|
- [ecstore-module-split-plan.md](ecstore-module-split-plan.md) — ECStore decomposition rules and facade contracts
|
|
|
|
## Contracts & invariants
|
|
|
|
- [placement-repair-invariants.md](placement-repair-invariants.md)
|
|
- [runtime-capability-contracts.md](runtime-capability-contracts.md)
|
|
- [workload-admission-contracts.md](workload-admission-contracts.md)
|
|
- [background-controller-contract.md](background-controller-contract.md)
|
|
- [config-model-boundary-adr.md](config-model-boundary-adr.md)
|
|
- [ecstore-layout-boundary.md](ecstore-layout-boundary.md)
|
|
- [decommission-compatibility.md](decommission-compatibility.md)
|
|
|
|
## Support matrices (release-facing, keep current)
|
|
|
|
- [s3-compatibility-matrix.md](s3-compatibility-matrix.md)
|
|
- [s3-tables-support-matrix.md](s3-tables-support-matrix.md)
|
|
- [minio-rustfs-router-compatibility.md](minio-rustfs-router-compatibility.md)
|
|
- [minio-file-format-compat.md](minio-file-format-compat.md)
|
|
|
|
## Inventories & baselines (snapshots that feed migration work)
|
|
|
|
- [global-state-inventory.md](global-state-inventory.md)
|
|
- [ecstore-api-facade-inventory.md](ecstore-api-facade-inventory.md)
|
|
- [ecstore-config-consumer-inventory.md](ecstore-config-consumer-inventory.md)
|
|
- [obs-ecstore-dependency-inventory.md](obs-ecstore-dependency-inventory.md)
|
|
- [background-services-inventory.md](background-services-inventory.md)
|
|
- [admin-route-action-snapshot.md](admin-route-action-snapshot.md)
|
|
- [compat-cleanup-register.md](compat-cleanup-register.md)
|
|
|
|
Historical plans and trackers (rebalance/decommission phases,
|
|
migration-progress ledger) were moved to
|
|
[`docs/superpowers/plans/`](../superpowers/plans/) in 2026-07. One-shot
|
|
migration snapshots whose only consumer was that ledger (startup timeline,
|
|
scheduler baseline, profiling/NUMA capability inventory, KMS development
|
|
defaults inventory) followed once the architecture-review ledger they fed
|
|
closed out (backlog#660/#665).
|