gsadmin/rustfs
1
0
Fork 0
mirror of https://github.com/rustfs/rustfs.git synced 2026-08-09 14:49:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(storage-api): add disk inventory contract (#3330)

Browse Source
This commit is contained in:
安正超
2026-06-11 00:33:31 +08:00
committed by GitHub
parent b1339a98ed
commit d9ddd1bedc
5 changed files with 179 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/architecture/migration-progress.md
+44 -51
View File
@@ -5,16 +5,15 @@ Status values: `[ ]` not started, `[~]` in progress, `[x]` complete, `[!]` block
## Current Context
- Issue: [`rustfs/backlog#660`](https://github.com/rustfs/backlog/issues/660)
- Branch: `overtrue/arch-storage-api-bucket-dtos`
- Baseline: `upstream/main` at `5fef10548477d9d25b0d391874f8280bf259d10e`
- PR type for this branch: `api-extraction`
- Branch: `overtrue/arch-storage-api-disk-inventory`
- Baseline: `upstream/main` at `3fed21c68ae858f4bbb7f1be375d73b2af522f02`
- PR type for this branch: `contract`
- Runtime behavior changes: none.
- Rust code changes: move the pure bucket/options DTO subset from
`rustfs-ecstore` into `rustfs-storage-api`, while preserving old
`ecstore::store_api` import paths through a temporary compatibility
re-export.
- Rust code changes: add a pure `rustfs-storage-api` admin/disk inventory
contract trait.
- CI/script changes: none
- Docs changes: record API-003 bucket DTO compatibility cleanup.
- Docs changes: record API-006 branch context, verification evidence, and
expert review outcomes.
## Phase 0 Tasks
@@ -167,8 +166,9 @@ Status values: `[ ]` not started, `[~]` in progress, `[x]` complete, `[!]` block
quorum classification, and reserved code gaps `0x2B/0x2C`.
- Risk defense: no storage hot-path enum move in this PR; only numeric code
mapping uses the new contract.
- [~] `API-003` Move DTOs.
- Current branch: move the pure bucket/options DTO subset:
- [x] `API-003` Move DTOs.
- Current PR: `rustfs/rustfs#3314` merged.
- Completed slice: move the pure bucket/options DTO subset:
`MakeBucketOptions`, `SRBucketDeleteOp`, `DeleteBucketOptions`,
`BucketOptions`, and `BucketInfo`.
- Acceptance: `rustfs-storage-api` exports these DTOs, ECStore re-exports
@@ -177,6 +177,17 @@ Status values: `[ ]` not started, `[~]` in progress, `[x]` complete, `[!]` block
- Must preserve: no `ObjectOptions`, `ObjectInfo`, reader, compression,
encryption, filemeta conversion, multipart conversion, route, storage, or
runtime behavior changes in this PR.
- [~] `API-006` Add disk inventory/admin trait.
- Acceptance: `StorageAdminApi` exposes backend info, global storage info,
local storage info, disk-set inventory, and drive-count surfaces without
depending on ECStore implementation types.
- Must preserve: no `StorageAPI::get_disks` removal, no ECStore implementation
change, no admin/readiness/capacity behavior change.
- Risk defense: use associated types for backend/storage/disk DTOs so this
contract slice does not pull `rustfs-madmin` or `rustfs-ecstore` into
`rustfs-storage-api`.
- Verification: focused storage-api tests, dependency tree, migration guards,
formatting, and diff hygiene.
## Phase 8 Background Controller Tasks
@@ -201,12 +212,12 @@ Status values: `[ ]` not started, `[~]` in progress, `[x]` complete, `[!]` block
## Next PRs
1. `api-extraction`: continue API-003 with the next pure DTO subset only after
the bucket/options compatibility re-export is reviewed.
2. `contract`: wait for API-002/#3313 before adding error-aware storage API
traits.
3. `test-only`: add focused preservation tests before moving scanner, heal,
replication, lifecycle, or disk health workers.
1. `contract`: bind ECStore to `StorageAdminApi` while keeping
`StorageAPI::get_disks` available.
2. `consumer-migration`: migrate readiness/admin/capacity consumers to the
inventory-facing admin contract one group at a time.
3. `dependency-migration`: remove duplicate old-path admin surfaces only after
consumer migration proves equivalent behavior.
4. `api-extraction`: move only the pure server-config model into
rustfs-config as CFG-003.
5. `api-extraction`: keep the old rustfs_ecstore::config::* path with
@@ -222,58 +233,40 @@ Status values: `[ ]` not started, `[~]` in progress, `[x]` complete, `[!]` block
| Expert | Status | Notes |
|---|---|---|
| Quality/architecture | pass | Only pure bucket/options DTOs moved into `rustfs-storage-api`; object, reader, compression, encryption, filemeta, multipart, storage, and runtime logic stayed in ECStore. |
| Migration preservation | pass | Old `ecstore::store_api` import paths remain through `RUSTFS_COMPAT_TODO(API-003)` compatibility re-export, with cleanup registered. |
| Testing/verification | pass | Focused DTO tests, ECStore compatibility test, migration guards, formatting, rio-v2 clippy, dependency review, diff checks, and pre-commit passed. |
| Quality/architecture | pass | Single `docs-only` PR; ADR chooses existing rustfs-config, records module path and dependency boundaries, and avoids a speculative new crate. |
| Migration preservation | pass | No code movement; ADR explicitly keeps persistence helpers, global server-config state, startup order, and old-path compatibility requirements out of CFG-002. |
| Testing/verification | pass | Docs-only verification uses migration guard scripts, metrics reference guard, layer dependency guard, and whitespace checks. |
| Quality/architecture | pass | Single `docs-only` PR; the inventory is isolated under `docs/architecture`, uses existing KMS source files as evidence, and introduces no new abstraction or dependency edge. |
| Migration preservation | pass | No runtime code, config persistence, admin authorization, startup order, storage path, global state, or crate boundary changes are made. |
| Testing/verification | pass | Docs-only verification is bounded to diff review, architecture migration rules, metrics reference guard, layer dependency guard, and whitespace checks. |
| Quality/architecture | pass | `StorageAdminApi` remains contract-only and introduces no `storage-api -> ecstore` or `storage-api -> madmin` coupling. |
| Migration preservation | pass | No ECStore implementation, `StorageAPI::get_disks`, readiness, admin, capacity, or storage hot-path behavior changed. |
| Testing/verification | pass | Focused tests, dependency tree, migration guards, Rust quality scan, and full pre-commit passed before push. |
## Verification Notes
Passed:
- `cargo test -p rustfs-storage-api`
- `cargo test -p rustfs-ecstore --test storage_api_compat_test`
- `cargo check -p rustfs-storage-api`
- `cargo check -p rustfs-storage-api -p rustfs-ecstore`
- `cargo check -p rustfs-ecstore --features rio-v2`
- `cargo clippy -p rustfs-ecstore --features rio-v2 --all-targets -- -D warnings`
- `cargo tree -p rustfs-storage-api --edges normal`
- `cargo fmt --all`
- `cargo fmt --all --check`
- `cargo test -p rustfs-ecstore error -- --nocapture`
- `./scripts/check_architecture_migration_rules.sh`
- `./scripts/check_layer_dependencies.sh`
- `./scripts/check_metrics_migration_refs.sh`
- `./scripts/check_unsafe_code_allowances.sh`
- `git diff --check`
- `cargo tree -p rustfs-storage-api --edges normal`
- Rust quality scan on changed Rust files.
- `make NUM_CORES=1 pre-commit`
Notes:
- Plain `make pre-commit` runs `fmt` and `unsafe-code-check` concurrently via
global Makefile parallelism; `unsafe-code-check` passes standalone, and the
full pre-commit target passed when run serially with `NUM_CORES=1`.
- Full nextest in pre-commit: 5704 passed, 111 skipped.
- Normal `rustfs-storage-api` dependencies added by this branch are limited to
`async-trait`.
- `tokio` is a dev-dependency only for the unit test runtime.
- No ECStore implementation, consumer import, admin route, readiness path,
capacity calculation, or storage hot path is changed.
- Full nextest in pre-commit: 5740 passed, 111 skipped.
- Workspace doctests passed.
## Handoff Notes
- Keep this API-003 branch as a focused `api-extraction` PR for bucket/options
DTOs only.
- Do not move `ObjectOptions`, `ObjectInfo`, `CompletePart`, reader types,
compression/encryption helpers, filemeta conversions, S3 DTO conversions, or
storage traits in this PR.
- Keep the old `ecstore::store_api` compatibility re-export until all consumers
import bucket DTOs from `rustfs_storage_api`.
- Do not add temporary compatibility code without a matching
`RUSTFS_COMPAT_TODO(<task-id>)` marker and cleanup-register entry.
- KMS production default hardening remains a separate task group; do not bundle
it with this inventory PR.
- The CFG-003 extraction PR must preserve the tuple-struct shape, serde fields,
`hiddenIfEmpty` alias, `Config::new` default behavior, marshal/unmarshal
behavior, and old `rustfs_ecstore::config::*` path.
- Do not create a new config-model crate unless a later implementation attempt
proves `rustfs-config` cannot hold the pure model boundary.
- Keep this API-006 branch as a focused `contract` PR.
- Do not implement the trait for ECStore in this PR.
- Do not remove or route around `StorageAPI::get_disks` in this PR.
- Do not add temporary compatibility code unless a matching
`RUSTFS_COMPAT_TODO(<task-id>)` marker and cleanup-register entry are added.