Skip to content

Commit e6213f3

Browse files
committed
Enforcing Markdown rules, list item indentation, cleaning up extra spaces (MD007, MD010).
1 parent f7f804a commit e6213f3

File tree

468 files changed

+12187
-15317
lines changed

Some content is hidden

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

468 files changed

+12187
-15317
lines changed

docs/_placeholders/api/_invitations-api-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ title: Invitations
55

66
## List all invitations {#list-all-invitations}
77

8-
This file is generated by `clickhouseapi.js` during the build process. If the
8+
This file is generated by `clickhouseapi.js` during the build process. If the
99
content needs changing please edit `clickhouseapi.js`.

docs/_placeholders/api/_keys-api-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ title: Keys
55

66
## Get list of all keys {#get-list-of-all-keys}
77

8-
This file is generated by `clickhouseapi.js` during the build process. If the
8+
This file is generated by `clickhouseapi.js` during the build process. If the
99
content needs changing please edit `clickhouseapi.js`.

docs/_placeholders/api/_members-api-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ title: Members
55

66
## List organization members {#list-organization-members}
77

8-
This file is generated by `clickhouseapi.js` during the build process. If the
8+
This file is generated by `clickhouseapi.js` during the build process. If the
99
content needs changing please edit `clickhouseapi.js`.

docs/_placeholders/api/_organizations-api-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ title: Organizations
55

66
## Get organization details {#get-organization-details}
77

8-
This file is generated by `clickhouseapi.js` during the build process. If the
8+
This file is generated by `clickhouseapi.js` during the build process. If the
99
content needs changing please edit `clickhouseapi.js`.

docs/_placeholders/api/_services-api-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ title: Services
55

66
## List of organization services {#list-of-organization-services}
77

8-
This file is generated by `clickhouseapi.js` during the build process. If the
8+
This file is generated by `clickhouseapi.js` during the build process. If the
99
content needs changing please edit `clickhouseapi.js`.

docs/_placeholders/changelog/_index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,3 @@ sidebar_position: 2
66
sidebar_label: '2025'
77
title: '2025 Changelog'
88
---
9-

docs/_snippets/_GCS_authentication_and_bucket.md

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,44 +9,24 @@ import GCS_guide_key from '@site/static/images/integrations/data-ingestion/s3/GC
99
import Image from '@theme/IdealImage';
1010

1111
<details>
12-
<summary>Create GCS buckets and an HMAC key</summary>
13-
12+
<summary>Create GCS buckets and an HMAC key</summary>
1413
### ch_bucket_us_east1 {#ch_bucket_us_east1}
15-
1614
<Image size="md" img={GCS_bucket_1} alt="Creating a GCS bucket in US East 1" border />
17-
1815
### ch_bucket_us_east4 {#ch_bucket_us_east4}
19-
2016
<Image size="md" img={GCS_bucket_2} alt="Creating a GCS bucket in US East 4" border />
21-
2217
### Generate an access key {#generate-an-access-key}
23-
2418
### Create a service account HMAC key and secret {#create-a-service-account-hmac-key-and-secret}
25-
2619
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-
2820
<Image size="md" img={GCS_create_service_account_key} alt="Generating a service account HMAC key in GCS" border />
29-
3021
### Add a new service account {#add-a-new-service-account}
31-
3222
If this is a project with no existing service account, **CREATE NEW ACCOUNT**.
33-
3423
<Image size="md" img={GCS_create_service_account_0} alt="Adding a new service account in GCS" border />
35-
3624
There are three steps to creating the service account, in the first step give the account a meaningful name, ID, and description.
37-
3825
<Image size="md" img={GCS_create_service_account_a} alt="Defining a new service account name and ID in GCS" border />
39-
4026
In the Interoperability settings dialog the IAM role **Storage Object Admin** role is recommended; select that role in step two.
41-
4227
<Image size="md" img={GCS_create_service_account_2} alt="Selecting IAM role Storage Object Admin in GCS" border />
43-
4428
Step three is optional and not used in this guide. You may allow users to have these privileges based on your policies.
45-
4629
<Image size="md" img={GCS_create_service_account_3} alt="Configuring additional settings for the new service account in GCS" border />
47-
4830
The service account HMAC key will be displayed. Save this information, as it will be used in the ClickHouse configuration.
49-
5031
<Image size="md" img={GCS_guide_key} alt="Retrieving the generated HMAC key for GCS" border />
51-
5232
</details>

