docs(enterprise): document trusting a private CA - #12659
Conversation
Merge Protections🟢 All 6 merge protections satisfied — ready to merge. Show 6 satisfied protections🟢 🤖 Continuous Integration
🟢 👀 Review Requirements
🟢 Enforce conventional commitMake sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
🟢 🔎 Reviews
🟢 📕 PR description
🟢 🚦 Auto-queueWhen all merge protections are satisfied, this pull request will be queued automatically. |
There was a problem hiding this comment.
🟢 Approval recommended
Only minor wording/grammar nits were found, with no functional or structural documentation issues identified.
Pull request overview
Adds dedicated Enterprise documentation for trusting private/self-signed CAs and updates existing Enterprise docs to recommend using MERGIFYENGINE_EXTRA_CA_BUNDLE (with caveats) instead of disabling TLS verification, then links the new guidance from key operator “failure points” (connectivity checks and outbound subscription calls).
Changes:
- Add a new Enterprise docs page covering
MERGIFYENGINE_EXTRA_CA_BUNDLEusage, caveats, and verification steps. - Update Installation, Requirements, Troubleshooting, and Enterprise overview pages to link to the new Private CA guidance.
- Add “Private CA” to the Enterprise navigation.
File summaries
| File | Description |
|---|---|
| src/content/enterpriseNavItems.ts | Adds the new “Private CA” entry to the Enterprise nav. |
| src/content/docs/enterprise/custom-ca.mdx | New page documenting how to trust a private/self-signed CA bundle and related caveats. |
| src/content/docs/enterprise/installation.mdx | Reorders guidance to prefer CA bundle for Redis/PostgreSQL TLS verification and links to the new page. |
| src/content/docs/enterprise/requirements.mdx | Notes egress proxy TLS interception implications and links to the new page. |
| src/content/docs/enterprise/troubleshooting.mdx | Links connectivity-check certificate verification failures to the new page. |
| src/content/docs/enterprise.mdx | Adds a top-level pointer to the new “Trusting a Private CA” page. |
Review details
- Files reviewed: 6/6 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
a6d130b to
b1240b9
Compare
Revision history
|
b1240b9 to
1fe01fa
Compare
The enterprise docs never said how to make an on-premise deployment trust a private or self-signed certificate authority, and installation.mdx told operators to disable Redis TLS verification instead, which is the anti-pattern this was raised about. Add an enterprise page for MERGIFYENGINE_EXTRA_CA_BUNDLE: what belongs in the bundle, how to mount it, how to confirm it took effect, and the places where the setting alone is not enough. PostgreSQL needs sslmode=verify-full before libpq consults the roots at all, REDIS_SSL_VERIFY_MODE_CERT_NONE overrides the bundle, SSL_CERT_DIR reaches only part of the engine, and the bundle is read once per process so rotating the CA needs a restart. The PostgreSQL and Redis caveats come before the verification steps on purpose: a connectivity check against a connection that verifies nothing reports ok either way. installation.mdx now leads its self-signed Redis section with the bundle and keeps REDIS_SSL_VERIFY_MODE_CERT_NONE only as the fallback for a certificate you cannot obtain, while still telling a truly self-signed deployment to put the server certificate itself in the bundle, and pointing managed-Redis users at the CA their provider publishes. Its vague PostgreSQL "configure the connection options accordingly" becomes the concrete sslmode. The section heading is unchanged so its existing anchor keeps resolving. Troubleshooting and requirements link the page from the two places an operator hits the wall: a connectivity check that fails on certificate verification, and an egress proxy that re-signs the subscription calls. Fixes MRGFY-8831 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018XJzBXXpAFeRk3pLsADvjw Change-Id: Ib0ef33d61614b688512cfe24897e121790072193
1fe01fa to
bd960d6
Compare
Merge Queue Status
This pull request spent 3 minutes 5 seconds in the queue, including 2 minutes 22 seconds running CI. Required conditions to merge
|
The enterprise docs never said how to make an on-premise deployment trust a
private or self-signed certificate authority, and installation.mdx told
operators to disable Redis TLS verification instead, which is the anti-pattern
this was raised about.
Add an enterprise page for MERGIFYENGINE_EXTRA_CA_BUNDLE: what belongs in the
bundle, how to mount it, how to confirm it took effect, and the places where
the setting alone is not enough. PostgreSQL needs sslmode=verify-full before
libpq consults the roots at all, REDIS_SSL_VERIFY_MODE_CERT_NONE overrides the
bundle, SSL_CERT_DIR reaches only part of the engine, and the bundle is read
once per process so rotating the CA needs a restart. The PostgreSQL and Redis
caveats come before the verification steps on purpose: a connectivity check
against a connection that verifies nothing reports ok either way.
installation.mdx now leads its self-signed Redis section with the bundle and
keeps REDIS_SSL_VERIFY_MODE_CERT_NONE only as the fallback for a certificate
you cannot obtain, while still telling a truly self-signed deployment to put
the server certificate itself in the bundle, and pointing managed-Redis users
at the CA their provider publishes. Its vague PostgreSQL "configure the
connection options accordingly" becomes the concrete sslmode. The section
heading is unchanged so its existing anchor keeps resolving.
Troubleshooting and requirements link the page from the two places an operator
hits the wall: a connectivity check that fails on certificate verification, and
an egress proxy that re-signs the subscription calls.
Fixes MRGFY-8831
Co-Authored-By: Claude Opus 5 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_018XJzBXXpAFeRk3pLsADvjw