Skip to content

Commit 90f7c1e

Browse files
gingerwizardgingerwizard
committed
final border
1 parent 3680224 commit 90f7c1e

File tree

14 files changed

+82
-81
lines changed

14 files changed

+82
-81
lines changed

‎docs/_snippets/_gather_your_details_http.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ To connect to ClickHouse with HTTP(S) you need this information:
1212

1313
The details for your ClickHouse Cloud service are available in the ClickHouse Cloud console. Select the service that you will connect to and click **Connect**:
1414

15-
<Image img={cloud_connect_button} size="md" alt="ClickHouse Cloud service connect button" />
15+
<Image img={cloud_connect_button} size="md" alt="ClickHouse Cloud service connect button" border />
1616

1717
Choose **HTTPS**, and the details are available in an example `curl` command.
1818

19-
<Image img={connection_details_https} size="md" alt="ClickHouse Cloud HTTPS connection details" />
19+
<Image img={connection_details_https} size="md" alt="ClickHouse Cloud HTTPS connection details" border/>
2020

2121
If you are using self-managed ClickHouse, the connection details are set by your ClickHouse administrator.

‎docs/_snippets/_gather_your_details_native.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ To connect to ClickHouse with native TCP you need this information:
1313

1414
The details for your ClickHouse Cloud service are available in the ClickHouse Cloud console. Select the service that you will connect to and click **Connect**:
1515

16-
<Image img={cloud_connect_button} size="md" alt="ClickHouse Cloud service connect button" />
16+
<Image img={cloud_connect_button} size="md" alt="ClickHouse Cloud service connect button" border/>
1717

1818
Choose **Native**, and the details are available in an example `clickhouse-client` command.
1919

20-
<Image img={connection_details_native} size="md" alt="ClickHouse Cloud Native TCP connection details" />
20+
<Image img={connection_details_native} size="md" alt="ClickHouse Cloud Native TCP connection details" border/>
2121

2222
If you are using self-managed ClickHouse, the connection details are set by your ClickHouse administrator.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import Image from '@theme/IdealImage';
2525

2626
[ClickPipes](/integrations/clickpipes) is a managed integration platform that makes ingesting data from a diverse set of sources as simple as clicking a few buttons. Designed for the most demanding workloads, ClickPipes's robust and scalable architecture ensures consistent performance and reliability. ClickPipes can be used for long-term streaming needs or one-time data loading job.
2727

28-
<Image img={clickpipes_stack} alt="ClickPipes stack" size="lg" />
28+
<Image img={clickpipes_stack} alt="ClickPipes stack" size="lg" border/>
2929

3030
## Supported Data Sources {#supported-data-sources}
3131

@@ -67,7 +67,7 @@ Steps:
6767
1. create a custom role `CREATE ROLE my_clickpipes_role SETTINGS ...`. See [CREATE ROLE](/sql-reference/statements/create/role.md) syntax for details.
6868
2. add the custom role to ClickPipes user on step `Details and Settings` during the ClickPipes creation.
6969

70-
<Image img={cp_custom_role} alt="Assign a custom role" size="lg" />
70+
<Image img={cp_custom_role} alt="Assign a custom role" size="lg" border/>
7171

7272
## Error reporting {#error-reporting}
7373
ClickPipes will create a table next to your destination table with the postfix `<destination_table_name>_clickpipes_error`. This table will contain any errors from the operations of your ClickPipe (network, connectivity, etc.) and also any data that don't conform to the schema. The error table has a [TTL](/engines/table-engines/mergetree-family/mergetree#table_engine-mergetree-ttl) of 7 days.

‎docs/integrations/data-ingestion/clickpipes/kafka.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -35,20 +35,20 @@ You have familiarized yourself with the [ClickPipes intro](./index.md).
3535

3636
1. Access the SQL Console for your ClickHouse Cloud Service.
3737

38-
<Image img={cp_service} alt="ClickPipes service" size="lg"/>
38+
<Image img={cp_service} alt="ClickPipes service" size="md" border/>
3939

4040

4141
2. Select the `Data Sources` button on the left-side menu and click on "Set up a ClickPipe"
4242

43-
<Image img={cp_step0} alt="Select imports" size="lg"/>
43+
<Image img={cp_step0} alt="Select imports" size="lg" border/>
4444

4545
3. Select your data source.
4646

