mirror of
https://github.com/rustfs/rustfs.git
synced 2026-08-08 14:23:13 +00:00
chore(docs): refresh agent docs, guard doc paths, archive plans (#4203)
Agent-instruction and architecture docs had drifted from the code: - CLAUDE.md: slim to commands + pointers; fix wrong claim that `make pre-commit` is the full pre-PR gate (that is `make pre-pr`); drop stale pre-#3929 file paths and merged bug narratives - AGENTS.md: drop dead `rust-refactor-helper` skill rule and the hand-maintained (already stale) scoped-AGENTS index; link architecture docs from Sources of Truth - .github/AGENTS.md: replace the outdated copied CI command matrix with a pointer to ci.yml - crates/AGENTS.md: merge duplicated Testing sections - ARCHITECTURE.md: resolve the utils->config contradiction (edges are removed), mark volatile counts as snapshots, fix a bad path - docs/architecture: add README router; move one-shot plans/trackers (rebalance-decommission phases, migration-progress ledger, PR template) to docs/superpowers/plans with archive headers; fix stale source paths in kept inventories (core/sets.rs, core/pools.rs, store/mod.rs, startup_* split from #3671) - docs/operations/tier-ilm-debugging.md: extracted tier debugging playbook with corrected paths - scripts/check_doc_paths.sh: new guard failing pre-commit/pre-pr when instruction/architecture docs reference nonexistent file paths - .claude/skills: add tier-debug and arch-checks repo skills; .gitignore now keeps .claude/skills and docs/operations committable Verification: ./scripts/check_doc_paths.sh, ./scripts/check_architecture_migration_rules.sh (both pass) Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,51 @@
|
||||
---
|
||||
name: arch-checks
|
||||
description: Resolve failures from the repository's architecture guard scripts — check_layer_dependencies.sh, check_architecture_migration_rules.sh, check_unsafe_code_allowances.sh, check_logging_guardrails.sh, check_doc_paths.sh. Use when make pre-commit / pre-pr or CI fails on one of these checks.
|
||||
---
|
||||
|
||||
# Architecture Guard Checks
|
||||
|
||||
All five run in `make pre-commit` / `make pre-pr` and in CI. Fix the cause;
|
||||
never weaken a check to get green.
|
||||
|
||||
## `check_layer_dependencies.sh` — layer DAG in `rustfs/src`
|
||||
|
||||
Enforces `interface (admin, storage/ecfs, storage/s3_api) → app → infra`; no
|
||||
upward imports. Known legacy violations live in
|
||||
`scripts/layer-dependency-baseline.txt`.
|
||||
|
||||
- **New violation**: restructure your change so the dependency points
|
||||
downward (move the shared type/function to the lower layer).
|
||||
- **You legitimately removed a baseline entry**: run
|
||||
`./scripts/check_layer_dependencies.sh --update-baseline` and commit the
|
||||
shrunken baseline. Never add new entries to the baseline to make a new
|
||||
violation pass.
|
||||
|
||||
## `check_architecture_migration_rules.sh` — required doc sections
|
||||
|
||||
Asserts that the core docs under `docs/architecture/` (overview,
|
||||
crate-boundaries, runtime-lifecycle, readiness-matrix,
|
||||
storage-control-data-plane, global-state-crate-split-plan,
|
||||
ecstore-module-split-plan, …) still contain specific headings and exact
|
||||
source lines. If it fails after a doc edit, you reworded or removed a
|
||||
guarded line — restore the wording or update the script deliberately in the
|
||||
same PR, with rationale.
|
||||
|
||||
## `check_unsafe_code_allowances.sh`
|
||||
|
||||
Every `#[allow(unsafe_code)]` needs a `SAFETY:` comment within a few lines.
|
||||
Write the actual safety argument; don't add a placeholder.
|
||||
|
||||
## `check_logging_guardrails.sh`
|
||||
|
||||
A fixed list of security-sensitive files (auth, IAM, KMS, admin handlers…)
|
||||
is scanned for logging violations. If you created a new sensitive file,
|
||||
consider adding it to the script's `checked_files` list.
|
||||
|
||||
## `check_doc_paths.sh`
|
||||
|
||||
Instruction/architecture docs (`AGENTS.md`, `CLAUDE.md`, `ARCHITECTURE.md`,
|
||||
`docs/architecture/*.md`) must not reference repo file paths that no longer
|
||||
exist. If your refactor moved code, update the docs that point at it — the
|
||||
error message lists `doc -> stale-path` pairs. Historical plans under
|
||||
`docs/superpowers/plans/` are exempt.
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
name: tier-debug
|
||||
description: Debug ILM tiering / lifecycle transition issues — NoSuchVersion on tier GET, restore failures, xl.meta inspection, remote-tier versionId tracing. Use when investigating tiered/transitioned objects, warm backends, or transition metadata.
|
||||
---
|
||||
|
||||
# Tier / ILM Debugging
|
||||
|
||||
Full playbook: [docs/operations/tier-ilm-debugging.md](../../../docs/operations/tier-ilm-debugging.md)
|
||||
— read it before changing tier code.
|
||||
|
||||
Quick moves:
|
||||
|
||||
```bash
|
||||
# Inspect transition metadata on disk (one xl.meta per erasure shard disk)
|
||||
cargo run -p rustfs-filemeta --example dump_fileinfo -- "/path/to/{bucket}/{object}/xl.meta"
|
||||
|
||||
# Trace what versionId is sent to the remote tier
|
||||
RUST_LOG=rustfs_ecstore::bucket::lifecycle=debug ./target/debug/rustfs …
|
||||
```
|
||||
|
||||
Interpretation:
|
||||
|
||||
- `transition_ver_id: <none>` → correct for an unversioned tier bucket; no
|
||||
`versionId` must be sent on tier GET/DELETE.
|
||||
- `transition_ver_id: 00000000-…` (nil) → corrupt legacy write-back; readers
|
||||
must filter it out, never send it.
|
||||
- Empty-string `transitioned-versionID` metadata under both
|
||||
`x-rustfs-internal-*` and `x-minio-internal-*` keys → object went to an
|
||||
unversioned tier bucket.
|
||||
|
||||
Code entry points: `crates/ecstore/src/bucket/lifecycle/bucket_lifecycle_ops.rs`
|
||||
(ILM actions), `crates/ecstore/src/services/tier/` (warm backends),
|
||||
`crates/filemeta/src/filemeta/version.rs` (metadata read/write + regression
|
||||
tests).
|
||||
Reference in New Issue
Block a user