gsadmin/rustfs

mirror of https://github.com/rustfs/rustfs.git synced 2026-07-26 16:28:15 +00:00

Files

T

History

Zhengchao An a6b3e4f5d6 refactor: use canonical Rust module paths (#4269 )

2026-07-05 03:01:14 +08:00

..

admin-route-action-snapshot.md

refactor: narrow test harness compatibility surfaces (#3592 )

2026-06-19 07:10:52 +08:00

background-controller-contract.md

feat(obs): add metrics runtime controller status (#3408 )

2026-06-13 20:48:34 +08:00

background-services-inventory.md

chore(docs): refresh agent docs, guard doc paths, archive plans (#4203 )

2026-07-02 23:30:13 +08:00

compat-cleanup-register.md

refactor: publish oidc through app context (#3893 )

2026-06-26 10:17:30 +08:00

config-model-boundary-adr.md

refactor(config): remove legacy accessor re-export (#3362 )

2026-06-11 19:32:57 +08:00

crate-boundaries.md

refactor(replication): isolate storage api contracts (#4240 )

2026-07-03 22:10:16 +08:00

decommission-compatibility.md

chore(docs): refresh agent docs, guard doc paths, archive plans (#4203 )

2026-07-02 23:30:13 +08:00

ecstore-api-facade-inventory.md

refactor(storage): hide replication runtime handles (#4152 )

2026-07-02 00:40:42 +08:00

ecstore-config-consumer-inventory.md

chore(docs): refresh agent docs, guard doc paths, archive plans (#4203 )

2026-07-02 23:30:13 +08:00

ecstore-layout-boundary.md

refactor: move ecstore format layout owners (#3646 )

2026-06-20 09:58:50 +08:00

ecstore-module-split-plan.md

refactor(lifecycle): extract core rule contracts (#4258 )

2026-07-04 20:05:56 +08:00

global-state-crate-split-plan.md

refactor(storage): hide replication runtime handles (#4152 )

2026-07-02 00:40:42 +08:00

global-state-inventory.md

refactor: use canonical Rust module paths (#4269 )

2026-07-05 03:01:14 +08:00

kms-development-defaults-inventory.md

security(kms): require explicit dev defaults opt-in (#3369 )

2026-06-12 07:05:20 +08:00

obs-ecstore-dependency-inventory.md

refactor(obs): hide replication stats handle (#4149 )

2026-07-01 23:37:23 +08:00

overview.md

chore(docs): refresh agent docs, guard doc paths, archive plans (#4203 )

2026-07-02 23:30:13 +08:00

placement-repair-invariants.md

refactor: flatten test harness storage compat aliases (#3596 )

2026-06-19 08:30:47 +08:00

profiling-numa-capability-inventory.md

refactor: extract optional runtime startup boundary (#3633 )

2026-06-20 00:12:44 +08:00

readiness-matrix.md

docs: add architecture readiness matrix (#3938 )

2026-06-27 11:23:07 +08:00

README.md

chore(docs): refresh agent docs, guard doc paths, archive plans (#4203 )

2026-07-02 23:30:13 +08:00

runtime-capability-contracts.md

feat: wire runtime capability snapshot providers (#3604 )

2026-06-19 09:50:42 +08:00

runtime-lifecycle.md

docs(architecture): inventory global state migration (#4028 )

2026-06-29 08:20:32 +08:00

s3-compatibility-matrix.md

docs: close final architecture audit gaps (#3966 )

2026-06-28 00:07:42 +08:00

s3-tables-support-matrix.md

feat(table-catalog): add distributed maintenance scheduling (#4257 )

2026-07-04 23:44:08 +08:00

scheduler-baseline.md

refactor: flatten test harness storage compat aliases (#3596 )

2026-06-19 08:30:47 +08:00

startup-timeline.md

chore(docs): refresh agent docs, guard doc paths, archive plans (#4203 )

2026-07-02 23:30:13 +08:00

storage-control-data-plane.md

docs: add architecture readiness matrix (#3938 )

2026-06-27 11:23:07 +08:00

workload-admission-contracts.md

refactor: compose workload admission providers (#3685 )

2026-06-21 13:36:12 +08:00

README.md

Architecture Documentation

Durable architecture reference for RustFS: migration guardrails, runtime contracts, boundary rules, and support matrices.

Two rules keep this directory healthy:

Durable reference only. One-shot implementation plans, task trackers, and PR templates live in docs/superpowers/plans/ and are archived there when their work closes.
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 — migration baseline, phase order, core principles

CI-enforced core (required by `scripts/check_architecture_migration_rules.sh`)

crate-boundaries.md — dependency direction, PR types, re-export contracts
runtime-lifecycle.md — startup/shutdown sequencing, readiness guarantees
readiness-matrix.md — request/dependency behavior, probe semantics
storage-control-data-plane.md — storage API contracts, control-plane boundaries
global-state-crate-split-plan.md — remaining global-state owners and split evaluation
ecstore-module-split-plan.md — ECStore decomposition rules and facade contracts

Contracts & invariants

Support matrices (release-facing, keep current)

Inventories & baselines (snapshots that feed migration work)

Historical plans and trackers (rebalance/decommission phases, migration-progress ledger) were moved to docs/superpowers/plans/ in 2026-07.