47-
<Image img={cp_step1} alt="Select data source type" size="lg"/>
47+
<Image img={cp_step1} alt="Select data source type" size="lg" border/>
4848

4949
4. Fill out the form by providing your ClickPipe with a name, a description (optional), your credentials, and other connection details.
5050

51-
<Image img={cp_step2} alt="Fill out connection details" size="lg"/>
51+
<Image img={cp_step2} alt="Fill out connection details" size="lg" border/>
5252

5353
5. Configure the schema registry. A valid schema is required for Avro streams and optional for JSON. This schema will be used to parse [AvroConfluent](../../../interfaces/formats.md/#data-format-avro-confluent) or validate JSON messages on the selected topic.
5454
- Avro messages that cannot be parsed or JSON messages that fail validation will generate an error.
@@ -63,41 +63,41 @@ without an embedded schema id, then the specific schema ID or subject must be sp
6363

6464
6. Select your topic and the UI will display a sample document from the topic.
6565

66-
<Image img={cp_step3} alt="Set data format and topic" size="lg"/>
66+
<Image img={cp_step3} alt="Set data format and topic" size="lg" border/>
6767

6868
7. In the next step, you can select whether you want to ingest data into a new ClickHouse table or reuse an existing one. Follow the instructions in the screen to modify your table name, schema, and settings. You can see a real-time preview of your changes in the sample table at the top.
6969

70-
<Image img={cp_step4a} alt="Set table, schema, and settings" size="lg"/>
70+
<Image img={cp_step4a} alt="Set table, schema, and settings" size="lg" border/>
7171

7272
You can also customize the advanced settings using the controls provided
7373

74-
<Image img={cp_step4a3} alt="Set advanced controls" size="lg"/>
74+
<Image img={cp_step4a3} alt="Set advanced controls" size="lg" border/>
7575

7676
8. Alternatively, you can decide to ingest your data in an existing ClickHouse table. In that case, the UI will allow you to map fields from the source to the ClickHouse fields in the selected destination table.
7777

78-
<Image img={cp_step4b} alt="Use an existing table" size="lg"/>
78+
<Image img={cp_step4b} alt="Use an existing table" size="lg" border/>
7979

8080
9. Finally, you can configure permissions for the internal ClickPipes user.
8181

8282
**Permissions:** ClickPipes will create a dedicated user for writing data into a destination table. You can select a role for this internal user using a custom role or one of the predefined role:
8383
- `Full access`: with the full access to the cluster. It might be useful if you use Materialized View or Dictionary with the destination table.
8484
- `Only destination table`: with the `INSERT` permissions to the destination table only.
8585

86-
<Image img={cp_step5} alt="Permissions" size="lg"/>
86+
<Image img={cp_step5} alt="Permissions" size="lg" border/>
8787

8888
10. By clicking on "Complete Setup", the system will register you ClickPipe, and you'll be able to see it listed in the summary table.
8989

90-
<Image img={cp_success} alt="Success notice" size="sm"/>
90+
<Image img={cp_success} alt="Success notice" size="sm" border/>
9191

92-
<Image img={cp_remove} alt="Remove notice" size="lg"/>
92+
<Image img={cp_remove} alt="Remove notice" size="lg" border/>
9393

9494
The summary table provides controls to display sample data from the source or the destination table in ClickHouse
9595

96-
<Image img={cp_destination} alt="View destination" size="lg"/>
96+
<Image img={cp_destination} alt="View destination" size="lg" border/>
9797

9898
As well as controls to remove the ClickPipe and display a summary of the ingest job.
9999

100-
<Image img={cp_overview} alt="View overview" size="lg"/>
100+
<Image img={cp_overview} alt="View overview" size="lg" border/>
101101

102102
11. **Congratulations!** you have successfully set up your first ClickPipe. If this is a streaming ClickPipe it will be continuously running, ingesting data in real-time from your remote data source.
103103

‎docs/integrations/data-ingestion/clickpipes/kinesis.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -29,57 +29,57 @@ You have familiarized yourself with the [ClickPipes intro](./index.md) and setup
2929

3030
1. Access the SQL Console for your ClickHouse Cloud Service.
3131

32-
<Image img={cp_service} alt="ClickPipes service" size="lg"/>
32+
<Image img={cp_service} alt="ClickPipes service" size="lg" border/>
3333

3434
2. Select the `Data Sources` button on the left-side menu and click on "Set up a ClickPipe"
3535

36-
<Image img={cp_step0} alt="Select imports" size="lg" />
36+
<Image img={cp_step0} alt="Select imports" size="lg" border/>
3737

3838
3. Select your data source.
3939

40-
<Image img={cp_step1} alt="Select data source type" size="lg" />
40+
<Image img={cp_step1} alt="Select data source type" size="lg" border/>
4141

4242
4. Fill out the form by providing your ClickPipe with a name, a description (optional), your IAM role or credentials, and other connection details.
4343

44-
<Image img={cp_step2_kinesis} alt="Fill out connection details" size="lg" />
44+
<Image img={cp_step2_kinesis} alt="Fill out connection details" size="lg" border/>
4545

4646
5. Select Kinesis Stream and starting offset. The UI will display a sample document from the selected source (Kafka topic, etc). You can also enable Enhanced Fan-out for Kinesis streams to improve the performance and stability of your ClickPipe (More information on Enhanced Fan-out can be found [here](https://aws.amazon.com/blogs/aws/kds-enhanced-fanout))
4747

48-
<Image img={cp_step3_kinesis} alt="Set data format and topic" size="lg" />
48+
<Image img={cp_step3_kinesis} alt="Set data format and topic" size="lg" border/>
4949

5050
6. In the next step, you can select whether you want to ingest data into a new ClickHouse table or reuse an existing one. Follow the instructions in the screen to modify your table name, schema, and settings. You can see a real-time preview of your changes in the sample table at the top.
5151

52-
<Image img={cp_step4a} alt="Set table, schema, and settings" size="lg" />
52+
<Image img={cp_step4a} alt="Set table, schema, and settings" size="lg" border/>
5353

5454
You can also customize the advanced settings using the controls provided
5555

56-
<Image img={cp_step4a3} alt="Set advanced controls" size="lg" />
56+
<Image img={cp_step4a3} alt="Set advanced controls" size="lg" border/>
5757

5858
7. Alternatively, you can decide to ingest your data in an existing ClickHouse table. In that case, the UI will allow you to map fields from the source to the ClickHouse fields in the selected destination table.
5959

60-
<Image img={cp_step4b} alt="Use an existing table" size="lg" />
60+
<Image img={cp_step4b} alt="Use an existing table" size="lg" border/>
6161

6262
8. Finally, you can configure permissions for the internal ClickPipes user.
6363

6464
**Permissions:** ClickPipes will create a dedicated user for writing data into a destination table. You can select a role for this internal user using a custom role or one of the predefined role:
6565
- `Full access`: with the full access to the cluster. It might be useful if you use Materialized View or Dictionary with the destination table.
6666
- `Only destination table`: with the `INSERT` permissions to the destination table only.
6767

68-
<Image img={cp_step5} alt="Permissions" />
68+
<Image img={cp_step5} alt="Permissions" border/>
6969

7070
9. By clicking on "Complete Setup", the system will register you ClickPipe, and you'll be able to see it listed in the summary table.
7171

72-
<Image img={cp_success} alt="Success notice" size="sm" />
72+
<Image img={cp_success} alt="Success notice" size="sm" border/>
7373

74-
<Image img={cp_remove} alt="Remove notice" size="lg" />
74+
<Image img={cp_remove} alt="Remove notice" size="lg" border/>
7575

7676
The summary table provides controls to display sample data from the source or the destination table in ClickHouse
7777

78-
<Image img={cp_destination} alt="View destination" size="lg" />
78+
<Image img={cp_destination} alt="View destination" size="lg" border/>
7979

8080
As well as controls to remove the ClickPipe and display a summary of the ingest job.
8181

82-
<Image img={cp_overview} alt="View overview" size="lg" />
82+
<Image img={cp_overview} alt="View overview" size="lg" border/>
8383

8484
10. **Congratulations!** you have successfully set up your first ClickPipe. If this is a streaming ClickPipe it will be continuously running, ingesting data in real-time from your remote data source. Otherwise it will ingest the batch and complete.
8585

‎docs/integrations/data-ingestion/clickpipes/object-storage.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -32,31 +32,31 @@ You have familiarized yourself with the [ClickPipes intro](./index.md).
3232

3333
1. In the cloud console, select the `Data Sources` button on the left-side menu and click on "Set up a ClickPipe"
3434

35-
<Image img={cp_step0} alt="Select imports" size="lg"/>
35+
<Image img={cp_step0} alt="Select imports" size="lg" border/>
3636

3737
2. Select your data source.
3838

39-
<Image img={cp_step1} alt="Select data source type" size="lg"/>
39+
<Image img={cp_step1} alt="Select data source type" size="lg" border/>
4040

4141
3. Fill out the form by providing your ClickPipe with a name, a description (optional), your IAM role or credentials, and bucket URL. You can specify multiple files using bash-like wildcards. For more information, [see the documentation on using wildcards in path](#limitations).
4242

43-
<Image img={cp_step2_object_storage} alt="Fill out connection details" size="lg"/>
43+
<Image img={cp_step2_object_storage} alt="Fill out connection details" size="lg" border/>
4444

4545
4. The UI will display a list of files in the specified bucket. Select your data format (we currently support a subset of ClickHouse formats) and if you want to enable continuous ingestion [More details below](#continuous-ingest).
4646

47-
<Image img={cp_step3_object_storage} alt="Set data format and topic" size="lg"/>
47+
<Image img={cp_step3_object_storage} alt="Set data format and topic" size="lg" border/>
4848

4949
5. In the next step, you can select whether you want to ingest data into a new ClickHouse table or reuse an existing one. Follow the instructions in the screen to modify your table name, schema, and settings. You can see a real-time preview of your changes in the sample table at the top.
5050

51-
<Image img={cp_step4a} alt="Set table, schema, and settings" size="lg"/>
51+
<Image img={cp_step4a} alt="Set table, schema, and settings" size="lg" border/>
5252

5353
You can also customize the advanced settings using the controls provided
5454

55-
<Image img={cp_step4a3} alt="Set advanced controls" size="lg"/>
55+
<Image img={cp_step4a3} alt="Set advanced controls" size="lg" border/>
5656

5757
6. Alternatively, you can decide to ingest your data in an existing ClickHouse table. In that case, the UI will allow you to map fields from the source to the ClickHouse fields in the selected destination table.
5858

59-
<Image img={cp_step4b} alt="Use an existing table" size="lg"/>
59+
<Image img={cp_step4b} alt="Use an existing table" size="lg" border/>
6060

6161
:::info
6262
You can also map [virtual columns](../../sql-reference/table-functions/s3#virtual-columns), like `_path` or `_size`, to fields.
@@ -68,21 +68,22 @@ You can also map [virtual columns](../../sql-reference/table-functions/s3#virtua
6868
- `Full access`: with the full access to the cluster. Required if you use Materialized View or Dictionary with the destination table.
6969
- `Only destination table`: with the `INSERT` permissions to the destination table only.
7070

71-
<Image img={cp_step5} alt="Permissions" size="lg"/>
71+
<Image img={cp_step5} alt="Permissions" size="lg" border/>
7272

7373
8. By clicking on "Complete Setup", the system will register you ClickPipe, and you'll be able to see it listed in the summary table.
7474

75-
<Image img={cp_success} alt="Success notice" size="sm"/>
75+
<Image img={cp_success} alt="Success notice" size="sm" border/>
7676

77-
<Image img={cp_remove} alt="Remove notice" size="lg"/>
77+
<Image img={cp_remove} alt="Remove notice" size="lg" border/>
7878

7979
The summary table provides controls to display sample data from the source or the destination table in ClickHouse
8080

81-
<Image img={cp_destination} alt="View destination" size="lg"/>
81+
<Image img={cp_destination} alt="View destination" size="lg" border/>
8282

8383
As well as controls to remove the ClickPipe and display a summary of the ingest job.
8484

85-
<Image img={cp_overview} alt="View overview" size="lg"/>
85+
<Image img={cp_overview} alt="View overview" size="lg" border/>
86+
8687
Image
8788
9. **Congratulations!** you have successfully set up your first ClickPipe. If this is a streaming ClickPipe it will be continuously running, ingesting data in real-time from your remote data source. Otherwise it will ingest the batch and complete.
8889

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -62,15 +62,15 @@ Make sure you are logged in to your ClickHouse Cloud account. If you don't have
6262
[//]: # ( TODO update image here)
6363
1. In the ClickHouse Cloud Console, navigate to your ClickHouse Cloud Service.
6464

65-
<Image img={cp_service} alt="ClickPipes service" size="lg"/>
65+
<Image img={cp_service} alt="ClickPipes service" size="lg" border/>
6666

6767
2. Select the `Data Sources` button on the left-side menu and click on "Set up a ClickPipe"
6868

69-
<Image img={cp_step0} alt="Select imports" size="lg"/>
69+
<Image img={cp_step0} alt="Select imports" size="lg" border/>
7070

7171
3. Select the `Postgres CDC` tile
7272

73-
<Image img={postgres_tile} alt="Select Postgres" size="lg"/>
73+
<Image img={postgres_tile} alt="Select Postgres" size="lg" border/>
7474

7575
### Adding your source Postgres database connection {#adding-your-source-postgres-database-connection}
7676

@@ -83,7 +83,7 @@ Make sure you are logged in to your ClickHouse Cloud account. If you don't have
8383

8484
:::
8585

86-
<Image img={postgres_connection_details} alt="Fill in connection details" size="lg"/>
86+
<Image img={postgres_connection_details} alt="Fill in connection details" size="lg" border/>
8787

8888
#### (Optional) Setting up SSH Tunneling {#optional-setting-up-ssh-tunneling}
8989

@@ -93,7 +93,7 @@ You can specify SSH tunneling details if your source Postgres database is not pu
9393
1. Enable the "Use SSH Tunnelling" toggle.
9494
2. Fill in the SSH connection details.
9595

96-
<Image img={ssh_tunnel} alt="SSH tunneling" size="lg"/>
96+
<Image img={ssh_tunnel} alt="SSH tunneling" size="lg" border/>
9797

9898
3. To use Key-based authentication, click on "Revoke and generate key pair" to generate a new key pair and copy the generated public key to your SSH server under `~/.ssh/authorized_keys`.
9999
4. Click on "Verify Connection" to verify the connection.
@@ -110,7 +110,7 @@ Once the connection details are filled in, click on "Next".
110110

111111
5. Make sure to select the replication slot from the dropdown list you created in the prerequisites step.
112112

113-
<Image img={select_replication_slot} alt="Select replication slot" size="lg"/>
113+
<Image img={select_replication_slot} alt="Select replication slot" size="lg" border/>
114114

115115
#### Advanced Settings {#advanced-settings}
116116

@@ -127,7 +127,7 @@ You can configure the Advanced settings if needed. A brief description of each s
127127

128128
6. Here you can select the destination database for your ClickPipe. You can either select an existing database or create a new one.
129129

130-
<Image img={select_destination_db} alt="Select destination database" size="lg"/>
130+
<Image img={select_destination_db} alt="Select destination database" size="lg" border/>
131131

132132
7. You can select the tables you want to replicate from the source Postgres database. While selecting the tables, you can also choose to rename the tables in the destination ClickHouse database as well as exclude specific columns.
133133

@@ -141,7 +141,7 @@ You can configure the Advanced settings if needed. A brief description of each s
141141

142142
8. Select the "Full access" role from the permissions dropdown and click "Complete Setup".
143143

144-
<Image img={ch_permissions} alt="Review permissions" size="lg"/>
144+
<Image img={ch_permissions} alt="Review permissions" size="lg" border/>
145145

146146
## What's next? {#whats-next}
147147

‎docs/integrations/data-ingestion/clickpipes/postgres/source/azure-flexible-server-postgres.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ ClickPipes supports Postgres version 12 and later.
2121

2222
1. Click on the **Server parameters** section
2323

24-
<Image img={server_parameters} alt="Server Parameters in Azure Flexible Server for Postgres" size="lg"/>
24+
<Image img={server_parameters} alt="Server Parameters in Azure Flexible Server for Postgres" size="lg" border/>
2525

2626
2. Edit the `wal_level` to `logical`
2727

28-
<Image img={wal_level} alt="Change wal_level to logical in Azure Flexible Server for Postgres" size="lg"/>
28+
<Image img={wal_level} alt="Change wal_level to logical in Azure Flexible Server for Postgres" size="lg" border/>
2929

3030
3. This change would require a server restart. So restart when requested.
3131

32-
<Image img={restart} alt="Restart server after changing wal_level" size="lg"/>
32+
<Image img={restart} alt="Restart server after changing wal_level" size="lg" border/>
3333

3434
## Creating ClickPipes User and Granting permissions {#creating-clickpipes-user-and-granting-permissions}
3535

0 commit comments

Comments
 (0)