Skip to content

docs(pre2): add VM image test guide - #92

Merged
sqlrush merged 2 commits into
mainfrom
docs/pre2-vm-test-guide
Oct 11, 2026
Merged

sqlrush merged 2 commits into
mainfrom
docs/pre2-vm-test-guide

Conversation

@sqlrush

@sqlrush sqlrush commented Oct 11, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add docs/pre2/vm-test-guide.md, a step-by-step test guide for the v0.135.0 ARM64 single-VM image. It covers:
    • architecture and how local PGDATA relates to the shared data directory;
    • cluster features: Cache Fusion 2-way and 3-way transfer, PCM block states and past images, GRD, GES, LMD deadlock detection, global SCN, undo/TT/ITL multi-versioning, per-instance WAL threads, membership and quorum, and background processes;
    • download, verification, installation, connection, hands-on labs, normal stop and restart, recovery steps, test recommendations and how to collect logs.
  • Add the companion lab scripts under docs/pre2/sql/.
  • Link the guide from docs/pre2/README.md and docs/pre2/vm-image.md.
  • The guide has 12 Mermaid diagrams and uses GitHub alert blocks.

Test plan

  • Downloaded the v0.135.0 release assets with the documented curl loop and ran the verification, merge and extract commands; every check printed OK.
  • Imported fresh copies of the image and ran each lab in document order: status checks, cross-node read/write, Cache Fusion counter deltas, row-lock wait (GesTxEnqueueWait), table-lock conflict (55P03), consistent read, pgbench with 4 clients per instance (no failed transactions; the four nodes read the same totals; the total increase equals the number of committed transactions), deadlock detection (40P01), SCN, WAL threads and shared files.
  • Ran ./stop.sh, ./start.sh and ./test.sh again after the restart; data was preserved.
  • Parsed all Mermaid blocks with mermaid 11; checked that every table-of-contents anchor exists on the rendered branch page.
  • After merge, confirm that the raw script URLs on main resolve.

SqlRush added 2 commits October 11, 2026 19:44
Add docs/pre2/vm-test-guide.md: download, verification, installation, connection, cluster feature overview, hands-on labs, normal stop and restart, test recommendations and support information for the v0.135.0 single-VM image. Add the companion SQL scripts under docs/pre2/sql/ and link the guide from the PRE2 index and the image guide.
Update the lab outputs, the restart and recovery steps and the section wording in docs/pre2/vm-test-guide.md.
@sqlrush
sqlrush merged commit b98ef6e into main Oct 11, 2026
5 checks passed
@sqlrush
sqlrush deleted the docs/pre2-vm-test-guide branch October 11, 2026 11:59
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