Skip to content

Commit 1cbcde5

Browse files
committed
snippets and remaining data visualizations
1 parent c1eb215 commit 1cbcde5

26 files changed

+237
-263
lines changed

docs/_snippets/_GCS_authentication_and_bucket.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,46 +6,47 @@ import GCS_create_service_account_a from '@site/static/images/integrations/data-
66
import GCS_create_service_account_2 from '@site/static/images/integrations/data-ingestion/s3/GCS-create-service-account-2.png';
77
import GCS_create_service_account_3 from '@site/static/images/integrations/data-ingestion/s3/GCS-create-service-account-3.png';
88
import GCS_guide_key from '@site/static/images/integrations/data-ingestion/s3/GCS-guide-key.png';
9+
import Image from '@theme/IdealImage';
910

1011
<details>
1112
<summary>Create GCS buckets and an HMAC key</summary>
1213

1314
### ch_bucket_us_east1 {#ch_bucket_us_east1}
1415

15-
<img src={GCS_bucket_1} alt="Creating a GCS bucket in US East 1" />
16+
<Image size="md" img={GCS_bucket_1} alt="Creating a GCS bucket in US East 1" border />
1617

1718
### ch_bucket_us_east4 {#ch_bucket_us_east4}
1819

19-
<img src={GCS_bucket_2} alt="Creating a GCS bucket in US East 4" />
20+
<Image size="md" img={GCS_bucket_2} alt="Creating a GCS bucket in US East 4" border />
2021

2122
### Generate an Access key {#generate-an-access-key}
2223

2324
### Create a service account HMAC key and secret {#create-a-service-account-hmac-key-and-secret}
2425

2526
Open **Cloud Storage > Settings > Interoperability** and either choose an existing **Access key**, or **CREATE A KEY FOR A SERVICE ACCOUNT**. This guide covers the path for creating a new key for a new service account.
2627

27-
<img src={GCS_create_service_account_key} alt="Generating a service account HMAC key in GCS" />
28+
<Image size="md" img={GCS_create_service_account_key} alt="Generating a service account HMAC key in GCS" border />
2829

2930
### Add a new service account {#add-a-new-service-account}
3031

3132
If this is a project with no existing service account, **CREATE NEW ACCOUNT**.
3233

33-
<img src={GCS_create_service_account_0} alt="Adding a new service account in GCS" />
34+
<Image size="md" img={GCS_create_service_account_0} alt="Adding a new service account in GCS" border />
3435

3536
There are three steps to creating the service account, in the first step give the account a meaningful name, ID, and description.
3637

37-
<img src={GCS_create_service_account_a} alt="Defining a new service account name and ID in GCS" />
38+
<Image size="md" img={GCS_create_service_account_a} alt="Defining a new service account name and ID in GCS" border />
3839

3940
In the Interoperability settings dialog the IAM role **Storage Object Admin** role is recommended; select that role in step two.
4041

41-
<img src={GCS_create_service_account_2} alt="Selecting IAM role Storage Object Admin in GCS" />
42+
<Image size="md" img={GCS_create_service_account_2} alt="Selecting IAM role Storage Object Admin in GCS" border />
4243

4344
Step three is optional and not used in this guide. You may allow users to have these privileges based on your policies.
4445

45-
<img src={GCS_create_service_account_3} alt="Configuring additional settings for the new service account in GCS" />
46+
<Image size="md" img={GCS_create_service_account_3} alt="Configuring additional settings for the new service account in GCS" border />
4647

4748
The service account HMAC key will be displayed. Save this information, as it will be used in the ClickHouse configuration.
4849

49-
<img src={GCS_guide_key} alt="Retrieving the generated HMAC key for GCS" />
50+
<Image size="md" img={GCS_guide_key} alt="Retrieving the generated HMAC key for GCS" border />
5051

5152
</details>

docs/_snippets/_S3_authentication_and_bucket.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import Image from '@theme/IdealImage';
12
import s3_1 from '@site/static/images/_snippets/s3/s3-1.png';
23
import s3_2 from '@site/static/images/_snippets/s3/s3-2.png';
34
import s3_3 from '@site/static/images/_snippets/s3/s3-3.png';
@@ -27,85 +28,85 @@ In this procedure, we'll be creating a service account user, not a login user.
2728

