Skip to content

Enforcing Markdown rules, list item indentation, cleaning up extra spaces (MD007, MD012). #4079

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .vale.ini
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
StylesPath = styles
MinAlertLevel = suggestion
MinAlertLevel = warning

[*.{md}]
BasedOnStyles = ClickHouse
2 changes: 1 addition & 1 deletion docs/_placeholders/api/_invitations-api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ title: Invitations

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

This file is generated by `clickhouseapi.js` during the build process. If the
This file is generated by `clickhouseapi.js` during the build process. If the
content needs changing please edit `clickhouseapi.js`.
2 changes: 1 addition & 1 deletion docs/_placeholders/api/_keys-api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ title: Keys

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

This file is generated by `clickhouseapi.js` during the build process. If the
This file is generated by `clickhouseapi.js` during the build process. If the
content needs changing please edit `clickhouseapi.js`.
2 changes: 1 addition & 1 deletion docs/_placeholders/api/_members-api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ title: Members

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

This file is generated by `clickhouseapi.js` during the build process. If the
This file is generated by `clickhouseapi.js` during the build process. If the
content needs changing please edit `clickhouseapi.js`.
2 changes: 1 addition & 1 deletion docs/_placeholders/api/_organizations-api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ title: Organizations

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

This file is generated by `clickhouseapi.js` during the build process. If the
This file is generated by `clickhouseapi.js` during the build process. If the
content needs changing please edit `clickhouseapi.js`.
2 changes: 1 addition & 1 deletion docs/_placeholders/api/_services-api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ title: Services

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

This file is generated by `clickhouseapi.js` during the build process. If the
This file is generated by `clickhouseapi.js` during the build process. If the
content needs changing please edit `clickhouseapi.js`.
22 changes: 1 addition & 21 deletions docs/_snippets/_GCS_authentication_and_bucket.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,44 +9,24 @@
import Image from '@theme/IdealImage';

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

<summary>Create GCS buckets and an HMAC key</summary>
### ch_bucket_us_east1 {#ch_bucket_us_east1}

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

### ch_bucket_us_east4 {#ch_bucket_us_east4}

<Image size="md" img={GCS_bucket_2} alt="Creating a GCS bucket in US East 4" border />

### Generate an access key {#generate-an-access-key}

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

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.

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

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

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

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

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

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

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

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

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

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

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

Check warning on line 30 in docs/_snippets/_GCS_authentication_and_bucket.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.FutureTense

Instead of future tense 'will be', use present tense.

Check warning on line 30 in docs/_snippets/_GCS_authentication_and_bucket.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.FutureTense

Instead of future tense 'will be', use present tense.

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

</details>
85 changes: 21 additions & 64 deletions docs/_snippets/_S3_authentication_and_bucket.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,118 +18,78 @@
import s3_h from '@site/static/images/_snippets/s3/s3-h.png';

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

<summary>Create S3 buckets and an IAM user</summary>
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.

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

1. Log into the AWS IAM Management Console.
2. In "users", select **Add users**

Check warning on line 26 in docs/_snippets/_S3_authentication_and_bucket.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.Quotes

Commas and periods go inside quotation marks.

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

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

Check warning on line 28 in docs/_snippets/_S3_authentication_and_bucket.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.Colons

': P' should be in lowercase.

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

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

Check warning on line 30 in docs/_snippets/_S3_authentication_and_bucket.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.Colons

': T' should be in lowercase.

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

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

Check warning on line 32 in docs/_snippets/_S3_authentication_and_bucket.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.Colons

': R' should be in lowercase.

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

6. Select **Create User**

:::note
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
:::

:::note
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
:::
<Image size="md" img={s3_5} alt="Creating the IAM user with no permissions warning" border force/>

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

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

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

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

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

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

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

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

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

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

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

<Image size="md" img={s3_b} alt="Finalizing S3 bucket creation" border force/>

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

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

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

7. Select **Create folder**

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

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

Check warning on line 64 in docs/_snippets/_S3_authentication_and_bucket.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.FutureTense

Instead of future tense 'will be', use present tense.

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

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

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

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.

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

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

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

12. Add a bucket policy, example below:
```json
{
"Version" : "2012-10-17",
"Id" : "Policy123456",
"Statement" : [
{
"Sid" : "abc123",
"Effect" : "Allow",
"Principal" : {
"AWS" : "arn:aws:iam::921234567898:user/mars-s3-user"
},
"Action" : "s3:*",
"Resource" : [
"arn:aws:s3:::mars-doc-test",
"arn:aws:s3:::mars-doc-test/*"
]
}
]
"Version" : "2012-10-17",

Check warning on line 75 in docs/_snippets/_S3_authentication_and_bucket.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.Quotes

Commas and periods go inside quotation marks.
"Id" : "Policy123456",
"Statement" : [
{
"Sid" : "abc123",
"Effect" : "Allow",
"Principal" : {
"AWS" : "arn:aws:iam::921234567898:user/mars-s3-user"
},
"Action" : "s3:*",
"Resource" : [
"arn:aws:s3:::mars-doc-test",
"arn:aws:s3:::mars-doc-test/*"
]
}
]
}
```

```response
|Parameter | Description | Example Value |
|----------|-------------|----------------|
Expand All @@ -140,13 +100,10 @@
|Action | What operations are allowed on the bucket| s3:*|
|Resource | Which resources in the bucket will operations be allowed in | "arn:aws:s3:::mars-doc-test", "arn:aws:s3:::mars-doc-test/*" |
```

