Skip to content

docs: add abstract-before-detail intro for bounded-eventual + gate-hygiene#15

Open
weicao wants to merge 4 commits intomainfrom
helen/abstract-retrofit-bounded-eventual-and-gate-hygiene
Open

docs: add abstract-before-detail intro for bounded-eventual + gate-hygiene#15
weicao wants to merge 4 commits intomainfrom
helen/abstract-retrofit-bounded-eventual-and-gate-hygiene

Conversation

@weicao
Copy link
Copy Markdown
Contributor

@weicao weicao commented Apr 29, 2026

Summary

Add '## 先用白话理解这篇文档' section to two Helen-owned methodology docs, following the host-stress / componentdef-upgrade gold standard pattern.

Changes

  • addon-bounded-eventual-convergence-guide.md: add abstract section
  • addon-test-environment-gate-hygiene-guide.md: add intro block (was missing 5 fields) + abstract section

Each abstract has 6 sub-sections:

  1. 你之前可能这么想 (wrong way)
  2. 这种思路的代价 (cost) / 在 K8s+DB 几乎必然踩坑
  3. 正确 reframe
  4. 什么时候应该 reach 这篇 (per-rule scope tags)
  5. 读完这篇你能做什么 (decision capability)
  6. 为什么独立成篇 (boundary clarification)

Addresses westonnnn 17:31 questions

  • 问题背景 (problem context): wrong-way → reframe at start of each doc
  • 应用场景 (per-rule scope): explicit when-to-apply enumeration in abstract
  • 逻辑合理 (logic consistency): boundary clarification with sibling docs

Owner self-write

Per Alice 17:33 framework split, substantive owner-起笔. Allen will not be drafting these two; they're written directly by Helen as owner.

Parallel: Alice writing 4 other docs (switchover / test-acceptance / tls / test-probe-classification) v0 abstracts.

weicao added 3 commits April 29, 2026 14:22
…reconciliation

cell-4 MariaDB single-load R1 (sample mdb-vc396r1-134638, alpha.11):
- T1-T11 / CM1-4 / R3 全过;chaos C4-C8 + T12 observation-class fails
- T12 csi-resizer single restart drift trigger hard-freeze
- cascade shape absent (4/4 plugin / readyz 5xok / CPU 256% vs cell-2 1645%)
- cell-4 = no cascade

Updates:
- chapter 2 evidence matrix: cell-1 / cell-3 / cell-4 cells filled with cross-refs
- appendix C: KB version + chart version 标注
- appendix D: full cell-4 case material with two-engine N=2 confirmation
  cross-ref to appendix B
- chapter 7: N=2 reconciliation (cell-3 + cell-4 cross-engine)
- manual <a name=""> anchors for stable cross-ref
…giene

Add '## 先用白话理解这篇文档' section to both docs following the
host-stress / componentdef-upgrade gold standard pattern:
- 你之前可能这么想 (wrong way)
- 这种思路的代价 (cost)
- 正确 reframe (correct reframe)
- 什么时候应该 reach 这篇 (when to apply scope tags)
- 读完这篇你能做什么 (decision capability)
- 为什么独立成篇 (boundary with sibling docs)

Addresses westonnnn 17:31 questions:
- 问题背景 (problem context): wrong-way → reframe at start
- 应用场景 (per-rule scope): explicit when-to-apply enumeration
- 逻辑合理 (logic consistency): boundary clarification with sibling docs

Owner self-write per Alice 17:33 framework split (substantive owner-起笔).
Adopt Allen's scope-table pattern (per his v0 draft proposal) to make
per-rule trigger more precise:

- bounded-eventual-convergence: 5 trigger rows × key decision
- test-environment-gate-hygiene: 6 trigger rows × key gate

Tables more directly address westonnnn 17:31 Q1 (per-rule scope)
than narrative prose enumeration.
…ule 8 + cross-engine caveat

Per Allen logic-flow audit (b71d32a5):
- Add 'rule 对应' column to anti-pattern table
- Add per-rule '应用场景' (when-to-apply) tag to each of 7 rules
- Add Rule 8 explicitly for addon-side reach (covers anti-pattern #5
  rejoin gate which previously had no dedicated rule)
- Add cross-engine scope caveat (current evidence MariaDB-specific,
  timeout numbers need cross-engine recalibration)

Addresses westonnnn 17:31 Q1 (per-rule scope) + Q2 (logic chain
explicit anti-pattern → rule mapping).
weicao added a commit that referenced this pull request May 7, 2026
…l finalizer deadlock

Documents N=4 reproducible KB DataProtection cleanup-order finalizer deadlock
pattern observed across MySQL Addon line task #11 / #14 / #15 / #16:

- task #11 (case A): deletionPolicy=Delete + ns Terminating + cleanup Job RoleBinding admission deny
- task #14 (case B): Retain prophylactic alone insufficient; finalizer still stuck
- task #15 (case C): Retain + sequential delete still insufficient
- task #16 (case D): Retain + sequential + user-managed MinIO server last still insufficient

Body covers:
- Dependency chain explanation (namespace controller waits BackupRepo waits
  Backup waits DataProtection controller reconcile waits ns-scoped operations
  rejected by admission during ns Terminating)
- Recommended sequential delete order with wait-NotFound at each layer
- Emergency force-remove finalizer pattern with evidence transparency
- Controller log filter discipline (bounded window, explicit scope)
- Anti-patterns
- 4-case appendix table linking back to MySQL line tasks
- Upstream fix hypotheses pending source-code reading

Companion sibling doc to addon-narrow-scope-force-delete-guide.md (pod-level
finalizer deadlock during image pull); both document finalizer deadlock at
different scopes with the "evidence-first then targeted force-remove" doctrine.

Adds:
- New file: docs/addon-dataprotection-cleanup-order-guide.md
- SKILL-INDEX.md: section 4 (运行期/排障) and 文档全列表 entries
- addon-narrow-scope-force-delete-guide.md: reverse anchor in 与其他文档的关系

Co-authored-by: William <william@apecloud.com>
Co-authored-by: Henry <henry@apecloud.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant