gsadmin/rustfs
1
0
Fork 0
mirror of https://github.com/rustfs/rustfs.git synced 2026-08-12 08:06:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: close final architecture audit gaps (#3966)

Browse Source
This commit is contained in:
Zhengchao An
2026-06-28 00:07:42 +08:00
committed by GitHub
parent 79234c030d
commit 7ae9697d42
20 changed files with 215 additions and 126 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/architecture/migration-progress.md
+39 -20
View File
@@ -5,7 +5,10 @@ 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-final-migration-validation`
is closed after PR #3965; execution index
[`rustfs/backlog#665`](https://github.com/rustfs/backlog/issues/665) is
treated as the historical task split once final sync is posted.
- Branch: `main` closeout state, with final audit remediation recorded here.
- Baseline: completed `C-011/C-012/C-013/API-055/API-059/API-079/API-080/API-081/API-082/API-083/API-084/API-085/API-086/API-087/API-088/API-089/API-090/API-091/API-092/API-093/API-094/API-095/API-096/API-097/API-098/API-099/API-100/API-101/API-102/API-103/API-104/API-105/API-106/API-107/API-108/API-109/API-110/API-111/API-112/API-113/API-114/API-115/API-116/API-117/API-118/API-119/API-120/API-121/API-122/API-123/API-124/API-125/API-126/API-127/API-128/API-129/API-130/API-131/API-132/API-133/API-134/API-135/API-136/API-137/API-138/API-139/API-140/API-141/API-142/API-143/API-144/API-145/API-146/API-147/API-148/API-149/API-150/API-151/API-152/API-153/API-154/API-155/API-156/API-157/API-158/API-159/API-160/API-161/API-162/API-163/API-164/API-165/API-166/API-167/API-168/API-169/API-170/API-171/API-172/API-173/API-174/API-175/API-176/API-177/API-178/API-179/API-180/API-181/API-182/API-183/API-184/API-185/API-186/API-187/API-188/API-189/API-190/API-191/API-192/API-193/API-194/API-195/API-196/API-197/API-198/API-199/API-200/API-201/API-202/API-203/API-204/API-205/API-206/API-207/API-208/API-209/API-210/API-211/API-212/API-213/API-214/API-215/API-216/API-217/API-218/API-219/API-220/API-221/API-222/API-223/API-224/API-225/API-226/API-227/API-228/API-229/API-230/API-231/API-232/API-233/API-234/API-235/API-236/API-237/API-238/API-239/API-240/API-241/API-242/API-243/API-244/API-245/API-246/API-247/API-248/API-249/API-250/API-251/API-252/API-253/API-254/CTX-002`.
- Current baseline also includes API-255 from PR #3923, API-256 from PR
#3925, CFG-009 from PR #3927, C-007/C-009 from PR #3935, C-008/C-010
@@ -28,16 +31,18 @@ Status values: `[ ]` not started, `[~]` in progress, `[x]` complete, `[!]` block
the GLOB-007 specialized resolver fallback
boundary from PR #3958, the GLOB-007 root runtime fallback facade cleanup
from PR #3961, the Phase 7 global-state/crate-split closeout from
PR #3962, and the combined `TEST-RUN-001`/`TEST-REP-001` preservation tests
from PR #3964.
- Current phase PR: final issue #660 validation and closeout after backlog
sub-issues #668 and #669 were closed.
- Based on: `origin/main` at PR #3964 (`82bbef0b6`).
PR #3962, the combined `TEST-RUN-001`/`TEST-REP-001` preservation tests
from PR #3964, and the final issue #660 validation closeout from PR #3965.
- Current phase PR: post-closeout audit remediation for stale ledger/issue
wording, S3 compatibility claim alignment, and workflow-pin enforcement.
- Based on: `origin/main` at PR #3965 (`79234c030`).
- PR type for this branch: `ci-gate`.
- Runtime behavior changes: none.
- Rust code changes: none.
- CI/script changes: none intended.
- Docs changes: record final #660 validation status and closeout handoff.
- CI/script changes: pin GitHub Actions to commit SHAs and make the workflow
pin audit enforce the existing supply-chain check.
- Docs changes: align README S3 compatibility wording with the s3tests
compatibility matrix and record final #660/#665 closeout state.
## Phase 0 Tasks
@@ -6137,14 +6142,17 @@ Status values: `[ ]` not started, `[~]` in progress, `[x]` complete, `[!]` block
## Next PRs
1. `ci-gate`: merge this final issue #660 validation closeout branch.
2. No further issue #660 migration PRs remain after this branch lands; close
backlog #660 with the merged PR reference.
1. `ci-gate`: merge the post-closeout audit remediation branch.
2. No further issue #660 migration implementation PRs remain; future
architecture work should use a new backlog issue.
## Pre-Push Review Log
| Expert | Status | Notes |
|---|---|---|
| Quality/architecture | pass | Final audit found no storage-api, ECStore, runtime/lifecycle, extension/security, or background-controller module blocker; this remediation only tightens documentation and CI supply-chain gates. |
| Migration preservation | pass | The original local plan is historical; the progress ledger plus backlog closeout agree that #660/#668/#669 are closed, while #665 is only the historical execution index pending final sync. |
| Testing/verification | pass | Final audit found runtime/repair/scheduler/KMS/CFG/CTX/API/BGC coverage aligned; it corrected S3 compatibility claim drift and upgraded workflow pin checking from report-only to enforced after pinning all action refs. |
| Quality/architecture | pass | Final validation is docs-only and records the merged #3964 preservation-test closeout without changing runtime, storage, or migration guard code. |
| Migration preservation | pass | The latest backlog #660 execution index and migration-progress agree that #668/#669 were the last incomplete sub-issues and are closed after #3964; older local plan files are historical. |
| Testing/verification | pass | Ledger status scan, backlog issue-state check, architecture migration guard, diff hygiene, and docs-only source scan passed for the closeout. |
@@ -9970,8 +9978,8 @@ Notes:
- `rg -n "^- \[[~! ]\]" docs/architecture/migration-progress.md`:
passed; no in-progress, blocked, or not-started task rows remain in the
progress ledger.
- Backlog issue-state check: passed; #668 and #669 are closed, while #660
remains open until this final validation branch lands.
- Backlog issue-state check: passed; #660, #668, and #669 are closed after
PR #3965, while #665 is a historical execution index pending final sync.
- Historical plan reconciliation: passed; the original local plan files are
superseded by the latest backlog #660 execution index and this
`migration-progress.md` ledger.
@@ -9980,13 +9988,24 @@ Notes:
- Docs-only scope scan: passed; only
`docs/architecture/migration-progress.md` changed.
- Issue #660 post-closeout audit remediation:
- Five-agent audit: completed across plan/ledger alignment, module structure,
behavior invariants, test/quality gates, and document/issue sync.
- S3 compatibility claim audit: fixed README overclaim wording and added
[`s3-compatibility-matrix.md`](s3-compatibility-matrix.md) tied to
`implemented_tests.txt`, `unimplemented_tests.txt`, and
`excluded_tests.txt`.
- Supply-chain workflow pin audit: all third-party GitHub Actions are pinned
to full-length commit SHAs, and `check_workflow_pins.sh --enforce` is the
audit workflow gate.
## Handoff Notes
- PR #3951, PR #3961, PR #3962, and PR #3964 are merged. Backlog sub-issues
#668 (`TEST-RUN-001`) and #669 (`TEST-REP-001`) are closed.
- After this final validation branch lands, close backlog #660 with the merged
PR reference. No further issue #660 migration PRs remain in the progress
ledger.
- PR #3951, PR #3961, PR #3962, PR #3964, and PR #3965 are merged. Backlog
issues #660, #668 (`TEST-RUN-001`), and #669 (`TEST-REP-001`) are closed.
- #665 is the historical execution index for #660. After final issue sync is
posted, close #665 rather than reopening #660.
- The final audit remediated stale closeout wording, README S3 compatibility
overclaiming, and report-only workflow pin checking.
- Treat the original local plan files as historical context; the current source
of truth is this progress ledger plus the latest backlog #660 execution
index.
of truth is this progress ledger plus the final #660/#665 issue sync.
docs/architecture/s3-compatibility-matrix.md
+70
View File
@@ -0,0 +1,70 @@
# S3 Compatibility Matrix
This matrix records the user-facing S3 compatibility claim for RustFS and ties
it to the executable Ceph s3tests lists under `scripts/s3-tests/`.
## Current Claim
RustFS provides broad S3 API compatibility for supported features. It does not
claim complete coverage of every standard or vendor-specific S3 behavior.
The root README should use the same wording: supported S3-compatible clients and
features are covered by the compatibility matrix and test lists.
## Test List Sources
| List | Purpose | Current count | Source |
|---|---:|---:|---|
| Implemented tests | Standard S3 tests expected to pass and used by the default local s3tests run. | 449 | `scripts/s3-tests/implemented_tests.txt` |
| Unimplemented tests | Standard S3 features planned but not yet implemented. | 17 | `scripts/s3-tests/unimplemented_tests.txt` |
| Excluded tests | Vendor-specific or intentionally unsupported behavior excluded from RustFS compatibility gating. | 281 | `scripts/s3-tests/excluded_tests.txt` |
Counts ignore blank lines and comments.
## Supported Coverage
The implemented test list currently covers the common object-storage surface:
| Area | Status | Evidence |
|---|---|---|
| Bucket create/delete/list/head | Supported | `implemented_tests.txt` |
| Object put/get/delete/copy/head | Supported | `implemented_tests.txt` |
| ListObjects/ListObjectsV2 prefix, delimiter, marker, max-keys | Supported | `implemented_tests.txt` |
| Multipart upload create/upload/complete/abort and selected multipart copy/checksum/object-attribute behavior | Supported | `implemented_tests.txt` |
| Bucket and object tagging | Supported | `implemented_tests.txt` |
| Bucket policy put/get/delete | Supported | `implemented_tests.txt` |
| Public access block put/get/delete | Supported | `implemented_tests.txt` |
| Presigned GET and PUT URLs | Supported | `implemented_tests.txt` |
| Range and conditional reads | Supported | `implemented_tests.txt` |
| User metadata | Supported | `implemented_tests.txt` |
| SSE-C and selected SSE-KMS edge cases | Supported | `implemented_tests.txt` |
| Selected versioning, object-lock, checksum, CORS, raw request, and conditional write behavior | Supported | `implemented_tests.txt` |
## Planned Standard Coverage
These are standard S3 areas that remain planned work and must not be described
as already complete:
| Area | Status | Evidence |
|---|---|---|
| Bucket access logging | Planned | `unimplemented_tests.txt` |
| POST Object form upload checksum handling | Planned | `unimplemented_tests.txt` |
| Bucket ownership controls | Planned | `unimplemented_tests.txt` |
| Multipart upload listing and part lookup compatibility edge cases | Not part of default gate | `excluded_tests.txt` |
| IAM-account or multi-storage-class dependent cases | Not part of default gate | `unimplemented_tests.txt` |
| Tenanted bucket policy edge cases | Needs investigation | `unimplemented_tests.txt` |
## Intentional Exclusions
`excluded_tests.txt` contains tests that should not block the RustFS
compatibility gate. They fall into two classes:
- vendor-specific or non-portable behavior not required for RustFS S3
compatibility;
- intentionally unsupported product behavior, such as ACL authorization.
## Update Rule
When a planned S3 feature is implemented, move its passing test entries from
`unimplemented_tests.txt` to `implemented_tests.txt`, update this matrix, and
avoid changing README wording beyond the supported coverage.