Skip to content

Commit ec5fa3a

Browse files
committed
PR Comments: Share common content using snippets
1 parent 9787369 commit ec5fa3a

4 files changed

Lines changed: 27 additions & 57 deletions

File tree

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
import tls_settings from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/tls-settings.png';
2+
import pipe_connection_settings from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/pipe-connection-settings.png';
3+
import pipe_edit_connection from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/pipe-edit-connection.png';
4+
import Image from '@theme/IdealImage';
5+
6+
By default, your ClickPipe will be created with TLS enabled and certificate verification. These defaults can be modified upon ClickPipe creation:
7+
8+
<Image img={tls_settings} alt="TLS settings" size="lg" border/>
9+
10+
Or edited at the _Connection settings_ section of your paused ClickPipe _Settings_ tab:
11+
12+
<Image img={pipe_connection_settings} alt="Connection settings -> Edit Connection" size="lg" border/>
13+
14+
<Image img={pipe_edit_connection} alt="Edit Connection" size="lg" border/>
15+
16+
Where:
17+
18+
- `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.
19+
- `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.
20+
- `TLS Host` (optional, defaults to the source _Host_) is the hostname the certificate's CN must match when certificate verification is enabled.
21+
- `Upload CA` can be used to provide a CA used when certificate verification is enabled.

docs/integrations/data-ingestion/clickpipes/mongodb/index.md

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,11 @@ import cp_service from '@site/static/images/integrations/data-ingestion/clickpip
1515
import cp_step0 from '@site/static/images/integrations/data-ingestion/clickpipes/cp_step0.png';
1616
import mongodb_tile from '@site/static/images/integrations/data-ingestion/clickpipes/mongodb/mongodb-tile.png'
1717
import mongodb_connection_details from '@site/static/images/integrations/data-ingestion/clickpipes/mongodb/mongodb-connection-details.png'
18-
import tls_settings from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/tls-settings.png'
19-
import pipe_connection_settings from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/pipe-connection-settings.png'
20-
import pipe_edit_connection from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/pipe-edit-connection.png'
2118
import select_destination_db from '@site/static/images/integrations/data-ingestion/clickpipes/mongodb/select-destination-db.png'
2219
import ch_permissions from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/ch-permissions.jpg'
2320
import Image from '@theme/IdealImage';
2421
import ssh_tunnel from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/ssh-tunnel.jpg'
22+
import ChangingTLSSettings from '@site/docs/_snippets/clickpipes/_changing_tls_settings.md';
2523

2624
<BetaBadge/>
2725

@@ -78,22 +76,7 @@ Make sure you're logged in to your ClickHouse Cloud account. If you don't have a
7876

7977
#### (Optional) Changing TLS settings {#optional-changing-tls-settings}
8078

81-
By default, your ClickPipe will be created with TLS enabled and certificate verification. These defaults can be modified upon ClickPipe creation:
82-
83-
<Image img={tls_settings} alt="TLS settings" size="lg" border/>
84-
85-
Or edited at the _Connection settings_ section of your paused ClickPipe _Settings_ tab:
86-
87-
<Image img={pipe_connection_settings} alt="Connection settings -> Edit Connection" size="lg" border/>
88-
89-
<Image img={pipe_edit_connection} alt="Edit Connection" size="lg" border/>
90-
91-
Where:
92-
93-
- `Disable TLS` toggles TLS for the connection on or off. This means data is sent as plaintext over the network, potentially including secrets and sensitive data.
94-
- `Skip certificate verification` toggles on and off the verification of the certificate presented by the source MongoDB database. Take into consideration the security implications of skipping certificate verification.
95-
- `TLS Host` (optional, defaults to the source _Host_) is the hostname the certificate's CN must match when certificate verification is enabled.
96-
- `Upload CA` can be used to provide a CA used when certificate verification is enabled.
79+
<ChangingTLSSettings/>
9780

9881
#### (Optional) Set up SSH Tunneling {#optional-set-up-ssh-tunneling}
9982

docs/integrations/data-ingestion/clickpipes/mysql/index.md

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,11 @@ import cp_service from '@site/static/images/integrations/data-ingestion/clickpip
2121
import cp_step0 from '@site/static/images/integrations/data-ingestion/clickpipes/cp_step0.png';
2222
import mysql_tile from '@site/static/images/integrations/data-ingestion/clickpipes/mysql/mysql-tile.png'
2323
import mysql_connection_details from '@site/static/images/integrations/data-ingestion/clickpipes/mysql/mysql-connection-details.png'
24-
import tls_settings from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/tls-settings.png'
25-
import pipe_connection_settings from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/pipe-connection-settings.png'
26-
import pipe_edit_connection from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/pipe-edit-connection.png'
2724
import ssh_tunnel from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/ssh-tunnel.jpg'
2825
import select_destination_db from '@site/static/images/integrations/data-ingestion/clickpipes/mysql/select-destination-db.png'
2926
import ch_permissions from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/ch-permissions.jpg'
3027
import Image from '@theme/IdealImage';
28+
import ChangingTLSSettings from '@site/docs/_snippets/clickpipes/_changing_tls_settings.md';
3129

3230
<BetaBadge/>
3331

@@ -89,22 +87,7 @@ Make sure you're logged in to your ClickHouse Cloud account. If you don't have a
8987

9088
#### (Optional) Changing TLS settings {#optional-changing-tls-settings}
9189

92-
By default, your ClickPipe will be created with TLS enabled and certificate verification. These defaults can be modified upon ClickPipe creation:
93-
94-
<Image img={tls_settings} alt="TLS settings" size="lg" border/>
95-
96-
Or edited at the _Connection settings_ section of your paused ClickPipe _Settings_ tab:
97-
98-
<Image img={pipe_connection_settings} alt="Connection settings -> Edit Connection" size="lg" border/>
99-
100-
<Image img={pipe_edit_connection} alt="Edit Connection" size="lg" border/>
101-
102-
Where:
103-
104-
- `Disable TLS` toggles TLS for the connection on or off. This means data is sent as plaintext over the network, potentially including secrets and sensitive data.
105-
- `Skip certificate verification` toggles on and off the verification of the certificate presented by the source MySQL database. Take into consideration the security implications of skipping certificate verification.
106-
- `TLS Host` (optional, defaults to the source _Host_) is the hostname the certificate's CN must match when certificate verification is enabled.
107-
- `Upload CA` can be used to provide a CA used when certificate verification is enabled.
90+
<ChangingTLSSettings/>
10891

10992
#### (Optional) Set up SSH Tunneling {#optional-set-up-ssh-tunneling}
11093

docs/integrations/data-ingestion/clickpipes/postgres/index.md

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,12 @@ import cp_service from '@site/static/images/integrations/data-ingestion/clickpip
1515
import cp_step0 from '@site/static/images/integrations/data-ingestion/clickpipes/cp_step0.png';
1616
import postgres_tile from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/postgres-tile.png'
1717
import postgres_connection_details from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/postgres-connection-details.jpg'
18-
import tls_settings from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/tls-settings.png'
19-
import pipe_connection_settings from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/pipe-connection-settings.png'
20-
import pipe_edit_connection from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/pipe-edit-connection.png'
2118
import ssh_tunnel from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/ssh-tunnel.jpg'
2219
import select_replication_slot from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/select-replication-slot.jpg'
2320
import select_destination_db from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/select-destination-db.jpg'
2421
import ch_permissions from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/ch-permissions.jpg'
2522
import Image from '@theme/IdealImage';
23+
import ChangingTLSSettings from '@site/docs/_snippets/clickpipes/_changing_tls_settings.md';
2624

2725
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.
2826

@@ -96,22 +94,7 @@ You can follow the [setup guide to set up the connection](/integrations/clickpip
9694

9795
#### (Optional) Changing TLS settings {#optional-changing-tls-settings}
9896

99-
By default, your ClickPipe will be created with TLS enabled and certificate verification. These defaults can be modified upon ClickPipe creation:
100-
101-
<Image img={tls_settings} alt="TLS settings" size="lg" border/>
102-
103-
Or edited at the _Connection settings_ section of your paused ClickPipe _Settings_ tab:
104-
105-
<Image img={pipe_connection_settings} alt="Connection settings -> Edit Connection" size="lg" border/>
106-
107-
<Image img={pipe_edit_connection} alt="Edit Connection" size="lg" border/>
108-
109-
Where:
110-
111-
- `Disable TLS` (defaults to on) 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.
112-
- `Skip certificate verification` (defaults to off) toggles on or off the verification of the certificate presented by the source database. Take into consideration the security implications of skipping certificate verification.
113-
- `TLS Host` (optional, defaults to the source _Host_) is the hostname the certificate's CN must match when certificate verification is enabled.
114-
- `Upload CA` can be used to provide a CA used when certificate verification is enabled.
97+
<ChangingTLSSettings/>
11598

11699
#### (Optional) Setting up SSH tunneling {#optional-setting-up-ssh-tunneling}
117100

0 commit comments

Comments
 (0)