Skip to content

Commit a33769c

Browse files
committed
revert_8a910bb4dc86fe5b1eda2f8f6febd3a3268eecc6
1 parent 2e50534 commit a33769c

File tree

159 files changed

+8258
-608
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

159 files changed

+8258
-608
lines changed
Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1+
---
2+
sidebar_label: Invitations
3+
title: Invitations
4+
---
15

2-
## List all invitations
6+
## List all invitations {#list-all-invitations}
37

48
This file is generated by `clickhouseapi.js` during the build process. If the
59
content needs changing please edit `clickhouseapi.js`.
Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1+
---
2+
sidebar_label: Keys
3+
title: Keys
4+
---
15

2-
## Get list of all keys
6+
## Get list of all keys {#get-list-of-all-keys}
37

48
This file is generated by `clickhouseapi.js` during the build process. If the
59
content needs changing please edit `clickhouseapi.js`.
Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1+
---
2+
sidebar_label: Members
3+
title: Members
4+
---
15

2-
## List organization members
6+
## List organization members {#list-organization-members}
37

48
This file is generated by `clickhouseapi.js` during the build process. If the
59
content needs changing please edit `clickhouseapi.js`.
Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1+
---
2+
sidebar_label: Organizations
3+
title: Organizations
4+
---
15

2-
## Get organization details
6+
## Get organization details {#get-organization-details}
37

48
This file is generated by `clickhouseapi.js` during the build process. If the
59
content needs changing please edit `clickhouseapi.js`.
Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1+
---
2+
sidebar_label: Services
3+
title: Services
4+
---
15

2-
## List of organization services
6+
## List of organization services {#list-of-organization-services}
37

48
This file is generated by `clickhouseapi.js` during the build process. If the
59
content needs changing please edit `clickhouseapi.js`.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,9 @@
1+
---
2+
description: 'Changelog for 2025'
3+
note: 'This file is autogenerated by the yarn new-build'
4+
slug: /whats-new/changelog/
5+
sidebar_position: 2
6+
sidebar_label: '2025'
7+
title: '2025 Changelog'
8+
---
19

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,52 @@
1+
import GCS_bucket_1 from '@site/static/images/integrations/data-ingestion/s3/GCS-bucket-1.png';
2+
import GCS_bucket_2 from '@site/static/images/integrations/data-ingestion/s3/GCS-bucket-2.png';
3+
import GCS_create_service_account_key from '@site/static/images/integrations/data-ingestion/s3/GCS-create-a-service-account-key.png';
4+
import GCS_create_service_account_0 from '@site/static/images/integrations/data-ingestion/s3/GCS-create-service-account-0.png';
5+
import GCS_create_service_account_a from '@site/static/images/integrations/data-ingestion/s3/GCS-create-service-account-a.png';
6+
import GCS_create_service_account_2 from '@site/static/images/integrations/data-ingestion/s3/GCS-create-service-account-2.png';
7+
import GCS_create_service_account_3 from '@site/static/images/integrations/data-ingestion/s3/GCS-create-service-account-3.png';
8+
import GCS_guide_key from '@site/static/images/integrations/data-ingestion/s3/GCS-guide-key.png';
9+
import Image from '@theme/IdealImage';
110

211
<details>
312
<summary>Create GCS buckets and an HMAC key</summary>
413

5-
### ch_bucket_us_east1
14+
### ch_bucket_us_east1 {#ch_bucket_us_east1}
615

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

18+
### ch_bucket_us_east4 {#ch_bucket_us_east4}
819

9-
### ch_bucket_us_east4
20+
<Image size="md" img={GCS_bucket_2} alt="Creating a GCS bucket in US East 4" border />
1021

22+
### Generate an Access key {#generate-an-access-key}
1123

12-
13-
### Generate an Access key
14-
15-
### Create a service account HMAC key and secret
24+
### Create a service account HMAC key and secret {#create-a-service-account-hmac-key-and-secret}
1625

1726
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.
1827

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

20-
21-
### Add a new service account
30+
### Add a new service account {#add-a-new-service-account}
2231

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

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

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

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

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

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

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

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

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

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

4352
</details>

docs/_snippets/_S3_authentication_and_bucket.md

Lines changed: 37 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,94 +1,112 @@
1+
import Image from '@theme/IdealImage';
2+
import s3_1 from '@site/static/images/_snippets/s3/s3-1.png';
3+
import s3_2 from '@site/static/images/_snippets/s3/s3-2.png';
4+
import s3_3 from '@site/static/images/_snippets/s3/s3-3.png';
5+
import s3_4 from '@site/static/images/_snippets/s3/s3-4.png';
6+
import s3_5 from '@site/static/images/_snippets/s3/s3-5.png';
7+
import s3_6 from '@site/static/images/_snippets/s3/s3-6.png';
8+
import s3_7 from '@site/static/images/_snippets/s3/s3-7.png';
9+
import s3_8 from '@site/static/images/_snippets/s3/s3-8.png';
10+
import s3_9 from '@site/static/images/_snippets/s3/s3-9.png';
11+
import s3_a from '@site/static/images/_snippets/s3/s3-a.png';
12+
import s3_b from '@site/static/images/_snippets/s3/s3-b.png';
13+
import s3_c from '@site/static/images/_snippets/s3/s3-c.png';
14+
import s3_d from '@site/static/images/_snippets/s3/s3-d.png';
15+
import s3_e from '@site/static/images/_snippets/s3/s3-e.png';
16+
import s3_f from '@site/static/images/_snippets/s3/s3-f.png';
17+
import s3_g from '@site/static/images/_snippets/s3/s3-g.png';
18+
import s3_h from '@site/static/images/_snippets/s3/s3-h.png';
119

