rustfs/docs/architecture/migration-progress.md

Architecture Migration Progress

Status values: [ ] not started, [~] in progress, [x] complete, [!] blocked.

Current Context

• Issue: rustfs/backlog#660
• Branch: overtrue/arch-security-governance-policy-types
• Baseline: upstream/main at 7a9bf707ee66e779f85e6e00cedfaa10ec2af4c2
• PR type for this branch: contract
• Runtime behavior changes: none
• Rust code changes: add redaction, serde policy, and artifact integrity contract modules to the pure rustfs-security-governance crate, with typed validation errors and unit tests.
• CI/script changes: none
• Docs changes: record the Phase 1 policy contract handoff.

Phase 0 Tasks

• G-001 Refresh main and record baseline.
  • Acceptance: baseline commit, title, and branch are recorded.
  • Verification: git fetch upstream main --prune; git rev-parse upstream/main.
• G-002 Create migration tracking checklist.
  • Acceptance: this file records task state, context, verification, and handoff.
• G-003 Classify PR types.
  • Acceptance: crate-boundaries.md lists exactly one allowed PR type per PR.
• G-004 Define re-export and wrapper policy.
  • Acceptance: temporary compatibility code must use RUSTFS_COMPAT_TODO.
• G-005 Add dependency direction guard.
  • Acceptance: ./scripts/check_layer_dependencies.sh passes on current upstream/main while still rejecting new unaccepted layer dependencies.
• [~] G-006 Create migration loss-prevention checks.
  • Current branch: add a mechanical admin route matrix guard from admin-route-action-snapshot.md and rustfs/src/admin/route_registration_test.rs.
  • Remaining follow-up: add checks for public re-export and storage trait coverage before pure moves.
• G-007 Create startup timeline table.
  • Acceptance: startup-timeline.md records current binary startup order, side effects, fatal boundaries, and readiness stages.
• G-008 Capture admin route-action snapshot.
  • Acceptance: admin-route-action-snapshot.md records current route families, handler ownership, authorization actions, public exceptions, table-catalog routes, and /minio/admin compatibility alias behavior.
• G-009 Enforce pre-push three-expert review.
  • Acceptance: crate-boundaries.md requires quality/architecture, migration-preservation, and testing/verification review before push.
• G-010 Inventory ecstore::config::{Config, KV, KVS} consumers.
  • Acceptance: ecstore-config-consumer-inventory.md records the current model definitions, global accessors, persistence helpers, consumer groups, migration risks, and do-not-change contract.
• TEST-PRTYPE-001 Check PR type enum consistency.
  • Acceptance: ./scripts/check_architecture_migration_rules.sh parses the allowed PR types from crate-boundaries.md and fails when ARCHITECTURE.md or architecture docs reference an unknown PR type.
• COMPAT-REG-001 Check temporary compatibility cleanup consistency.
  • Acceptance: ./scripts/check_architecture_migration_rules.sh fails when a source RUSTFS_COMPAT_TODO(<task-id>) marker lacks a cleanup-register entry, when a register entry lacks a source marker, or when a source marker omits a removal condition.

Phase 1 Security Governance Tasks

• S-001 Add crates/security-governance.
  • Acceptance: the crate is a workspace member and has no dependency on rustfs, ecstore, admin handlers, Axum, or runtime state.
  • Verification: cargo check -p rustfs-security-governance.
• S-002 Add admin route matrix core types.
  • Acceptance: AdminRouteSpec, AdminRouteAccess, AdminActionRef, PublicRouteKind, RouteRiskLevel, and validation errors model route governance metadata without registering routes or enforcing auth.
  • Verification: cargo test -p rustfs-security-governance.
• S-003 Add redaction contract types.
  • Acceptance: RedactionRule, RedactionLevel, and validation errors model sensitive field handling without logging, masking, or runtime integration.
  • Verification: cargo test -p rustfs-security-governance.
• S-004 Add serde policy marker types.
  • Acceptance: SerdePolicy, SerdePolicyKind, UnknownFieldPolicy, and validation errors model strict ingress and compatibility serde contracts without changing deserialization behavior.
  • Verification: cargo test -p rustfs-security-governance.
• S-005 Add supply-chain policy contract types.
  • Acceptance: ArtifactIntegrityPolicy, ArtifactSourceKind, and validation errors model digest, signature, and provenance requirements without changing release or CI behavior.
  • Verification: cargo test -p rustfs-security-governance.
• S-006 Add rustfs/src/admin/route_policy.rs backed by these contract types, without changing route registration or auth behavior.

Next PRs

1. contract: add an admin route policy table that consumes the new admin route matrix types while preserving route registration and auth behavior.
2. contract: add initial policy inventory tables for redaction, serde, or supply-chain governance only after the contract shape remains stable.

Pre-Push Review Log

Expert	Status	Notes
Quality/architecture	pass	Confirmed the staged diff includes the new modules, keeps a pure contract design, uses clear API names and typed errors, and does not introduce runtime/admin/router/auth/startup/storage/config/global-state integration
Migration preservation	pass	Confirmed this PR only completes S-003 through S-005, does not shift away from backlog #660, does not touch storage hot paths or global-state migration, and does not need compatibility markers
Testing/verification	pass	Confirmed focused contract tests assert valid and invalid policy behavior, production logic was not changed to satisfy tests, focused checks passed, and full make pre-commit passed

Verification Notes

Passed:

• cargo check -p rustfs-security-governance
• cargo test -p rustfs-security-governance
• cargo fmt --all --check
• cargo tree -p rustfs-security-governance --edges normal
• ./scripts/check_architecture_migration_rules.sh
• ./scripts/check_layer_dependencies.sh
• ./scripts/check_metrics_migration_refs.sh
• git diff --check
• make pre-commit

Notes:

• cargo test -p rustfs-security-governance passed 20 unit tests.
• make pre-commit passed, including 5513 nextest tests, 105 skipped tests, and workspace doctests.

Handoff Notes

• Keep this Phase 1 branch as a pure contract PR. Do not add rustfs/src/admin integration, route registration changes, auth enforcement, Config moves, Storage API moves, Runtime moves, or ECStore moves.
• The new crate is allowed to depend on generic Rust libraries such as thiserror, but must stay independent from implementation crates and runtime state.
• Do not add temporary compatibility code without a matching RUSTFS_COMPAT_TODO(<task-id>) marker and cleanup-register entry.
• The next admin route policy PR may consume the contract types, but must preserve current route registration, alias canonicalization, public exceptions, and handler-level authorization behavior.