docs/_snippets/_S3_authentication_and_bucket.md

Lines changed: 20 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -18,118 +18,78 @@ import s3_g from '@site/static/images/_snippets/s3/s3-g.png';
1818
import s3_h from '@site/static/images/_snippets/s3/s3-h.png';
1919

2020
<details>
21-
<summary>Create S3 buckets and an IAM user</summary>
22-
21+
<summary>Create S3 buckets and an IAM user</summary>
2322
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-
2523
### Create an AWS IAM user {#create-an-aws-iam-user}
2624
In this procedure, we'll be creating a service account user, not a login user.
2725
1. Log into the AWS IAM Management Console.
28-
2926
2. In "users", select **Add users**
30-
3127
<Image size="md" img={s3_1} alt="AWS IAM Management Console - Adding a new user" border force/>
32-
3328
3. Enter the user name and set the credential type to **Access key - Programmatic access** and select **Next: Permissions**
34-
3529
<Image size="md" img={s3_2} alt="Setting user name and access type for IAM user" border force/>
36-
3730
4. Do not add the user to any group; select **Next: Tags**
38-
3931
<Image size="md" img={s3_3} alt="Skipping group assignment for IAM user" border force/>
40-
4132
5. Unless you need to add any tags, select **Next: Review**
42-
4333
<Image size="md" img={s3_4} alt="Skipping tag assignment for IAM user" border force/>
44-
4534
6. Select **Create User**
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-
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+
:::
5138
<Image size="md" img={s3_5} alt="Creating the IAM user with no permissions warning" border force/>
52-
5339
7. The user is now created; click on **show** and copy the access and secret keys.
5440
:::note
5541
Save the keys somewhere else; this is the only time that the secret access key will be available.
5642
:::
57-
5843
<Image size="md" img={s3_6} alt="Viewing and copying the IAM user access keys" border force/>
59-
6044
8. Click close, then find the user in the users screen.
61-
6245
<Image size="md" img={s3_7} alt="Finding the newly created IAM user in the users list" border force/>
63-
6446
9. Copy the ARN (Amazon Resource Name) and save it for use when configuring the access policy for the bucket.
65-
6647
<Image size="md" img={s3_8} alt="Copying the ARN of the IAM user" border force/>
67-
6848
### Create an S3 bucket {#create-an-s3-bucket}
6949
1. In the S3 bucket section, select **Create bucket**
70-
7150
<Image size="md" img={s3_9} alt="Starting the S3 bucket creation process" border force/>
72-
7351
2. Enter a bucket name, leave other options default
7452
:::note
7553
The bucket name must be unique across AWS, not just the organization, or it will emit an error.
7654
:::
7755
3. Leave `Block all Public Access` enabled; public access is not needed.
78-
7956
<Image size="md" img={s3_a} alt="Configuring the S3 bucket settings with public access blocked" border force/>
80-
8157
4. Select **Create Bucket** at the bottom of the page
82-
8358
<Image size="md" img={s3_b} alt="Finalizing S3 bucket creation" border force/>
84-
8559
5. Select the link, copy the ARN, and save it for use when configuring the access policy for the bucket.
86-
8760
6. Once the bucket has been created, find the new S3 bucket in the S3 buckets list and select the link
88-
8961
<Image size="md" img={s3_c} alt="Finding the newly created S3 bucket in the buckets list" border force/>
90-
9162
7. Select **Create folder**
92-
9363
<Image size="md" img={s3_d} alt="Creating a new folder in the S3 bucket" border force/>
94-
9564
8. Enter a folder name that will be the target for the ClickHouse S3 disk and select **Create folder**
96-
9765
<Image size="md" img={s3_e} alt="Setting the folder name for ClickHouse S3 disk usage" border force/>
98-
9966
9. The folder should now be visible on the bucket list
100-
10167
<Image size="md" img={s3_f} alt="Viewing the newly created folder in the S3 bucket" border force/>
102-
10368
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-
10569
<Image size="md" img={s3_g} alt="Copying the S3 folder URL for ClickHouse configuration" border force/>
106-
10770
11. Select the **Permissions** tab and click on the **Edit** button in the **Bucket Policy** section
108-
10971
<Image size="md" img={s3_h} alt="Accessing the S3 bucket policy configuration" border force/>
110-
11172
12. Add a bucket policy, example below:
11273
```json
11374
{
114-
"Version" : "2012-10-17",
115-
"Id" : "Policy123456",
116-
"Statement" : [
117-
{
118-
"Sid" : "abc123",
119-
"Effect" : "Allow",
120-
"Principal" : {
121-
"AWS" : "arn:aws:iam::921234567898:user/mars-s3-user"
122-
},
123-
"Action" : "s3:*",
124-
"Resource" : [
125-
"arn:aws:s3:::mars-doc-test",
126-
"arn:aws:s3:::mars-doc-test/*"
127-
]
128-
}
129-
]
75+
"Version" : "2012-10-17",
76+
"Id" : "Policy123456",
77+
"Statement" : [
78+
{
79+
"Sid" : "abc123",
80+
"Effect" : "Allow",
81+
"Principal" : {
82+
"AWS" : "arn:aws:iam::921234567898:user/mars-s3-user"
83+
},
84+
"Action" : "s3:*",
85+
"Resource" : [
86+
"arn:aws:s3:::mars-doc-test",
87+
"arn:aws:s3:::mars-doc-test/*"
88+
]
89+
}
90+
]
13091
}
13192
```
132-
13393
```response
13494
|Parameter | Description | Example Value |
13595
|----------|-------------|----------------|
@@ -140,13 +100,10 @@ The bucket name must be unique across AWS, not just the organization, or it will
140100
|Action | What operations are allowed on the bucket| s3:*|
141101
|Resource | Which resources in the bucket will operations be allowed in | "arn:aws:s3:::mars-doc-test", "arn:aws:s3:::mars-doc-test/*" |
142102
```
143-
144103
:::note
145104
You should work with your security team to determine the permissions to be used, consider these as a starting point.
146105
For more information on Policies and settings, refer to AWS documentation:
147106
https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-policy-language-overview.html
148107
:::
149-
150108
13. Save the policy configuration.
151-
152109
</details>