:::note
You should work with your security team to determine the permissions to be used, consider these as a starting point.
For more information on Policies and settings, refer to AWS documentation:
https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-policy-language-overview.html
:::

13. Save the policy configuration.

</details>
7 changes: 1 addition & 6 deletions docs/_snippets/_add_remote_ip_access_list_detail.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,9 @@
import ip_allow_list_add_current_ip from '@site/static/images/_snippets/ip-allow-list-add-current-ip.png';

<details>
<summary>Manage your IP Access List</summary>

<summary>Manage your IP Access List</summary>
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**:

Check warning on line 7 in docs/_snippets/_add_remote_ip_access_list_detail.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.FutureTense

Instead of future tense 'will work', use present tense.

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

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

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

</details>
19 changes: 1 addition & 18 deletions docs/_snippets/_add_superset_detail.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,30 @@
<details>
<summary>Launch Apache Superset in Docker</summary>

<summary>Launch Apache Superset in Docker</summary>
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`.

There are a few tasks to be done before running `docker compose`:

1. Add the official ClickHouse Connect driver
2. Obtain a Mapbox API key and add that as an environment variable (optional)
3. Specify the version of Superset to run

:::tip
The commands below are to be run from the top level of the GitHub repo, `superset`.
:::

## Official ClickHouse connect driver {#official-clickhouse-connect-driver}

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

```bash
echo "clickhouse-connect" >> ./docker/requirements-local.txt
```

## Mapbox {#mapbox}

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.

Check warning on line 17 in docs/_snippets/_add_superset_detail.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.OxfordComma

Use a comma before the last 'and' or 'or' in a list of four or more items.

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.

Make the API key available to Superset:

```bash
echo "MAPBOX_API_KEY=pk.SAMPLE-Use-your-key-instead" >> docker/.env-non-dev
```

## Deploy Superset version 2.0.0 {#deploy-superset-version-200}

To deploy release 2.0.0 run:

```bash
git checkout 2.0.0
TAG=2.0.0 docker-compose -f docker-compose-non-dev.yml pull
TAG=2.0.0 docker-compose -f docker-compose-non-dev.yml up
```

</details>

4 changes: 0 additions & 4 deletions docs/_snippets/_aws_regions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,3 @@
|us-east-1 c1 | com.amazonaws.vpce.us-east-1.vpce-svc-096c118db1ff20ea4 | use1-az6 use1-az4 use1-az2 |
|us-east-2 | com.amazonaws.vpce.us-east-2.vpce-svc-0b99748bf269a86b4 | use2-az1 use2-az2 use2-az3 |
|us-west-2 | com.amazonaws.vpce.us-west-2.vpce-svc-049bbd33f61271781 | usw2-az2 usw2-az1 usw2-az3 |




20 changes: 6 additions & 14 deletions docs/_snippets/_clickhouse_mysql_cloud_setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,34 +7,26 @@ import Image from '@theme/IdealImage';

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

<Image size="md" img={mysql_1} alt="ClickHouse Cloud credentials screen showing MySQL interface selection dropdown" border />

<Image size="md" img={mysql_1} alt="ClickHouse Cloud credentials screen showing MySQL interface selection dropdown" border />

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.

<Image size="md" img={mysql_2} alt="ClickHouse Cloud MySQL interface enabling toggle and connection details" border />
<br/>
<Image size="md" img={mysql_2} alt="ClickHouse Cloud MySQL interface enabling toggle and connection details" border />

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

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:

<br/>
<Image size="md" img={mysql_3} alt="ClickHouse Cloud service connection screen with Connect option highlighted" border />
<br/>

<Image size="md" img={mysql_3} alt="ClickHouse Cloud service connection screen with Connect option highlighted" border />

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

<br/>
<Image size="md" img={mysql_4} alt="ClickHouse Cloud connection screen showing MySQL option selection" border />
<br/>
<Image size="md" img={mysql_4} alt="ClickHouse Cloud connection screen showing MySQL option selection" border />

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.

<Image size="md" img={mysql_5} alt="ClickHouse Cloud connection screen with MySQL interface enabled showing connection details" border />
<Image size="md" img={mysql_5} alt="ClickHouse Cloud connection screen with MySQL interface enabled showing connection details" border />

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

Expand Down
2 changes: 1 addition & 1 deletion docs/_snippets/_clickhouse_mysql_on_premise_setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,5 +89,5 @@ Read 4 rows, 603.00 B in 0.00156 sec., 2564 rows/sec., 377.48 KiB/sec.
Finally, configure the Clickhouse Server to listen on the desired IP address(es). For example, in `config.xml`, uncomment out the following to listen on all addresses:

```bash
<listen_host>::</listen_host>
<listen_host>::</listen_host>
```
4 changes: 2 additions & 2 deletions docs/_snippets/_config-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ When configuring ClickHouse Server by adding or editing configuration files you
- Add files to `/etc/clickhouse-server/config.d/` directory
- Add files to `/etc/clickhouse-server/users.d/` directory
- Leave the `/etc/clickhouse-server/config.xml` file as it is
- Leave the `/etc/clickhouse-server/users.xml` file as it is
:::
- Leave the `/etc/clickhouse-server/users.xml` file as it is
:::
10 changes: 5 additions & 5 deletions docs/_snippets/_gather_your_details_http.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ To connect to ClickHouse with HTTP(S) you need this information:

- The USERNAME and PASSWORD: out of the box, the username is `default`. Use the username appropriate for your use case.

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

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

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

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

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