Skip to content

[P2] documentation sync (4 design docs) + final acceptance evidence #5365

Description

@qqeasonchen

Tracking sub-issue of #5354. Part of the production-HA acceptance plan (Phase 4, P2).

What this PR changes

The four design documents that #5352 / #5353 / #5354 explicitly call out are updated to reflect the actual runtime behavior after #5359 / #5360 / #5361 / #5362 / #5363 / #5364 land. A row is added to docs/architecture-review/evidence.md for each of the 8 tracking issues.

Doc changes

  • docs/eventmesh-architecture.md section "Control plane": replace the "wiring is a follow-up" sentence with the actual boot-time MetaStore wiring and the explicit fail-fast messages.
  • docs/control-plane.md sections 1.2 / 1.3 / 4: document the PARTITION_OWNED_PULL fail-fast paths, the A2A operation classification, and the admin security posture.
  • docs/production-readiness.md sections 5 / 6 / 7: link to the Testcontainers harness, the chaos test matrix, the supported backend × topology matrix, and the metrics + alert table.
  • docs/eventmesh-offset-lb-frame-design.md section 3: add the FrameLimits table (max frame 16 MiB, max payload 8 MiB, max attrs 64, max attr-name 256 B, max attr-value 4 KiB); document the immutable API; document the streaming isFinal semantics.

docs/architecture-review/production-ha-plan.md

The plan document is the source of truth for the topology. This issue adds:

Acceptance criteria

Verification

This is a docs PR. The verification is:

# docs build
mkdocs build --strict  # or the project's doc build command

# cross-link check
grep -r 'docs/architecture-review/production-ha-plan.md' docs/
grep -r 'docs/eventmesh-architecture.md' docs/control-plane.md
grep -r 'docs/control-plane.md' docs/production-readiness.md

Depends on / blocks

References

  • docs/eventmesh-architecture.md
  • docs/control-plane.md
  • docs/production-readiness.md
  • docs/eventmesh-offset-lb-frame-design.md
  • docs/architecture-review/production-ha-plan.md (new)
  • docs/architecture-review/evidence.md (existing, will be appended)

Part of the production-HA topology in #5354. See also #5352 and #5353.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions