Merge pull request #4160 from ClickHouse/Blargian-patch-72

Image fix

Author: Blargian

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

@@ -9,6 +9,7 @@ import edit_sync_button from '@site/static/images/integrations/data-ingestion/cl
 import create_sync_settings from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/create_sync_settings.png'
 import edit_sync_settings from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/sync_settings_edit.png'
 import cdc_syncs from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/cdc_syncs.png'
+import Image from '@theme/IdealImage';
 
 This document describes how to control the sync of a database ClickPipe (Postgres, MySQL etc.) when the ClickPipe is in **CDC (Running) mode**.
 
@@ -19,32 +20,40 @@ Database ClickPipes have an architecture that consists of two parallel processes
 There are two main ways to control the sync of a database ClickPipe. The ClickPipe will start pushing when one of the below settings kicks in.
 
 ### Sync interval {#interval-mysql-sync}
+
 The sync interval of the pipe is the amount of time (in seconds) for which the ClickPipe will pull records from the source database. The time to push what we have to ClickHouse is not included in this interval.
 
 The default is **1 minute**.
 Sync interval can be set to any positive integer value, but it is recommended to keep it above 10 seconds.
 
 ### Pull batch size {#batch-size-mysql-sync}
+
 The pull batch size is the number of records that the ClickPipe will pull from the source database in one batch. Records mean inserts, updates and deletes done on the tables that are part of the pipe.
 
 The default is **100,000** records.
 A safe maximum is 10 million.
 
 ### An exception: Long-running transactions on source {#transactions-pg-sync}
+
 When a transaction is run on the source database, the ClickPipe waits until it receives the COMMIT of the transaction before it moves forward. This with **overrides** both the sync interval and the pull batch size.
 
 ### Configuring sync settings {#configuring-mysql-sync}
+
 You can set the sync interval and pull batch size when you create a ClickPipe or edit an existing one.
 When creating a ClickPipe it will be seen in the second step of the creation wizard, as shown below:
-<img src={create_sync_settings} alt="Create sync settings" />
+
+<Image img={create_sync_settings} alt="Create sync settings" size="md"/>
 
 When editing an existing ClickPipe, you can head over to the **Settings** tab of the pipe, pause the pipe and then click on **Configure** here:
-<img src={edit_sync_button} alt="Edit sync button" />
+
+<Image img={edit_sync_button} alt="Edit sync button" size="md"/>
 
 This will open a flyout with the sync settings, where you can change the sync interval and pull batch size:
-<img src={edit_sync_settings} alt="Edit sync settings" />
+
+<Image img={edit_sync_settings} alt="Edit sync settings" size="md"/>
 
 ### Monitoring sync control behaviour {#monitoring-mysql-sync}
+
 You can see how long each batch takes in the **CDC Syncs** table in the **Metrics** tab of the ClickPipe. Note that the duration here includes push time and also if there are no rows incoming, the ClickPipe waits and the wait time is also included in the duration.
 
-<img src={cdc_syncs} alt="CDC Syncs table" />
+<Image img={cdc_syncs} alt="CDC Syncs table" size="md"/>

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

@@ -7,6 +7,7 @@ sidebar_label: 'How parallel snapshot works'
 
 import snapshot_params from '@site/static/images/integrations/data-ingestion/clickpipes/mysql/snapshot_params.png'
 import partition_key from '@site/static/images/integrations/data-ingestion/clickpipes/mysql/partition_key.png'
+import Image from '@theme/IdealImage';
 
 This document explains parallelized snapshot/initial load in the MySQL ClickPipe works and talks about the snapshot parameters that can be used to control it.
 
@@ -18,7 +19,7 @@ However, the MySQL ClickPipe can parallelize this process, which can significant
 ### Partition key column {#key-mysql-snapshot}
 
 Once we've enabled the feature flag, you should see the below setting in the ClickPipe table picker (both during creation and editing of a ClickPipe):
-<img src={partition_key} alt="Partition key column" />
+<Image img={partition_key} alt="Partition key column" size="md"/>
 
 The MySQL ClickPipe uses a column on your source table to logically partition the source tables. This column is called the **partition key column**. It is used to divide the source table into partitions, which can then be processed in parallel by the ClickPipe.
 
@@ -30,7 +31,7 @@ The partition key column must be indexed in the source table to see a good perfo
 
 Let's talk about the below settings:
 
-<img src={snapshot_params} alt="Snapshot parameters" />
+<Image img={snapshot_params} alt="Snapshot parameters" size="md"/>
 
 #### Snapshot number of rows per partition {#numrows-mysql-snapshot}
 This setting controls how many rows constitute a partition. The ClickPipe will read the source table in chunks of this size, and chunks will be processed in parallel based on the initial load parallelism set. The default value is 100,000 rows per partition.

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

@@ -19,31 +19,26 @@ There are scenarios where it would be useful to pause a MySQL ClickPipe. For exa
 1. In the Data Sources tab, click on the MySQL ClickPipe you wish to pause.
 2. Head over to the **Settings** tab.
 3. Click on the **Pause** button.
-<br/>
 
 <Image img={pause_button} border size="md"/>
 
 4. A dialog box should appear for confirmation. Click on Pause again.
-<br/>
 
 <Image img={pause_dialog} border size="md"/>
 
 4. Head over to the **Metrics** tab.
 5. In around 5 seconds (and also on page refresh), the status of the pipe should be **Paused**.
-<br/>
 
 <Image img={pause_status} border size="md"/>
 
 ## Steps to resume a MySQL ClickPipe {#resume-clickpipe-steps}
 1. In the Data Sources tab, click on the MySQL ClickPipe you wish to resume. The status of the mirror should be **Paused** initially.
 2. Head over to the **Settings** tab.
 3. Click on the **Resume** button.
-<br/>
 
 <Image img={resume_button} border size="md"/>
 
 4. A dialog box should appear for confirmation. Click on Resume again.
-<br/>
 
 <Image img={resume_dialog} border size="md"/>
 

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

@@ -6,10 +6,12 @@ sidebar_label: 'Resync ClickPipe'
 ---
 
 import resync_button from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/resync_button.png'
+import Image from '@theme/IdealImage';
 
 ### What does Resync do? {#what-mysql-resync-do}
 
 Resync involves the following operations in order:
+
 1. The existing ClickPipe is dropped, and a new "resync" ClickPipe is kicked off. Thus, changes to source table structures will be picked up when you resync.
 2. The resync ClickPipe creates (or replaces) a new set of destination tables which have the same names as the original tables except with a `_resync` suffix.
 3. Initial load is performed on the `_resync` tables.
@@ -18,6 +20,7 @@ Resync involves the following operations in order:
 All the settings of the original ClickPipe are retained in the resync ClickPipe. The statistics of the original ClickPipe are cleared in the UI.
 
 ### Use cases for resyncing a ClickPipe {#use-cases-mysql-resync}
+
 Here are a few scenarios:
 
 1. You may need to perform major schema changes on the source tables which would break the existing ClickPipe and you would need to restart. You can just click Resync after performing the changes.
@@ -29,13 +32,14 @@ since initial load with parallel threads is involved each time.
 :::
 
 ### Resync ClickPipe Guide {#guide-mysql-resync}
+
 1. In the Data Sources tab, click on the MySQL ClickPipe you wish to resync.
 2. Head over to the **Settings** tab.
 3. Click on the **Resync** button.
-<br/>
-<img img={resync_button} border size="md"/>
+
+<Image img={resync_button} border size="md"/>
+
 4. A dialog box should appear for confirmation. Click on Resync again.
-<br/>
 5. Head over to the **Metrics** tab.
 6. In around 5 seconds (and also on page refresh), the status of the pipe should be **Setup** or **Snapshot**.
 7. The initial load of the resync can be monitored in the **Tables** tab - in the **Initial Load Stats** section.

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

@@ -9,6 +9,7 @@ import edit_sync_button from '@site/static/images/integrations/data-ingestion/cl
 import create_sync_settings from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/create_sync_settings.png'
 import edit_sync_settings from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/sync_settings_edit.png'
 import cdc_syncs from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/cdc_syncs.png'
+import Image from '@theme/IdealImage';
 
 This document describes how to control the sync of a database ClickPipe (Postgres, MySQL etc.) when the ClickPipe is in **CDC (Running) mode**.
 
@@ -19,37 +20,45 @@ Database ClickPipes have an architecture that consists of two parallel processes
 There are two main ways to control the sync of a database ClickPipe. The ClickPipe will start pushing when one of the below settings kicks in.
 
 ### Sync interval {#interval-pg-sync}
+
 The sync interval of the pipe is the amount of time (in seconds) for which the ClickPipe will pull records from the source database. The time to push what we have to ClickHouse is not included in this interval.
 
 The default is **1 minute**.
 Sync interval can be set to any positive integer value, but it is recommended to keep it above 10 seconds.
 
 ### Pull batch size {#batch-size-pg-sync}
+
 The pull batch size is the number of records that the ClickPipe will pull from the source database in one batch. Records mean inserts, updates and deletes done on the tables that are part of the pipe.
 
 The default is **100,000** records.
 A safe maximum is 10 million.
 
 ### An exception: Long-running transactions on source {#transactions-pg-sync}
+
 When a transaction is run on the source database, the ClickPipe waits until it receives the COMMIT of the transaction before it moves forward. This with **overrides** both the sync interval and the pull batch size.
 
 ### Configuring sync settings {#configuring-pg-sync}
+
 You can set the sync interval and pull batch size when you create a ClickPipe or edit an existing one.
 When creating a ClickPipe it will be seen in the second step of the creation wizard, as shown below:
-<img src={create_sync_settings} alt="Create sync settings" />
+
+<Image img={create_sync_settings} alt="Create sync settings" size="md"/>
 
 When editing an existing ClickPipe, you can head over to the **Settings** tab of the pipe, pause the pipe and then click on **Configure** here:
-<img src={edit_sync_button} alt="Edit sync button" />
+
+<Image img={edit_sync_button} alt="Edit sync button" size="md"/>
 
 This will open a flyout with the sync settings, where you can change the sync interval and pull batch size:
-<img src={edit_sync_settings} alt="Edit sync settings" />
+
+<Image img={edit_sync_settings} alt="Edit sync settings" size="md"/>
 
 ### Tweaking the sync settings to help with replication slot growth {#tweaking-pg-sync}
+
 Let's talk about how to use these settings to handle a large replication slot of a CDC pipe.
 The pushing time to ClickHouse does not scale linearly with the pulling time from the source database. This can be leveraged to reduce the size of a large replication slot.
 By increasing both the sync interval and pull batch size, the ClickPipe will pull a whole lot of data from the source database in one go, and then push it to ClickHouse.
 
 ### Monitoring sync control behaviour {#monitoring-pg-sync}
 You can see how long each batch takes in the **CDC Syncs** table in the **Metrics** tab of the ClickPipe. Note that the duration here includes push time and also if there are no rows incoming, the ClickPipe waits and the wait time is also included in the duration.
 
-<img src={cdc_syncs} alt="CDC Syncs table" />
+<Image img={cdc_syncs} alt="CDC Syncs table" size="md"/>

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

@@ -6,6 +6,7 @@ sidebar_label: 'How parallel snapshot works'
 ---
 
 import snapshot_params from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/snapshot_params.png'
+import Image from '@theme/IdealImage';
 
 This document explains parallelized snapshot/initial load in the Postgres ClickPipe works and talks about the snapshot parameters that can be used to control it.
 
@@ -22,20 +23,25 @@ The Postgres ClickPipe uses the CTID column to logically partition source tables
 
 Let's talk about the below settings:
 
-<img src={snapshot_params} alt="Snapshot parameters" />
+<Image img={snapshot_params} alt="Snapshot parameters" size="md"/>
 
 #### Snapshot number of rows per partition {#numrows-pg-snapshot}
+
 This setting controls how many rows constitute a partition. The ClickPipe will read the source table in chunks of this size, and  chunks will be processed in parallel based on the initial load parallelism set. The default value is 100,000 rows per partition.
 
 #### Initial load parallelism {#parallelism-pg-snapshot}
+
 This setting controls how many partitions will be processed in parallel. The default value is 4, which means that the ClickPipe will read 4 partitions of the source table in parallel. This can be increased to speed up the initial load, but it is recommended to keep it to a reasonable value depending on your source instance specs to avoid overwhelming the source database. The ClickPipe will automatically adjust the number of partitions based on the size of the source table and the number of rows per partition.
 
 #### Snapshot number of tables in parallel {#tables-parallel-pg-snapshot}
+
 Not really related to parallel snapshot, but this setting controls how many tables will be processed in parallel during the initial load. The default value is 1. Note that is on top of the parallelism of the partitions, so if you have 4 partitions and 2 tables, the ClickPipe will read 8 partitions in parallel.
 
 ### Monitoring parallel snapshot in Postgres {#monitoring-parallel-pg-snapshot}
+
 You can analyze **pg_stat_activity** to see the parallel snapshot in action. The ClickPipe will create multiple connections to the source database, each reading a different partition of the source table. If you see **FETCH** queries with different CTID ranges, it means that the ClickPipe is reading the source tables. You can also see the COUNT(*) and the partitioning query in here.
 
 ### Limitations {#limitations-parallel-pg-snapshot}
+
 - The snapshot parameters cannot be edited after pipe creation. If you want to change them, you will have to create a new ClickPipe.
 - When adding tables to an existing ClickPipe, you cannot change the snapshot parameters. The ClickPipe will use the existing parameters for the new tables.

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

@@ -19,37 +19,30 @@ There are scenarios where it would be useful to pause a Postgres ClickPipe. For
 1. In the Data Sources tab, click on the Postgres ClickPipe you wish to pause.
 2. Head over to the **Settings** tab.
 3. Click on the **Pause** button.
-<br/>
 
 <Image img={pause_button} border size="md"/>
 
 4. A dialog box should appear for confirmation. Click on Pause again.
-<br/>
 
 <Image img={pause_dialog} border size="md"/>
 
 4. Head over to the **Metrics** tab.
 5. In around 5 seconds (and also on page refresh), the status of the pipe should be **Paused**.
-<br/>
 
 :::warning
 Pausing a Postgres ClickPipe will not pause the growth of replication slots.
 :::
 
-<br/>
-
 <Image img={pause_status} border size="md"/>
 
 ## Steps to resume a Postgres ClickPipe {#resume-clickpipe-steps}
 1. In the Data Sources tab, click on the Postgres ClickPipe you wish to resume. The status of the mirror should be **Paused** initially.
 2. Head over to the **Settings** tab.
 3. Click on the **Resume** button.
-<br/>
 
 <Image img={resume_button} border size="md"/>
 
 4. A dialog box should appear for confirmation. Click on Resume again.
-<br/>
 
 <Image img={resume_dialog} border size="md"/>
 

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

@@ -6,6 +6,7 @@ sidebar_label: 'Resync ClickPipe'
 ---
 
 import resync_button from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/resync_button.png'
+import Image from '@theme/IdealImage';
 
 ### What does Resync do? {#what-postgres-resync-do}
 
@@ -18,6 +19,7 @@ Resync involves the following operations in order:
 All the settings of the original ClickPipe are retained in the resync ClickPipe. The statistics of the original ClickPipe are cleared in the UI.
 
 ### Use cases for resyncing a ClickPipe {#use-cases-postgres-resync}
+
 Here are a few scenarios:
 
 1. You may need to perform major schema changes on the source tables which would break the existing ClickPipe and you would need to restart. You can just click Resync after performing the changes.
@@ -30,13 +32,14 @@ since initial load with parallel threads is involved each time.
 :::
 
 ### Resync ClickPipe Guide {#guide-postgres-resync}
+
 1. In the Data Sources tab, click on the Postgres ClickPipe you wish to resync.
 2. Head over to the **Settings** tab.
 3. Click on the **Resync** button.
-<br/>
-<img img={resync_button} border size="md"/>
+
+<Image img={resync_button} border size="md"/>
+
 4. A dialog box should appear for confirmation. Click on Resync again.
-<br/>
 5. Head over to the **Metrics** tab.
 6. In around 5 seconds (and also on page refresh), the status of the pipe should be **Setup** or **Snapshot**.
 7. The initial load of the resync can be monitored in the **Tables** tab - in the **Initial Load Stats** section.