2829
2. In "users", select **Add users**
2930

30-
<img src={s3_1} alt="create_iam_user_0"/>
31+
<Image size="md" img={s3_1} alt="AWS IAM Management Console - Adding a new user" border />
3132

3233
3. Enter the user name and set the credential type to **Access key - Programmatic access** and select **Next: Permissions**
3334

34-
<img src={s3_2} alt="create_iam_user_1"/>
35+
<Image size="md" img={s3_2} alt="Setting user name and access type for IAM user" border />
3536

3637
4. Do not add the user to any group; select **Next: Tags**
3738

38-
<img src={s3_3} alt="create_iam_user_2"/>
39+
<Image size="md" img={s3_3} alt="Skipping group assignment for IAM user" border />
3940

4041
5. Unless you need to add any tags, select **Next: Review**
4142

42-
<img src={s3_4} alt="create_iam_user_3"/>
43+
<Image size="md" img={s3_4} alt="Skipping tag assignment for IAM user" border />
4344

4445
6. Select **Create User**
4546

4647
:::note
4748
The warning message stating that the user has no permissions can be ignored; permissions will be granted on the bucket for the user in the next section
4849
:::
4950

50-
<img src={s3_5} alt="create_iam_user_4"/>
51+
<Image size="md" img={s3_5} alt="Creating the IAM user with no permissions warning" border />
5152

5253
7. The user is now created; click on **show** and copy the access and secret keys.
5354
:::note
5455
Save the keys somewhere else; this is the only time that the secret access key will be available.
5556
:::
5657

57-
<img src={s3_6} alt="create_iam_user_5"/>
58+
<Image size="md" img={s3_6} alt="Viewing and copying the IAM user access keys" border />
5859

5960
8. Click close, then find the user in the users screen.
6061

61-
<img src={s3_7} alt="create_iam_user_6"/>
62+
<Image size="md" img={s3_7} alt="Finding the newly created IAM user in the users list" border />
6263

6364
9. Copy the ARN (Amazon Resource Name) and save it for use when configuring the access policy for the bucket.
6465

65-
<img src={s3_8} alt="create_iam_user_7"/>
66+
<Image size="md" img={s3_8} alt="Copying the ARN of the IAM user" border />
6667

6768
### Create an S3 bucket {#create-an-s3-bucket}
6869
1. In the S3 bucket section, select **Create bucket**
6970

70-
<img src={s3_9} alt="create_s3_bucket_0"/>
71+
<Image size="md" img={s3_9} alt="Starting the S3 bucket creation process" border />
7172

7273
2. Enter a bucket name, leave other options default
7374
:::note
7475
The bucket name must be unique across AWS, not just the organization, or it will emit an error.
7576
:::
7677
3. Leave `Block all Public Access` enabled; public access is not needed.
7778

78-
<img src={s3_a} alt="create_s3_bucket_2"/>
79+
<Image size="md" img={s3_a} alt="Configuring the S3 bucket settings with public access blocked" border />
7980

8081
4. Select **Create Bucket** at the bottom of the page
8182

82-
<img src={s3_b} alt="create_s3_bucket_3"/>
83+
<Image size="md" img={s3_b} alt="Finalizing S3 bucket creation" border />
8384

8485
5. Select the link, copy the ARN, and save it for use when configuring the access policy for the bucket.
8586

8687
6. Once the bucket has been created, find the new S3 bucket in the S3 buckets list and select the link
8788

88-
<img src={s3_c} alt="create_s3_bucket_4"/>
89+
<Image size="md" img={s3_c} alt="Finding the newly created S3 bucket in the buckets list" border />
8990

9091
7. Select **Create folder**
9192

92-
<img src={s3_d} alt="create_s3_bucket_5"/>
93+
<Image size="md" img={s3_d} alt="Creating a new folder in the S3 bucket" border />
9394

9495
8. Enter a folder name that will be the target for the ClickHouse S3 disk and select **Create folder**
9596

96-
<img src={s3_e} alt="create_s3_bucket_6"/>
97+
<Image size="md" img={s3_e} alt="Setting the folder name for ClickHouse S3 disk usage" border />
9798

9899
9. The folder should now be visible on the bucket list
99100

