diff --git a/docs/_snippets/clickpipes/_changing_tls_settings.md b/docs/_snippets/clickpipes/_changing_tls_settings.md new file mode 100644 index 00000000000..6e7c3e21341 --- /dev/null +++ b/docs/_snippets/clickpipes/_changing_tls_settings.md @@ -0,0 +1,21 @@ +import tls_settings from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/tls-settings.png'; +import pipe_connection_settings from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/pipe-connection-settings.png'; +import pipe_edit_connection from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/pipe-edit-connection.png'; +import Image from '@theme/IdealImage'; + +By default, your ClickPipe will be created with TLS enabled and certificate verification. These defaults can be modified upon ClickPipe creation: + +TLS settings + +Or edited at the _Connection settings_ section of your paused ClickPipe _Settings_ tab: + +Connection settings -> Edit Connection + +Edit Connection + +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. +- `Skip certificate verification` toggles on or off the verification of the certificate presented by the source database. Take into consideration the security implications of skipping certificate verification. +- `TLS Host` (optional, defaults to the source _Host_) is the hostname the certificate's CN must match when certificate verification is enabled. +- `Upload CA` can be used to provide a CA used when certificate verification is enabled. diff --git a/docs/integrations/data-ingestion/clickpipes/mongodb/index.md b/docs/integrations/data-ingestion/clickpipes/mongodb/index.md index eaa2e5253eb..eec4726d813 100644 --- a/docs/integrations/data-ingestion/clickpipes/mongodb/index.md +++ b/docs/integrations/data-ingestion/clickpipes/mongodb/index.md @@ -19,6 +19,7 @@ import select_destination_db from '@site/static/images/integrations/data-ingesti import ch_permissions from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/ch-permissions.jpg' import Image from '@theme/IdealImage'; import ssh_tunnel from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/ssh-tunnel.jpg' +import ChangingTLSSettings from '@site/docs/_snippets/clickpipes/_changing_tls_settings.md'; @@ -73,6 +74,10 @@ Make sure you're logged in to your ClickHouse Cloud account. If you don't have a Fill in connection details +#### (Optional) Changing TLS settings {#optional-changing-tls-settings} + + + #### (Optional) Set up SSH Tunneling {#optional-set-up-ssh-tunneling} You can specify SSH tunneling details if your source MongoDB database isn't publicly accessible. diff --git a/docs/integrations/data-ingestion/clickpipes/mysql/index.md b/docs/integrations/data-ingestion/clickpipes/mysql/index.md index c27038fc847..3e5f92a1bbb 100644 --- a/docs/integrations/data-ingestion/clickpipes/mysql/index.md +++ b/docs/integrations/data-ingestion/clickpipes/mysql/index.md @@ -25,6 +25,7 @@ import ssh_tunnel from '@site/static/images/integrations/data-ingestion/clickpip import select_destination_db from '@site/static/images/integrations/data-ingestion/clickpipes/mysql/select-destination-db.png' import ch_permissions from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/ch-permissions.jpg' import Image from '@theme/IdealImage'; +import ChangingTLSSettings from '@site/docs/_snippets/clickpipes/_changing_tls_settings.md'; @@ -84,6 +85,10 @@ Make sure you're logged in to your ClickHouse Cloud account. If you don't have a Fill in connection details +#### (Optional) Changing TLS settings {#optional-changing-tls-settings} + + + #### (Optional) Set up SSH Tunneling {#optional-set-up-ssh-tunneling} You can specify SSH tunneling details if your source MySQL database isn't publicly accessible. diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/index.md b/docs/integrations/data-ingestion/clickpipes/postgres/index.md index eb110592155..5eb042a8cdf 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/index.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/index.md @@ -20,6 +20,7 @@ import select_replication_slot from '@site/static/images/integrations/data-inges import select_destination_db from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/select-destination-db.jpg' import ch_permissions from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/ch-permissions.jpg' import Image from '@theme/IdealImage'; +import ChangingTLSSettings from '@site/docs/_snippets/clickpipes/_changing_tls_settings.md'; You can use ClickPipes to ingest data from your source Postgres database into ClickHouse Cloud. The source Postgres database can be hosted on-premises or in the cloud including Amazon RDS, Google Cloud SQL, Azure Database for Postgres, Supabase and others. @@ -91,6 +92,10 @@ You can use AWS Private Link to connect to your source Postgres database if it i want to keep your data transfer private. You can follow the [setup guide to set up the connection](/integrations/clickpipes/aws-privatelink). +#### (Optional) Changing TLS settings {#optional-changing-tls-settings} + + + #### (Optional) Setting up SSH tunneling {#optional-setting-up-ssh-tunneling} You can specify SSH tunneling details if your source Postgres database isn't publicly accessible. diff --git a/static/images/integrations/data-ingestion/clickpipes/postgres/pipe-connection-settings.png b/static/images/integrations/data-ingestion/clickpipes/postgres/pipe-connection-settings.png new file mode 100644 index 00000000000..0b596f18a0f Binary files /dev/null and b/static/images/integrations/data-ingestion/clickpipes/postgres/pipe-connection-settings.png differ diff --git a/static/images/integrations/data-ingestion/clickpipes/postgres/pipe-edit-connection.png b/static/images/integrations/data-ingestion/clickpipes/postgres/pipe-edit-connection.png new file mode 100644 index 00000000000..b50a6f760c8 Binary files /dev/null and b/static/images/integrations/data-ingestion/clickpipes/postgres/pipe-edit-connection.png differ diff --git a/static/images/integrations/data-ingestion/clickpipes/postgres/tls-settings.png b/static/images/integrations/data-ingestion/clickpipes/postgres/tls-settings.png new file mode 100644 index 00000000000..7fb0f8605ba Binary files /dev/null and b/static/images/integrations/data-ingestion/clickpipes/postgres/tls-settings.png differ