Skip to content

docs(enterprise): document trusting a private CA - #12659

Merged
mergify[bot] merged 1 commit into
mainfrom
devs/sileht/docs-enterprise-custom-ca/document-trusting-private-ca--b0ef33d6
Sep 3, 2026
Merged

docs(enterprise): document trusting a private CA#12659
mergify[bot] merged 1 commit into
mainfrom
devs/sileht/docs-enterprise-custom-ca/document-trusting-private-ca--b0ef33d6

Conversation

@sileht

@sileht sileht commented Sep 2, 2026

Copy link
Copy Markdown
Member

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

Copilot AI lite review requested due to automatic review settings September 2, 2026 08:30
@mergify
mergify Bot had a problem deploying to Mergify Merge Protections September 2, 2026 08:30 Failure
@mergify

mergify Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Merge Protections

🟢 All 6 merge protections satisfied — ready to merge.

Show 6 satisfied protections

🟢 🤖 Continuous Integration

  • all of:
    • check-success = build
    • check-success = lint
    • check-success = test
    • any of:
      • check-success = test-broken-links
      • label = ignore-broken-links
    • any of:
      • check-success=Cloudflare Pages
      • -head-repo-full-name~=^Mergifyio/

🟢 👀 Review Requirements

  • any of:
    • #approved-reviews-by >= 2
    • author = dependabot[bot]
    • author = renovate[bot]
    • all of:
      • author = mergify-ci-bot
      • -head ~= ^docs-agent/

🟢 Enforce conventional commit

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

  • title ~= ^(fix|feat|internal|docs|style|refactor|perf|test|build|ci|chore|revert|ui)(?:\(.+\))?!?:

🟢 🔎 Reviews

  • #changes-requested-reviews-by = 0
  • #review-requested = 0
  • #review-threads-unresolved = 0

🟢 📕 PR description

  • body ~= (?ms:.{48,})

🟢 🚦 Auto-queue

When all merge protections are satisfied, this pull request will be queued automatically.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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_BUNDLE usage, 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.

Comment thread src/content/docs/enterprise/custom-ca.mdx Outdated
Comment thread src/content/docs/enterprise/troubleshooting.mdx Outdated
@mergify
mergify Bot requested a review from a team September 2, 2026 08:34
jd
jd previously approved these changes Sep 2, 2026
@mergify
mergify Bot requested a review from a team September 2, 2026 11:54
@sileht
sileht force-pushed the devs/sileht/docs-enterprise-custom-ca/document-trusting-private-ca--b0ef33d6 branch from a6d130b to b1240b9 Compare September 2, 2026 13:24
@sileht

sileht commented Sep 2, 2026

Copy link
Copy Markdown
Member Author

Revision history

# Type Changes Reason Date
1 initial a6d130b 2026-09-02 13:24 UTC
2 content a6d130b → b1240b9 (raw) 2026-09-02 13:24 UTC
3 content b1240b9 → 1fe01fa (raw) 2026-09-02 13:27 UTC
4 content 1fe01fa → bd960d6 (raw) 2026-09-02 13:33 UTC

@sileht
sileht marked this pull request as ready for review September 2, 2026 13:24
@mergify
mergify Bot dismissed jd’s stale review September 2, 2026 13:25

Pull request has been modified.

@mergify
mergify Bot had a problem deploying to Mergify Merge Protections September 2, 2026 13:25 Failure
@sileht
sileht force-pushed the devs/sileht/docs-enterprise-custom-ca/document-trusting-private-ca--b0ef33d6 branch from b1240b9 to 1fe01fa Compare September 2, 2026 13:27
@mergify
mergify Bot had a problem deploying to Mergify Merge Protections September 2, 2026 13:27 Failure
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
@sileht
sileht force-pushed the devs/sileht/docs-enterprise-custom-ca/document-trusting-private-ca--b0ef33d6 branch from 1fe01fa to bd960d6 Compare September 2, 2026 13:33
@mergify
mergify Bot deployed to Mergify Merge Protections September 2, 2026 13:33 Active
@mergify
mergify Bot requested a review from a team September 3, 2026 07:36
@mergify

mergify Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

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

@mergify mergify Bot added the queued label Sep 3, 2026
@mergify
mergify Bot merged commit e056e20 into main Sep 3, 2026
10 checks passed
@mergify
mergify Bot deleted the devs/sileht/docs-enterprise-custom-ca/document-trusting-private-ca--b0ef33d6 branch September 3, 2026 07:45
@mergify mergify Bot removed the queued label Sep 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

4 participants