100-
<img src={s3_f} alt="create_s3_bucket_7"/>
101+
<Image size="md" img={s3_f} alt="Viewing the newly created folder in the S3 bucket" border />
101102

102103
10. Select the checkbox for the new folder and click on **Copy URL** Save the URL copied to be used in the ClickHouse storage configuration in the next section.
103104

104-
<img src={s3_g} alt="create_s3_bucket_8"/>
105+
<Image size="md" img={s3_g} alt="Copying the S3 folder URL for ClickHouse configuration" border />
105106

106107
11. Select the **Permissions** tab and click on the **Edit** button in the **Bucket Policy** section
107108

108-
<img src={s3_h} alt="create_s3_bucket_9"/>
109+
<Image size="md" img={s3_h} alt="Accessing the S3 bucket policy configuration" border />
109110

110111
12. Add a bucket policy, example below:
111112
```json
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import Image from '@theme/IdealImage';
12
import ip_allow_list_check_list from '@site/static/images/_snippets/ip-allow-list-check-list.png';
23
import ip_allow_list_add_current_ip from '@site/static/images/_snippets/ip-allow-list-add-current-ip.png';
34

@@ -6,10 +7,10 @@ import ip_allow_list_add_current_ip from '@site/static/images/_snippets/ip-allow
67

78
From your ClickHouse Cloud services list choose the service that you will work with and switch to **Settings**. If the IP Access List does not contain the IP Address or range of the remote system that needs to connect to your ClickHouse Cloud service, then you can resolve the problem with **Add IPs**:
89

9-
<img src={ip_allow_list_check_list} class="image" alt="Check to see if the service allows traffic" />
10+
<Image size="md" img={ip_allow_list_check_list} alt="Check to see if the service allows traffic from your IP address in the IP Access List" border />
1011

1112
Add the individual IP Address, or the range of addresses that need to connect to your ClickHouse Cloud service. Modify the form as you see fit and then **Save**.
1213

13-
<img src={ip_allow_list_add_current_ip} class="image" alt="Add your current IP address" />
14+
<Image size="md" img={ip_allow_list_add_current_ip} alt="Add your current IP address to the IP Access List in ClickHouse Cloud" border />
1415

1516
</details>

docs/_snippets/_clickhouse_mysql_cloud_setup.mdx

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,43 +3,38 @@ import mysql_2 from '@site/static/images/_snippets/mysql2.png';
33
import mysql_3 from '@site/static/images/_snippets/mysql3.png';
44
import mysql_4 from '@site/static/images/_snippets/mysql4.png';
55
import mysql_5 from '@site/static/images/_snippets/mysql5.png';
6+
import Image from '@theme/IdealImage';
67

78
<br/>
89
1. After creating your ClickHouse Cloud Service, on the `Connect your app` screen, select MySQL from the drop down.
910
<br/>
1011

11-
<div class="eighty-percent">
12-
<img src={mysql_1} class="image" alt="Credentials screen - Prompt" />
13-
</div>
12+
<Image size="md" img={mysql_1} alt="ClickHouse Cloud credentials screen showing MySQL interface selection dropdown" border />
1413

1514

1615
2. Toggle the switch to enable the MySQL interface for this specific service. This will expose port `3306` for this service and prompt you with your MySQL connection screen that include your unique MySQL username.
1716

18-
<div class="eighty-percent">
19-
<img src={mysql_2} class="image" alt="Credentials screen - Enabled MySQL" />
20-
</div>
17+
<Image size="md" img={mysql_2} alt="ClickHouse Cloud MySQL interface enabling toggle and connection details" border />
2118
<br/>
2219

2320
Alternatively, in order to enable the MySQL interface for an existing service:
2421

2522
3. Ensure your service is in `Running` state then click on the service you want to enable the MySQL interface for. Select "Connect" from the left menu:
2623

2724
<br/>
28-
<div class="eighty-percent">
29-
<img src={mysql_3} class="image" alt="Connection screen - Prompt MySQL" />
30-
</div>
25+
<Image size="md" img={mysql_3} alt="ClickHouse Cloud service connection screen with Connect option highlighted" border />
3126
<br/>
3227

3328

3429
4. Select MySQL from the `Connect With` drop down.
3530

3631
<br/>
37-
<img src={mysql_4} class="image" alt="Connection screen - Prompt MySQL" />
32+
<Image size="md" img={mysql_4} alt="ClickHouse Cloud connection screen showing MySQL option selection" border />
3833
<br/>
3934

4035
5. Toggle the switch to enable the MySQL interface for this specific service. This will expose port `3306` for this service and prompt you with your MySQL connection screen that include your unique MySQL username.
4136

42-
<img src={mysql_5} class="image" alt="Connection screen - MySQL Enabled" />
37+
<Image size="md" img={mysql_5} alt="ClickHouse Cloud connection screen with MySQL interface enabled showing connection details" border />
4338

4439
## Creating multiple MySQL users in ClickHouse Cloud {#creating-multiple-mysql-users-in-clickhouse-cloud}
4540

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
import Image from '@theme/IdealImage';
12
import cloud_service_action_menu from '@site/static/images/_snippets/cloud-service-actions-menu.png';
23

34
Select your service, followed by `Data souces` -> `Predefined sample data`.
45

5-
<img src={cloud_service_action_menu} class="image" alt="Cloud service Actions menu" />
6+
<Image size="md" img={cloud_service_action_menu} alt="ClickHouse Cloud service Actions menu showing Data sources and Predefined sample data options" border />

docs/integrations/data-visualization/astrato-and-clickhouse.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,21 +41,21 @@ When setting up your data connection, you'll need to know:
4141
4242
- Click on the **New Data Connection** button in the top right side of the screen.
4343

44-
<Image img={astrato_1_dataconnection} class="image" alt="Astrato Data Connection" size="sm"/>
44+
<Image size="sm" img={astrato_1_dataconnection} alt="Astrato Data Connection" border />
4545

4646
- Select **ClickHouse**.
4747

48-
<Image img={astrato_2a_clickhouse_connection} class="image" alt="Astrato ClickHouse Data Connection" size="sm"/>
48+
<Image size="sm" img={astrato_2a_clickhouse_connection} alt="Astrato ClickHouse Data Connection" border />
4949

5050
- Complete the required fields in the connection dialogue box
5151

52-
<Image img={astrato_2b_clickhouse_connection} class="image" alt="Astrato connect to ClickHouse required fields" size="sm"/>
52+
<Image size="sm" img={astrato_2b_clickhouse_connection} alt="Astrato connect to ClickHouse required fields" border />
5353

5454
- Click **Test Connection**. If the connection is successful, give the data connection a **name** and click **Next.**
5555

5656
- Set the **user access** to the data connection and click **connect.**
5757

58-
<Image img={astrato_3_user_access} alt="Astrato connect to ClickHouse User Access" size="md"/>
58+
<Image size="md" img={astrato_3_user_access} alt="Astrato connect to ClickHouse User Access" border />
5959

6060
- A connection is created and a dataview is created.
6161

@@ -67,17 +67,17 @@ if a duplicate is created, a timestamp is added to the data source name.
6767

6868
In our Data View editor, you will see all of your Tables and Schemas in ClickHouse, select some to get started.
6969

70-
<Image img={astrato_4a_clickhouse_data_view} alt="Astrato connect to ClickHouse User Access" size="lg"/>
70+
<Image size="lg" img={astrato_4a_clickhouse_data_view} alt="Astrato connect to ClickHouse User Access" border />
7171

7272
Now that you have your data selected, go to define the **data view**. Click define on the top right of the webpage.
7373

7474
In here, you are able to join data, as well as, **create governed dimensions and measures** - ideal for driving consistency in business logic across various teams.
7575

76-
<Image img={astrato_4b_clickhouse_data_view_joins} alt="Astrato connect to ClickHouse User Access" size="lg"/>
76+
<Image size="lg" img={astrato_4b_clickhouse_data_view_joins} alt="Astrato connect to ClickHouse User Access" border />
7777

7878
**Astrato intelligently suggests joins** using your meta data, including leveraging the keys in ClickHouse. Our suggested joins make it easy for you to gets started, working from your well-governed ClickHouse data, without reinventing the wheel. We also show you **join quality** so that you have the option to review all suggestions, in detail, from Astrato.
7979

80-
<Image img={astrato_4c_clickhouse_completed_data_view} alt="Astrato connect to ClickHouse User Access" size="lg"/>
80+
<Image size="lg" img={astrato_4c_clickhouse_completed_data_view} alt="Astrato connect to ClickHouse User Access" border />
8181

8282
## Creating a dashboard {#creating-a-dashboard}
8383

@@ -87,18 +87,18 @@ In just a few steps, you can build your first chart in Astrato.
8787
3. Add dimension(s)
8888
4. Add measure(s)
8989

90-
<Image img={astrato_5a_clickhouse_build_chart} alt="Astrato connect to ClickHouse User Access" size="lg"/>
90+
<Image size="lg" img={astrato_5a_clickhouse_build_chart} alt="Astrato connect to ClickHouse User Access" border />
9191

9292

9393
### View generated SQL supporting each visualization {#view-generated-sql-supporting-each-visualization}
9494

9595
Transparency and accuracy are at the heart of Astrato. We ensure that every query generated is visible, letting you keep full control. All compute happens directly in ClickHouse, taking advantage of its speed while maintaining robust security and governance.
9696

97-
<Image img={astrato_5b_clickhouse_view_sql} alt="Astrato connect to ClickHouse User Access" size="lg"/>
97+
<Image size="lg" img={astrato_5b_clickhouse_view_sql} alt="Astrato connect to ClickHouse User Access" border />
9898

9999

100100
### Example completed dashboard {#example-completed-dashboard}
101101

102102
A beautiful complete dashboard or data app isn't far away now. To see more of what we've built, head to our demo gallery on our website. https://astrato.io/gallery
103103

104-
<Image img={astrato_5c_clickhouse_complete_dashboard} alt="Astrato connect to ClickHouse User Access" size="lg"/>
104+
<Image size="lg" img={astrato_5c_clickhouse_complete_dashboard} alt="Astrato connect to ClickHouse User Access" border />

docs/integrations/data-visualization/deepnote.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,18 @@ This guide assumes you already have a Deepnote account and that you have a runni
2323
## Interactive example {#interactive-example}
2424
If you would like to explore an interactive example of querying ClickHouse from Deepnote data notebooks, click the button below to launch a template project connected to the [ClickHouse playground](../../getting-started/playground.md).
2525

26-
[<Image size="logo" img="https://deepnote.com/buttons/launch-in-deepnote.svg"/>](https://deepnote.com/launch?template=ClickHouse%20and%20Deepnote)
26+
[<Image size="logo" img="https://deepnote.com/buttons/launch-in-deepnote.svg" alt="Launch in Deepnote" />](https://deepnote.com/launch?template=ClickHouse%20and%20Deepnote)
2727

2828
## Connect to ClickHouse {#connect-to-clickhouse}
2929

3030
1. Within Deepnote, select the "Integrations" overview and click on the ClickHouse tile.
3131

32-
<Image size="lg" img={deepnote_01} alt="ClickHouse integration tile"/>
32+
<Image size="lg" img={deepnote_01} alt="ClickHouse integration tile" border />
3333

3434
2. Provide the connection details for your ClickHouse instance:
3535
<ConnectionDetails />
3636

37-
<Image size="md" img={deepnote_02} alt="ClickHouse details dialog"/>
37+
<Image size="md" img={deepnote_02} alt="ClickHouse details dialog" border />
3838

3939
**_NOTE:_** If your connection to ClickHouse is protected with an IP Access List, you might need to allow Deepnote's IP addresses. Read more about it in [Deepnote's docs](https://docs.deepnote.com/integrations/authorize-connections-from-deepnote-ip-addresses).
4040

@@ -44,7 +44,7 @@ If you would like to explore an interactive example of querying ClickHouse from
4444

4545
1. Start by connecting to the ClickHouse integration on the right of your notebook.
4646

47-
<Image size="lg" img={deepnote_03} alt="ClickHouse details dialog"/>
47+
<Image size="lg" img={deepnote_03} alt="ClickHouse details dialog" border />
4848

4949
2. Now create a new ClickHouse query block and query your database. The query results will be saved as a DataFrame and stored in the variable specified in the SQL block.
5050
3. You can also convert any existing [SQL block](https://docs.deepnote.com/features/sql-cells) to a ClickHouse block.

0 commit comments

Comments
 (0)