Skip to content

Add admin commands docs, static musl binary, and comprehensive README improvements#142

Merged
vadv merged 4 commits intomasterfrom
feature/readme-musl-release
Mar 3, 2026
Merged

Add admin commands docs, static musl binary, and comprehensive README improvements#142
vadv merged 4 commits intomasterfrom
feature/readme-musl-release

Conversation

@vadv
Copy link
Collaborator

@vadv vadv commented Mar 3, 2026

Summary

Commit 1: Admin commands & static binary

  • Document PAUSE / RESUME / RECONNECT admin commands in README: comparison table row + dedicated section with SQL examples
  • Add static-binary job to release workflow — builds fully statically linked binaries via rust:1.87.0-alpine (musl), uploads pg_doorman-linux-amd64-static and patroni_proxy-linux-amd64-static as release artifacts

Commit 2: Comprehensive README improvements

Add 7 new documentation sections based on competitor analysis (PgBouncer, Odyssey, PgPool-II):

  • Pooling Modes — transaction vs session mode explanation
  • SQL Feature Compatibility — matrix of what works in each pooling mode (inspired by PgBouncer features page)
  • TLS / SSL — client-facing and server-facing TLS configuration with mode reference table
  • Monitoring — Prometheus metrics endpoint configuration and key metrics table
  • Signals & Zero-Downtime Upgrade — signal reference table, binary upgrade procedure, systemd integration
  • Docker — container usage example with environment variables table
  • Coming from PgBouncer? — migration guide with INI→YAML parameter mapping table

Commit 3: Advisory locks & TLS security

  • Fix advisory locks documentation: session-level pg_advisory_lock is unreliable with any pooler, recommend pg_advisory_xact_lock instead
  • Add TLS Security defaults subsection: TLS 1.2 minimum, Mozilla Intermediate ciphers, full SAN+CN hostname verification
  • Add comparison table row highlighting Odyssey's TLS 1.0 and weak cipher defaults

README grows from 201 to 375 lines (15 sections total).

Test plan

  • Verify README renders correctly on GitHub (all tables, code blocks, links)
  • Trigger release workflow on a test tag and confirm static binaries appear in artifacts
  • Verify static binaries are truly statically linked (file ... | grep "statically linked")

🤖 Generated with Claude Code

dmitrivasilyev and others added 2 commits March 3, 2026 09:41
Document PAUSE/RESUME/RECONNECT admin commands in the comparison table
and a new dedicated section. Add static-binary job using musl toolchain
to produce fully statically linked binaries as release artifacts.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add pooling modes explanation, SQL feature compatibility matrix,
TLS/SSL configuration, Prometheus monitoring, signals & zero-downtime
upgrade, Docker usage, and PgBouncer migration guide.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@vadv vadv changed the title Add admin commands docs and static musl binary to releases Add admin commands docs, static musl binary, and comprehensive README improvements Mar 3, 2026
dmitrivasilyev and others added 2 commits March 3, 2026 11:10
Advisory locks: clarify that session-level pg_advisory_lock is unreliable
with any connection pooler; recommend pg_advisory_xact_lock instead.

TLS: add Security defaults subsection documenting TLS 1.2 minimum,
Mozilla Intermediate ciphers, full SAN+CN hostname verification, and
startup validation. Add comparison table row highlighting Odyssey's
TLS 1.0 and weak cipher defaults.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@vadv vadv merged commit 9d45ecb into master Mar 3, 2026
42 checks passed
@vadv vadv deleted the feature/readme-musl-release branch March 3, 2026 10:48
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