Skip to content

TLS Unification in DB ClickPipes: Update documentation#6421

Merged
pfcoperez merged 4 commits into
mainfrom
CP-707/tls-unification/update-docs
Jun 23, 2026
Merged

TLS Unification in DB ClickPipes: Update documentation#6421
pfcoperez merged 4 commits into
mainfrom
CP-707/tls-unification/update-docs

Conversation

@pfcoperez

@pfcoperez pfcoperez commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR adds TLS configuration settings to MySQL, Postgres and MongoDB ClickPipes pages. This information was so far missing.

Checklist


Note

Low Risk
Documentation-only changes with no application or infrastructure code; risk is limited to doc accuracy and reuse of Postgres UI screenshots across connectors.

Overview
Adds shared documentation for TLS connection options on database ClickPipes (Postgres, MySQL, MongoDB), which was previously missing from those guides.

A new reusable snippet (docs/_snippets/clickpipes/_changing_tls_settings.md) describes default behavior (TLS on with certificate verification), where to change settings at pipe creation or on a paused pipe’s Connection settings, and what Disable TLS, Skip certificate verification, TLS Host, and Upload CA mean—including security notes for plaintext and skipped verification. Each of the three connector index pages imports the snippet under an (Optional) Changing TLS settings section after connection details (Postgres places it after AWS Private Link, before SSH tunneling).

Reviewed by Cursor Bugbot for commit 500c484. Bugbot is set up for automated code reviews on this repo. Configure here.

@pfcoperez pfcoperez requested review from a team as code owners June 19, 2026 20:24
@CLAassistant

CLAassistant commented Jun 19, 2026

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ Blargian
❌ pfcoperez
You have signed the CLA already but the status is still pending? Let us recheck it.

@vercel

vercel Bot commented Jun 19, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clickhouse-docs Ready Ready Preview, Comment Jun 22, 2026 5:02pm
4 Skipped Deployments
Project Deployment Actions Updated (UTC)
clickhouse-docs-jp Ignored Ignored Jun 22, 2026 5:02pm
clickhouse-docs-ko Ignored Ignored Preview Jun 22, 2026 5:02pm
clickhouse-docs-ru Ignored Ignored Preview Jun 22, 2026 5:02pm
clickhouse-docs-zh Ignored Ignored Preview Jun 22, 2026 5:02pm

Request Review

@Blargian

Copy link
Copy Markdown
Member

Hey @pfcoperez, for repeated information like this across multiple files it's possible to use a reusable snippet. See for example https://github.com/ClickHouse/clickhouse-docs/blob/main/docs/_snippets/_gather_your_details_http.mdx which gets imported in

import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx';
<ConnectionDetails />

@pfcoperez pfcoperez changed the title Cp 707/tls unification/update docs TLS Unification in DB ClickPipes: Update documentation Jun 22, 2026
@pfcoperez

Copy link
Copy Markdown
Contributor Author

Hey @pfcoperez, for repeated information like this across multiple files it's possible to use a reusable snippet. See for example https://github.com/ClickHouse/clickhouse-docs/blob/main/docs/_snippets/_gather_your_details_http.mdx which gets imported in

import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx';
<ConnectionDetails />

This is great @Blargian , thank you!

I've followed your advice in 91cfaa5

@Blargian

Copy link
Copy Markdown
Member

Hey @pfcoperez, for repeated information like this across multiple files it's possible to use a reusable snippet. See for example https://github.com/ClickHouse/clickhouse-docs/blob/main/docs/_snippets/_gather_your_details_http.mdx which gets imported in

import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx';
<ConnectionDetails />

This is great @Blargian , thank you!

I've followed your advice in 91cfaa5

I think we're just missing the snippet file itself in the commit and then it should be good to go

@pfcoperez pfcoperez force-pushed the CP-707/tls-unification/update-docs branch from 91cfaa5 to ec5fa3a Compare June 22, 2026 16:08
@pfcoperez

Copy link
Copy Markdown
Contributor Author

I think we're just missing the snippet file itself in the commit and then it should be good to go

My mind! Sorry @Blargian ! Fixed now.


Where:

- `Disable TLS` toggles TLS for the connection on or off. Turning TLS off means data is sent as plaintext over the network, potentially including secrets and sensitive data.

@ilidemi ilidemi Jun 22, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

When TLS is "disabled", at least for PG we'd do sslmode=prefer instead of require which would use TLS if available, right? Or are we trying to be extra scary

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

oYeah, I did this on purpose. Actually "potentially" in potentially including secrets and sensitive data. hints this.

The only reason for PG to use prefer is to be consistent at PeerDB level. I think users should assume cleartext when they check this option regardless of TLS being possibly negotiated with prefer.

@pfcoperez pfcoperez merged commit 6bca48b into main Jun 23, 2026
18 checks passed
@pfcoperez pfcoperez deleted the CP-707/tls-unification/update-docs branch June 23, 2026 08:45
@mintlify

mintlify Bot commented Jun 23, 2026

Copy link
Copy Markdown

Docs PR opened: ClickHouse/mintlify-docs-dev#245

Added a shared TLS settings section to the Postgres, MySQL, and MongoDB ClickPipes pages, with three new screenshots.

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.

4 participants