220
<details>
321
<summary>Create S3 buckets and an IAM user</summary>
422

523
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.
624

7-
### Create an AWS IAM user
25+
### Create an AWS IAM user {#create-an-aws-iam-user}
826
In this procedure, we'll be creating a service account user, not a login user.
927
1. Log into the AWS IAM Management Console.
1028

1129
2. In "users", select **Add users**
1230

13-
31+
<Image size="md" img={s3_1} alt="AWS IAM Management Console - Adding a new user" border force/>
1432

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

17-
35+
<Image size="md" img={s3_2} alt="Setting user name and access type for IAM user" border force/>
1836

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

21-
39+
<Image size="md" img={s3_3} alt="Skipping group assignment for IAM user" border force/>
2240

2341
5. Unless you need to add any tags, select **Next: Review**
2442

25-
43+
<Image size="md" img={s3_4} alt="Skipping tag assignment for IAM user" border force/>
2644

2745
6. Select **Create User**
2846

2947
:::note
3048
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
3149
:::
3250

33-
51+
<Image size="md" img={s3_5} alt="Creating the IAM user with no permissions warning" border force/>
3452

3553
7. The user is now created; click on **show** and copy the access and secret keys.
3654
:::note
3755
Save the keys somewhere else; this is the only time that the secret access key will be available.
3856
:::
3957

40-
58+
<Image size="md" img={s3_6} alt="Viewing and copying the IAM user access keys" border force/>
4159

4260
8. Click close, then find the user in the users screen.
4361

44-
62+
<Image size="md" img={s3_7} alt="Finding the newly created IAM user in the users list" border force/>
4563

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

66+
<Image size="md" img={s3_8} alt="Copying the ARN of the IAM user" border force/>
4867

49-
50-
### Create an S3 bucket
68+
### Create an S3 bucket {#create-an-s3-bucket}
5169
1. In the S3 bucket section, select **Create bucket**
5270

53-
71+
<Image size="md" img={s3_9} alt="Starting the S3 bucket creation process" border force/>
5472

5573
2. Enter a bucket name, leave other options default
5674
:::note
5775
The bucket name must be unique across AWS, not just the organization, or it will emit an error.
5876
:::
5977
3. Leave `Block all Public Access` enabled; public access is not needed.
6078

61-
79+
<Image size="md" img={s3_a} alt="Configuring the S3 bucket settings with public access blocked" border force/>
6280

6381
4. Select **Create Bucket** at the bottom of the page
6482

65-
83+
<Image size="md" img={s3_b} alt="Finalizing S3 bucket creation" border force/>
6684

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

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

71-
89+
<Image size="md" img={s3_c} alt="Finding the newly created S3 bucket in the buckets list" border force/>
7290

7391
7. Select **Create folder**
7492

75-
93+
<Image size="md" img={s3_d} alt="Creating a new folder in the S3 bucket" border force/>
7694

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

79-
97+
<Image size="md" img={s3_e} alt="Setting the folder name for ClickHouse S3 disk usage" border force/>
8098

8199
9. The folder should now be visible on the bucket list
82100

83-
101+
<Image size="md" img={s3_f} alt="Viewing the newly created folder in the S3 bucket" border force/>
84102

85103
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.
86104

87-
105+
<Image size="md" img={s3_g} alt="Copying the S3 folder URL for ClickHouse configuration" border force/>
88106

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

91-
109+
<Image size="md" img={s3_h} alt="Accessing the S3 bucket policy configuration" border force/>
92110

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

25
<details>
36
<summary>Manage your IP Access List</summary>
47

58
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**:
69

7-
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 />
811

912
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**.
1013

11-
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 />
1215

1316
</details>

docs/_snippets/_add_superset_detail.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ There are a few tasks to be done before running `docker compose`:
1313
The commands below are to be run from the top level of the GitHub repo, `superset`.
1414
:::
1515

16-
## Official ClickHouse Connect driver
16+
## Official ClickHouse Connect driver {#official-clickhouse-connect-driver}
1717

1818
To make the ClickHouse Connect driver available in the Superset deployment add it to the local requirements file:
1919

2020
```bash
2121
echo "clickhouse-connect" >> ./docker/requirements-local.txt
2222
```
2323

24-
## Mapbox
24+
## Mapbox {#mapbox}
2525

2626
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.
2727

@@ -33,7 +33,7 @@ Make the API key available to Superset:
3333
echo "MAPBOX_API_KEY=pk.SAMPLE-Use-your-key-instead" >> docker/.env-non-dev
3434
```
3535

36-
## Deploy Superset version 2.0.0
36+
## Deploy Superset version 2.0.0 {#deploy-superset-version-200}
3737

3838
To deploy release 2.0.0 run:
3939

0 commit comments

Comments
 (0)