docs: pgcat prod guide docs #2660
Conversation
WalkthroughAdds a new "Database Pooling with Pgcat" docs page, updates site navigation to include it, and extends the configuration guide with a production best-practices section recommending pgcat and providing example settings and deployment patterns. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/setting-up/configuration.mdx (1)
494-494: Use a realistic password placeholder for clarity.The password placeholder "password" could be confused with an actual password. Consider using a placeholder name like "DB_USER_PASSWORD" (as used in pooling.mdx) to make it clear this needs to be replaced.
Also applies to: 496-496
docs/setting-up/installation/pooling.mdx (1)
78-78: Minor style improvement: remove weak intensifier.The phrase "very small deployments" could be simplified to "small deployments" for clearer communication.
Apply this diff:
-Run pgcat as a sidecar next to Permify in the same Pod for very small deployments. In most cases a shared pgcat Service is simpler to operate and scale. +Run pgcat as a sidecar next to Permify in the same Pod for small deployments. In most cases a shared pgcat Service is simpler to operate and scale.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/mint.json(1 hunks)docs/setting-up/configuration.mdx(1 hunks)docs/setting-up/installation/pooling.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/setting-up/installation/pooling.mdx
[style] ~78-~78: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...car next to Permify in the same Pod for very small deployments. In most cases a shared pgc...
(EN_WEAK_ADJECTIVE)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Scan Container for Vulnerabilities
- GitHub Check: Test with Coverage
- GitHub Check: Analyze (go)
- GitHub Check: Test with Coverage
🔇 Additional comments (4)
docs/mint.json (1)
316-317: Navigation entry is well-structured.The new pooling page is correctly positioned under Deployment > Installation with proper JSON syntax and path reference.
docs/setting-up/configuration.mdx (1)
490-502: Align configuration with pooling.mdx guidance.This configuration example differs significantly from the equivalent in the new
pooling.mdxfile:
max_connection_lifetime: 300s here vs 3600s in pooling.mdx- Missing lifecycle settings:
max_connection_lifetime_jitter,health_check_period,connect_timeoutVerify which configuration is correct and update both locations to be consistent, or clarify the differences (e.g., if this is a minimal vs recommended setup).
docs/setting-up/installation/pooling.mdx (2)
1-211: Excellent foundational documentation for Pgcat pooling.The page provides clear, well-organized guidance on when and how to use Pgcat for production deployments. The structure (overview, installation, reference config, Permify integration, sizing, monitoring, troubleshooting, backward compatibility) is logical and comprehensive. Configuration examples are technically sound, and the cautions about session mode and connection lifecycle are appropriate.
129-134: Query parameter clarification is excellent.The
<Note>block (lines 129-134) clearly explains the purpose ofplan_cache_modeanddefault_query_exec_modeparameters and why they're necessary with Pgcat's session mode. This guidance will help users understand the "why" behind the configuration, not just the "what."
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2660 +/- ##
==========================================
- Coverage 82.53% 82.52% -0.01%
==========================================
Files 74 74
Lines 8125 8125
==========================================
- Hits 6705 6704 -1
- Misses 904 905 +1
Partials 516 516 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.