You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/_snippets/_GCS_authentication_and_bucket.md
+21-1Lines changed: 21 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,24 +9,44 @@ import GCS_guide_key from '@site/static/images/integrations/data-ingestion/s3/GC
9
9
import Image from '@theme/IdealImage';
10
10
11
11
<details>
12
-
<summary>Create GCS buckets and an HMAC key</summary>
12
+
<summary>Create GCS buckets and an HMAC key</summary>
13
+
13
14
### ch_bucket_us_east1 {#ch_bucket_us_east1}
15
+
14
16
<Imagesize="md"img={GCS_bucket_1}alt="Creating a GCS bucket in US East 1"border />
17
+
15
18
### ch_bucket_us_east4 {#ch_bucket_us_east4}
19
+
16
20
<Imagesize="md"img={GCS_bucket_2}alt="Creating a GCS bucket in US East 4"border />
21
+
17
22
### Generate an access key {#generate-an-access-key}
23
+
18
24
### Create a service account HMAC key and secret {#create-a-service-account-hmac-key-and-secret}
25
+
19
26
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.
27
+
20
28
<Imagesize="md"img={GCS_create_service_account_key}alt="Generating a service account HMAC key in GCS"border />
29
+
21
30
### Add a new service account {#add-a-new-service-account}
31
+
22
32
If this is a project with no existing service account, **CREATE NEW ACCOUNT**.
33
+
23
34
<Imagesize="md"img={GCS_create_service_account_0}alt="Adding a new service account in GCS"border />
35
+
24
36
There are three steps to creating the service account, in the first step give the account a meaningful name, ID, and description.
37
+
25
38
<Imagesize="md"img={GCS_create_service_account_a}alt="Defining a new service account name and ID in GCS"border />
39
+
26
40
In the Interoperability settings dialog the IAM role **Storage Object Admin** role is recommended; select that role in step two.
41
+
27
42
<Imagesize="md"img={GCS_create_service_account_2}alt="Selecting IAM role Storage Object Admin in GCS"border />
43
+
28
44
Step three is optional and not used in this guide. You may allow users to have these privileges based on your policies.
45
+
29
46
<Imagesize="md"img={GCS_create_service_account_3}alt="Configuring additional settings for the new service account in GCS"border />
47
+
30
48
The service account HMAC key will be displayed. Save this information, as it will be used in the ClickHouse configuration.
49
+
31
50
<Imagesize="md"img={GCS_guide_key}alt="Retrieving the generated HMAC key for GCS"border />
Copy file name to clipboardExpand all lines: docs/_snippets/_S3_authentication_and_bucket.md
+64-21Lines changed: 64 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,78 +18,118 @@ import s3_g from '@site/static/images/_snippets/s3/s3-g.png';
18
18
import s3_h from '@site/static/images/_snippets/s3/s3-h.png';
19
19
20
20
<details>
21
-
<summary>Create S3 buckets and an IAM user</summary>
21
+
<summary>Create S3 buckets and an IAM user</summary>
22
+
22
23
This article demonstrates the basics of how to configure an AWS IAM user, create an S3 bucket and configure ClickHouse to use the bucket as an S3 disk. You should work with your security team to determine the permissions to be used, and consider these as a starting point.
24
+
23
25
### Create an AWS IAM user {#create-an-aws-iam-user}
24
26
In this procedure, we'll be creating a service account user, not a login user.
25
-
1. Log into the AWS IAM Management Console.
27
+
1. Log into the AWS IAM Management Console.
28
+
26
29
2. In "users", select **Add users**
30
+
27
31
<Imagesize="md"img={s3_1}alt="AWS IAM Management Console - Adding a new user"borderforce/>
32
+
28
33
3. Enter the user name and set the credential type to **Access key - Programmatic access** and select **Next: Permissions**
34
+
29
35
<Imagesize="md"img={s3_2}alt="Setting user name and access type for IAM user"borderforce/>
36
+
30
37
4. Do not add the user to any group; select **Next: Tags**
38
+
31
39
<Imagesize="md"img={s3_3}alt="Skipping group assignment for IAM user"borderforce/>
40
+
32
41
5. Unless you need to add any tags, select **Next: Review**
42
+
33
43
<Imagesize="md"img={s3_4}alt="Skipping tag assignment for IAM user"borderforce/>
44
+
34
45
6. Select **Create User**
35
-
:::note
36
-
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
37
-
:::
46
+
47
+
:::note
48
+
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
49
+
:::
50
+
38
51
<Imagesize="md"img={s3_5}alt="Creating the IAM user with no permissions warning"borderforce/>
52
+
39
53
7. The user is now created; click on **show** and copy the access and secret keys.
40
54
:::note
41
55
Save the keys somewhere else; this is the only time that the secret access key will be available.
42
56
:::
57
+
43
58
<Imagesize="md"img={s3_6}alt="Viewing and copying the IAM user access keys"borderforce/>
59
+
44
60
8. Click close, then find the user in the users screen.
61
+
45
62
<Imagesize="md"img={s3_7}alt="Finding the newly created IAM user in the users list"borderforce/>
63
+
46
64
9. Copy the ARN (Amazon Resource Name) and save it for use when configuring the access policy for the bucket.
65
+
47
66
<Imagesize="md"img={s3_8}alt="Copying the ARN of the IAM user"borderforce/>
67
+
48
68
### Create an S3 bucket {#create-an-s3-bucket}
49
69
1. In the S3 bucket section, select **Create bucket**
70
+
50
71
<Imagesize="md"img={s3_9}alt="Starting the S3 bucket creation process"borderforce/>
72
+
51
73
2. Enter a bucket name, leave other options default
52
74
:::note
53
75
The bucket name must be unique across AWS, not just the organization, or it will emit an error.
54
76
:::
55
77
3. Leave `Block all Public Access` enabled; public access is not needed.
78
+
56
79
<Imagesize="md"img={s3_a}alt="Configuring the S3 bucket settings with public access blocked"borderforce/>
80
+
57
81
4. Select **Create Bucket** at the bottom of the page
5. Select the link, copy the ARN, and save it for use when configuring the access policy for the bucket.
86
+
60
87
6. Once the bucket has been created, find the new S3 bucket in the S3 buckets list and select the link
88
+
61
89
<Imagesize="md"img={s3_c}alt="Finding the newly created S3 bucket in the buckets list"borderforce/>
90
+
62
91
7. Select **Create folder**
92
+
63
93
<Imagesize="md"img={s3_d}alt="Creating a new folder in the S3 bucket"borderforce/>
94
+
64
95
8. Enter a folder name that will be the target for the ClickHouse S3 disk and select **Create folder**
96
+
65
97
<Imagesize="md"img={s3_e}alt="Setting the folder name for ClickHouse S3 disk usage"borderforce/>
98
+
66
99
9. The folder should now be visible on the bucket list
100
+
67
101
<Imagesize="md"img={s3_f}alt="Viewing the newly created folder in the S3 bucket"borderforce/>
102
+
68
103
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.
104
+
69
105
<Imagesize="md"img={s3_g}alt="Copying the S3 folder URL for ClickHouse configuration"borderforce/>
106
+
70
107
11. Select the **Permissions** tab and click on the **Edit** button in the **Bucket Policy** section
108
+
71
109
<Imagesize="md"img={s3_h}alt="Accessing the S3 bucket policy configuration"borderforce/>
Copy file name to clipboardExpand all lines: docs/_snippets/_add_remote_ip_access_list_detail.md
+6-1Lines changed: 6 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,9 +3,14 @@ import ip_allow_list_check_list from '@site/static/images/_snippets/ip-allow-lis
3
3
import ip_allow_list_add_current_ip from '@site/static/images/_snippets/ip-allow-list-add-current-ip.png';
4
4
5
5
<details>
6
-
<summary>Manage your IP Access List</summary>
6
+
<summary>Manage your IP Access List</summary>
7
+
7
8
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**:
9
+
8
10
<Imagesize="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 />
11
+
9
12
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**.
13
+
10
14
<Imagesize="md"img={ip_allow_list_add_current_ip}alt="Add your current IP address to the IP Access List in ClickHouse Cloud"border />
<summary>Launch Apache Superset in Docker</summary>
2
+
<summary>Launch Apache Superset in Docker</summary>
3
+
3
4
Superset provides [installing Superset locally using Docker Compose](https://superset.apache.org/docs/installation/installing-superset-using-docker-compose/) instructions. After checking out the Apache Superset repo from GitHub you can run the latest development code, or a specific tag. We recommend release 2.0.0 as it is the latest release not marked as `pre-release`.
5
+
4
6
There are a few tasks to be done before running `docker compose`:
7
+
5
8
1. Add the official ClickHouse Connect driver
6
9
2. Obtain a Mapbox API key and add that as an environment variable (optional)
7
10
3. Specify the version of Superset to run
11
+
8
12
:::tip
9
13
The commands below are to be run from the top level of the GitHub repo, `superset`.
10
14
:::
15
+
11
16
## Official ClickHouse connect driver {#official-clickhouse-connect-driver}
17
+
12
18
To make the ClickHouse Connect driver available in the Superset deployment add it to the local requirements file:
This is optional, you can plot location data in Superset without a Mapbox API key, but you will see a message telling you that you should add a key and the background image of the map will be missing (you will only see the data points and not the map background). Mapbox provides a free tier if you would like to use it.
27
+
18
28
Some of the sample visualizations that the guides have you create use location, for example longitude and latitude, data. Superset includes support for Mapbox maps. To use the Mapbox visualizations you need a Mapbox API key. Sign up for the [Mapbox free tier](https://account.mapbox.com/auth/signup/), and generate an API key.
Copy file name to clipboardExpand all lines: docs/_snippets/_clickhouse_mysql_cloud_setup.mdx
+12-6Lines changed: 12 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,26 +7,32 @@ import Image from '@theme/IdealImage';
7
7
8
8
<br/>
9
9
1. After creating your ClickHouse Cloud Service, on the `Connect your app` screen, select MySQL from the drop down.
10
+
<br/>
10
11
11
-
<Imagesize="md"img={mysql_1}alt="ClickHouse Cloud credentials screen showing MySQL interface selection dropdown"border />
12
+
<Imagesize="md"img={mysql_1}alt="ClickHouse Cloud credentials screen showing MySQL interface selection dropdown"border />
12
13
13
14
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.
14
15
15
-
<Imagesize="md"img={mysql_2}alt="ClickHouse Cloud MySQL interface enabling toggle and connection details"border />
16
+
<Imagesize="md"img={mysql_2}alt="ClickHouse Cloud MySQL interface enabling toggle and connection details"border />
17
+
<br/>
16
18
17
-
Alternatively, in order to enable the MySQL interface for an existing service:
19
+
Alternatively, in order to enable the MySQL interface for an existing service:
18
20
19
21
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:
20
22
21
-
<Imagesize="md"img={mysql_3}alt="ClickHouse Cloud service connection screen with Connect option highlighted"border />
23
+
<br/>
24
+
<Imagesize="md"img={mysql_3}alt="ClickHouse Cloud service connection screen with Connect option highlighted"border />
25
+
<br/>
22
26
23
27
4. Select MySQL from the `Connect With` drop down.
24
28
25
-
<Imagesize="md"img={mysql_4}alt="ClickHouse Cloud connection screen showing MySQL option selection"border />
29
+
<br/>
30
+
<Imagesize="md"img={mysql_4}alt="ClickHouse Cloud connection screen showing MySQL option selection"border />
31
+
<br/>
26
32
27
33
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.
28
34
29
-
<Imagesize="md"img={mysql_5}alt="ClickHouse Cloud connection screen with MySQL interface enabled showing connection details"border />
35
+
<Imagesize="md"img={mysql_5}alt="ClickHouse Cloud connection screen with MySQL interface enabled showing connection details"border />
30
36
31
37
## Creating multiple MySQL users in ClickHouse Cloud {#creating-multiple-mysql-users-in-clickhouse-cloud}
0 commit comments