docs/_snippets/_add_remote_ip_access_list_detail.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,9 @@ import ip_allow_list_check_list from '@site/static/images/_snippets/ip-allow-lis
33
import ip_allow_list_add_current_ip from '@site/static/images/_snippets/ip-allow-list-add-current-ip.png';
44

55
<details>
6-
<summary>Manage your IP Access List</summary>
7-
6+
<summary>Manage your IP Access List</summary>
87
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-
108
<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 />
11-
129
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-
1410
<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 />
15-
1611
</details>
Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,30 @@
11
<details>
2-
<summary>Launch Apache Superset in Docker</summary>
3-
2+
<summary>Launch Apache Superset in Docker</summary>
43
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-
64
There are a few tasks to be done before running `docker compose`:
7-
85
1. Add the official ClickHouse Connect driver
96
2. Obtain a Mapbox API key and add that as an environment variable (optional)
107
3. Specify the version of Superset to run
11-
128
:::tip
139
The commands below are to be run from the top level of the GitHub repo, `superset`.
1410
:::
15-
1611
## Official ClickHouse connect driver {#official-clickhouse-connect-driver}
17-
1812
To make the ClickHouse Connect driver available in the Superset deployment add it to the local requirements file:
19-
2013
```bash
2114
echo "clickhouse-connect" >> ./docker/requirements-local.txt
2215
```
23-
2416
## Mapbox {#mapbox}
25-
2617
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-
2818
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.
29-
3019
Make the API key available to Superset:
31-
3220
```bash
3321
echo "MAPBOX_API_KEY=pk.SAMPLE-Use-your-key-instead" >> docker/.env-non-dev
3422
```
35-
3623
## Deploy Superset version 2.0.0 {#deploy-superset-version-200}
37-
3824
To deploy release 2.0.0 run:
39-
4025
```bash
4126
git checkout 2.0.0
4227
TAG=2.0.0 docker-compose -f docker-compose-non-dev.yml pull
4328
TAG=2.0.0 docker-compose -f docker-compose-non-dev.yml up
4429
```
45-
4630
</details>
47-

0 commit comments

Comments
 (0)