Skip to content

Commit 107c084

Browse files
authored
Merge branch 'main' into prod-readiness
2 parents add1b9f + 1ddcf5a commit 107c084

File tree

68 files changed

+3075
-348
lines changed

Some content is hidden

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

68 files changed

+3075
-348
lines changed

docs/cloud/features/01_cloud_tiers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This page discusses which tiers are right for your specific use case.
2323
<th>[Enterprise](#enterprise)</th>
2424
</tr></thead>
2525
<tbody>
26-
<tr>
26+
<tr className="table-category-header">
2727
<td>**Service Features**</td>
2828
<td colspan="3"></td>
2929
</tr>
@@ -105,7 +105,7 @@ This page discusses which tiers are right for your specific use case.
105105
<td></td>
106106
<td>✓</td>
107107
</tr>
108-
<tr>
108+
<tr className="table-category-header">
109109
<td>**Security**</td>
110110
<td colspan="3"></td>
111111
</tr>

docs/cloud/features/05_admin_features/api/openapi.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ This document covers the ClickHouse Cloud API. For database API endpoints, pleas
3434
<br/>
3535
:::note
3636
Permissions align with ClickHouse Cloud [predefined roles](/cloud/security/console-roles). The developer role has read-only permissions for assigned services and the admin role has full read and write permissions.
37+
:::
38+
39+
:::tip Query API Endpoints
40+
To use API keys with [Query API Endpoints](/cloud/get-started/query-endpoints), set Organization Role to `Member` (minimum) and grant Service Role access to `Query Endpoints`.
3741
:::
3842

3943
<Image img={image_03} size="md" alt="Create API key form" border/>

docs/cloud/guides/SQL_console/query-endpoints.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,15 @@ The **Query API Endpoints** feature allows you to create an API endpoint directl
2424
## Pre-requisites {#quick-start-guide}
2525

2626
Before proceeding, ensure you have:
27-
- an API key
28-
- an Admin Console Role.
27+
- An API key with appropriate permissions
28+
- An Admin Console Role
2929

3030
You can follow this guide to [create an API key](/cloud/manage/openapi) if you don't yet have one.
3131

32+
:::note Minimum permissions
33+
To query an API endpoint, the API key needs `Member` organization role with `Query Endpoints` service access. The database role is configured when you create the endpoint.
34+
:::
35+
3236
<VerticalStepper headerLevel="h3">
3337

3438
### Create a saved query {#creating-a-saved-query}

docs/cloud/reference/01_changelog/01_changelog.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,22 @@ import dashboards from '@site/static/images/cloud/reference/may-30-dashboards.pn
3333

3434
In addition to this ClickHouse Cloud changelog, please see the [Cloud Compatibility](/whats-new/cloud-compatibility) page.
3535

36+
:::tip[Automatically keep up to date!]
37+
<a href="/docs/cloud/changelog-rss.xml">
38+
Subscribe to Cloud Changelog via RSS
39+
</a>
40+
:::
41+
42+
## November 7, 2025 {#november-7-2025}
43+
44+
- ClickHouse Cloud console now supports configuring replica sizes in increments of 1 vCPU, 4 GiB from the cloud console.
45+
These options are available both when setting up a new service as well as when setting minimum and maximum replica sizes on the settings page.
46+
- Custom hardware profiles (available on the Enterprise tier) now support idling.
47+
- ClickHouse Cloud now offers a simplified purchasing experience through AWS Marketplace, with separate options for [pay-as-you-go](https://aws.amazon.com/marketplace/pp/prodview-p4gwofrqpkltu?sr=0-2&ref_=beagle&applicationId=AWSMPContessa) and [committed spend contracts](https://aws.amazon.com/marketplace/pp/prodview-4qyeihstyym2s?sr=0-3&ref_=beagle&applicationId=AWSMPContessa).
48+
- Alerting is now available for ClickStack users in ClickHouse Cloud.
49+
Users can now create and manage alerts directly in the HyperDX UI, across logs, metrics, and traces with no extra setup, no extra infra or service, and no config. Alerts integrate with Slack, PagerDuty, and more.
50+
For more information see the [alerting documentation](/use-cases/observability/clickstack/alerts).
51+
3652
## October 17, 2025 {#october-17-2025}
3753

3854
- **Service Monitoring - Resource Utilization Dashboard**

docs/cloud/reference/03_billing/02_marketplace/aws-marketplace-payg.md

Lines changed: 43 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,6 @@ import aws_marketplace_payg_6 from '@site/static/images/cloud/manage/billing/mar
1515
import aws_marketplace_payg_7 from '@site/static/images/cloud/manage/billing/marketplace/aws-marketplace-payg-7.png';
1616
import aws_marketplace_payg_8 from '@site/static/images/cloud/manage/billing/marketplace/aws-marketplace-payg-8.png';
1717
import aws_marketplace_payg_9 from '@site/static/images/cloud/manage/billing/marketplace/aws-marketplace-payg-9.png';
18-
import aws_marketplace_payg_10 from '@site/static/images/cloud/manage/billing/marketplace/aws-marketplace-payg-10.png';
19-
import aws_marketplace_payg_11 from '@site/static/images/cloud/manage/billing/marketplace/aws-marketplace-payg-11.png';
20-
import aws_marketplace_payg_12 from '@site/static/images/cloud/manage/billing/marketplace/aws-marketplace-payg-12.png';
2118
import Image from '@theme/IdealImage';
2219

2320
Get started with ClickHouse Cloud on the [AWS Marketplace](https://aws.amazon.com/marketplace) via a PAYG (Pay-as-you-go) Public Offer.
@@ -26,112 +23,83 @@ Get started with ClickHouse Cloud on the [AWS Marketplace](https://aws.amazon.co
2623

2724
- An AWS account that is enabled with purchasing rights by your billing administrator.
2825
- To purchase, you must be logged into the AWS marketplace with this account.
26+
- To connect a ClickHouse organization to your subscription, you must be an admin of that organization.
2927

30-
## Steps to sign up {#steps-to-sign-up}
31-
32-
1. Go to the [AWS Marketplace](https://aws.amazon.com/marketplace) and search for ClickHouse Cloud.
33-
34-
<br />
35-
36-
<Image img={aws_marketplace_payg_1} size="md" alt="AWS Marketplace home page" border/>
37-
38-
<br />
39-
40-
2. Click on the [listing](https://aws.amazon.com/marketplace/pp/prodview-jettukeanwrfc) and then on **View purchase options**.
41-
42-
<br />
43-
44-
<Image img={aws_marketplace_payg_2} size="md" alt="AWS Marketplace search for ClickHouse" border/>
45-
46-
<br />
47-
48-
3. On the next screen, configure the contract:
49-
- **Length of contract** - PAYG contracts run month to month.
50-
- **Renewal settings** - You can set the contract to auto-renew or not.
51-
Note that we strongly recommend keeping your subscription set to auto-renew every month. However, if you don't enable auto renewal, your organization is automatically put into a grace period at the end of the billing cycle and then decommissioned.
28+
:::note
29+
One AWS account can only subscribe to one “ClickHouse Cloud - Pay As You Go” subscription which can only be linked to one ClickHouse organization.
30+
:::
5231

53-
- **Contract options** - You can input any number (or just 1) into this text box. This will not affect the price you pay as the price for these units for the public offer is $0. These units are usually used when accepting a private offer from ClickHouse Cloud.
54-
55-
- **Purchase order** - This is optional and you can ignore this.
56-
57-
<br />
58-
59-
<Image img={aws_marketplace_payg_3} size="md" alt="AWS Marketplace configure contract" border/>
60-
61-
<br />
62-
63-
After filling out the above information, click on **Create Contract**. You can confirm that the contract price displayed is zero dollars which essentially means that you have no payment due and will incur charges based on usage.
64-
65-
<br />
32+
## Steps to sign up {#steps-to-sign-up}
6633

67-
<Image img={aws_marketplace_payg_4} size="md" alt="AWS Marketplace confirm contract" border/>
34+
<VerticalStepper headerLevel="h3">
6835

69-
<br />
36+
### Search for Clickhouse Cloud - Pay As You Go {#search-payg}
7037

71-
4. Once you click **Create Contract**, you will see a modal to confirm and pay ($0 due).
38+
Go to the [AWS Marketplace](https://aws.amazon.com/marketplace) and search for “ClickHouse Cloud - Pay As You Go”.
7239

73-
5. Once you click **Pay now**, you will see a confirmation that you are now subscribed to the AWS Marketplace offering for ClickHouse Cloud.
40+
<Image img={aws_marketplace_payg_1} alt="AWS Marketplace search for ClickHouse" border/>
7441

75-
<br />
42+
### View purchase options {#purchase-options}
7643

77-
<Image img={aws_marketplace_payg_5} size="md" alt="AWS Marketplace payment confirmation" border/>
44+
Click on the [listing](https://aws.amazon.com/marketplace/pp/prodview-p4gwofrqpkltu) and then on **View purchase options**.
7845

79-
<br />
46+
<Image img={aws_marketplace_payg_2} alt="AWS Marketplace view purchase options" border/>
8047

81-
6. Note that at this point, the setup is not complete yet. You will need to redirect to ClickHouse Cloud by clicking on **Set up your account** and signing up on ClickHouse Cloud.
48+
### Subscribe {#subscribe}
8249

83-
7. Once you redirect to ClickHouse Cloud, you can either login with an existing account, or register with a new account. This step is very important so we can bind your ClickHouse Cloud organization to the AWS Marketplace billing.
50+
On the next screen, click subscribe.
8451

85-
<br />
52+
:::note
53+
**Purchase order (PO) number** is optional and can be ignored.
54+
:::
8655

87-
<Image img={aws_marketplace_payg_6} size="md" alt="ClickHouse Cloud sign in page" border/>
56+
<Image img={aws_marketplace_payg_3} alt="AWS Marketplace subscribe" border/>
8857

89-
<br />
58+
### Set up your account {#set-up-your-account}
9059

91-
If you are a new ClickHouse Cloud user, click **Register** at the bottom of the page. You will be prompted to create a new user and verify the email. After verifying your email, you can leave the ClickHouse Cloud login page and login using the new username at the [https://console.clickhouse.cloud](https://console.clickhouse.cloud).
60+
Note that at this point, the setup is not complete and your ClickHouse Cloud organization is not being billed through the marketplace yet. You will now need to click on Set up your account on your marketplace subscription to redirect to ClickHouse Cloud to finish setup.
9261

93-
<br />
62+
<Image img={aws_marketplace_payg_4} alt="Set up your account" border/>
9463

95-
<Image img={aws_marketplace_payg_7} size="md" alt="ClickHouse Cloud sign up page" border/>
64+
Once you redirect to ClickHouse Cloud, you can either login with an existing account, or register with a new account. This step is very important so we can bind your ClickHouse Cloud organization to your AWS Marketplace billing.
9665

97-
<br />
66+
:::note[New Clickhouse Cloud Users]
67+
If you are a new ClickHouse Cloud user, follow the steps below.
68+
:::
9869

99-
Note that if you are a new user, you will also need to provide some basic information about your business. See the screenshots below.
70+
<details>
71+
<summary><strong>Steps for new users</strong></summary>
10072

101-
<br />
73+
If you are a new ClickHouse Cloud user, click Register at the bottom of the page. You will be prompted to create a new user and verify the email. After verifying your email, you can leave the ClickHouse Cloud login page and login using the new username at the https://console.clickhouse.cloud.
10274

103-
<Image img={aws_marketplace_payg_8} size="md" alt="ClickHouse Cloud sign up info form" border/>
75+
<Image img={aws_marketplace_payg_5} size="md" alt="Clickhouse Cloud sign-up"/>
10476

105-
<br />
77+
:::note[New users]
78+
You will also need to provide some basic information about your business. See the screenshots below.
79+
:::
10680

107-
<br />
81+
<Image img={aws_marketplace_payg_6} size="md" alt="Before you start"/>
10882

109-
<Image img={aws_marketplace_payg_9} size="md" alt="ClickHouse Cloud sign up info form 2" border/>
83+
<Image img={aws_marketplace_payg_7} size="md" alt="Before you star continued"/>
11084

111-
<br />
85+
</details>
11286

11387
If you are an existing ClickHouse Cloud user, simply log in using your credentials.
11488

115-
8. After successfully logging in, a new ClickHouse Cloud organization will be created. This organization will be connected to your AWS billing account and all usage will be billed via your AWS account.
116-
117-
9. Once you login, you can confirm that your billing is in fact tied to the AWS Marketplace and start setting up your ClickHouse Cloud resources.
118-
119-
<br />
120-
121-
<Image img={aws_marketplace_payg_10} size="md" alt="ClickHouse Cloud view AWS Marketplace billing" border/>
89+
### Add the Marketplace Subscription to an Organization {#add-marketplace-subscription}
12290

123-
<br />
91+
After successfully logging in, you can decide whether to create a new organization to bill to this marketplace subscription or choose an existing organization to bill to this subscription.
12492

125-
<Image img={aws_marketplace_payg_11} size="md" alt="ClickHouse Cloud new services page" border/>
93+
<Image img={aws_marketplace_payg_8} size="md" alt="Add marketplace subscription" border/>
12694

127-
<br />
95+
After completing this step your organization will be connected to this AWS subscription and all usage will be billed via your AWS account.
12896

129-
10. You should receive an email confirming the sign up:
97+
You can confirm from the organization's billing page in the ClickHouse UI that billing is indeed now linked to the AWS marketplace.
13098

131-
<br />
99+
<Image img={aws_marketplace_payg_9} size="lg" alt="Confirm billing page" border/>
132100

133-
<Image img={aws_marketplace_payg_12} size="md" alt="AWS Marketplace confirmation email" border/>
101+
</VerticalStepper>
134102

135-
<br />
103+
## Support {#support}
136104

137105
If you run into any issues, please do not hesitate to contact [our support team](https://clickhouse.com/support/program).

docs/cloud/reference/03_billing/02_marketplace/azure-marketplace-committed.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Get started with ClickHouse Cloud on the [Azure Marketplace](https://azuremarket
3737

3838
<br />
3939

40-
2. Click on the **Review Private Offer** link in the email. This should take you to your GCP Marketplace page with the private offer details.
40+
2. Click on the **Review Private Offer** link in the email. This should take you to your Azure Marketplace page with the private offer details.
4141

4242
<br />
4343

docs/cloud/reference/05_supported-regions.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,13 @@ Additional requirements may apply for HIPAA compliance (including signing a BAA)
8282
<EnterprisePlanFeatureBadge feature="HIPAA" support="true"/>
8383

8484
Customers must sign a Business Associate Agreement (BAA) and request onboarding through Sales or Support to set up services in HIPAA compliant regions. The following regions support HIPAA compliance:
85+
- AWS af-south-1 (South Africa) **Private Region**
86+
- AWS ca-central-1 (Canada) **Private Region**
8587
- AWS eu-central-1 (Frankfurt)
88+
- AWS eu-north-1 (Stockholm) **Private Region**
89+
- AWS eu-west-1 (Ireland)
8690
- AWS eu-west-2 (London)
91+
- AWS sa-east-1 (South America) **Private Region**
8792
- AWS us-east-1 (N. Virginia)
8893
- AWS us-east-2 (Ohio)
8994
- AWS us-west-2 (Oregon)
@@ -96,8 +101,13 @@ Customers must sign a Business Associate Agreement (BAA) and request onboarding
96101
<EnterprisePlanFeatureBadge feature="PCI" support="true"/>
97102

98103
Customers must request onboarding through Sales or Support to set up services in PCI compliant regions. The following regions support PCI compliance:
104+
- AWS af-south-1 (South Africa) **Private Region**
105+
- AWS ca-central-1 (Canada) **Private Region**
99106
- AWS eu-central-1 (Frankfurt)
107+
- AWS eu-north-1 (Stockholm) **Private Region**
108+
- AWS eu-west-1 (Ireland)
100109
- AWS eu-west-2 (London)
110+
- AWS sa-east-1 (South America) **Private Region**
101111
- AWS us-east-1 (N. Virginia)
102112
- AWS us-east-2 (Ohio)
103113
- AWS us-west-2 (Oregon)

docs/deployment-guides/replication-sharding-examples/01_1_shard_2_replicas.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -392,9 +392,9 @@ In this example, each `users.xml` file is identical for all nodes in the cluster
392392

393393
| Directory | File |
394394
|------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
395-
| `fs/volumes/clickhouse-keeper-01/etc/clickhouse-server/config.d` | [`keeper_config.xml`](https://github.com/ClickHouse/examples/blob/main/docker-compose-recipes/recipes/cluster_1S_2R/fs/volumes/clickhouse-keeper-01/etc/clickhouse-keeper/keeper_config.xml) |
396-
| `fs/volumes/clickhouse-keeper-02/etc/clickhouse-server/config.d` | [`keeper_config.xml`](https://github.com/ClickHouse/examples/blob/main/docker-compose-recipes/recipes/cluster_1S_2R/fs/volumes/clickhouse-keeper-02/etc/clickhouse-keeper/keeper_config.xml) |
397-
| `fs/volumes/clickhouse-keeper-03/etc/clickhouse-server/config.d` | [`keeper_config.xml`](https://github.com/ClickHouse/examples/blob/main/docker-compose-recipes/recipes/cluster_1S_2R/fs/volumes/clickhouse-keeper-03/etc/clickhouse-keeper/keeper_config.xml) |
395+
| `fs/volumes/clickhouse-keeper-01/etc/clickhouse-keeper` | [`keeper_config.xml`](https://github.com/ClickHouse/examples/blob/main/docker-compose-recipes/recipes/cluster_1S_2R/fs/volumes/clickhouse-keeper-01/etc/clickhouse-keeper/keeper_config.xml) |
396+
| `fs/volumes/clickhouse-keeper-02/etc/clickhouse-keeper` | [`keeper_config.xml`](https://github.com/ClickHouse/examples/blob/main/docker-compose-recipes/recipes/cluster_1S_2R/fs/volumes/clickhouse-keeper-02/etc/clickhouse-keeper/keeper_config.xml) |
397+
| `fs/volumes/clickhouse-keeper-03/etc/clickhouse-keeper` | [`keeper_config.xml`](https://github.com/ClickHouse/examples/blob/main/docker-compose-recipes/recipes/cluster_1S_2R/fs/volumes/clickhouse-keeper-03/etc/clickhouse-keeper/keeper_config.xml) |
398398

399399
<KeeperConfigExplanation/>
400400

docs/deployment-guides/replication-sharding-examples/02_2_shards_1_replica.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -410,9 +410,9 @@ In this example, each `users.xml` file is identical for all nodes in the cluster
410410

411411
| Directory | File |
412412
|------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
413-
| `fs/volumes/clickhouse-keeper-01/etc/clickhouse-server/config.d` | [`keeper_config.xml`](https://github.com/ClickHouse/examples/blob/main/docker-compose-recipes/recipes/cluster_2S_1R/fs/volumes/clickhouse-keeper-01/etc/clickhouse-keeper/keeper_config.xml) |
414-
| `fs/volumes/clickhouse-keeper-02/etc/clickhouse-server/config.d` | [`keeper_config.xml`](https://github.com/ClickHouse/examples/blob/main/docker-compose-recipes/recipes/cluster_2S_1R/fs/volumes/clickhouse-keeper-02/etc/clickhouse-keeper/keeper_config.xml) |
415-
| `fs/volumes/clickhouse-keeper-03/etc/clickhouse-server/config.d` | [`keeper_config.xml`](https://github.com/ClickHouse/examples/blob/main/docker-compose-recipes/recipes/cluster_2S_1R/fs/volumes/clickhouse-keeper-03/etc/clickhouse-keeper/keeper_config.xml) |
413+
| `fs/volumes/clickhouse-keeper-01/etc/clickhouse-keeper` | [`keeper_config.xml`](https://github.com/ClickHouse/examples/blob/main/docker-compose-recipes/recipes/cluster_2S_1R/fs/volumes/clickhouse-keeper-01/etc/clickhouse-keeper/keeper_config.xml) |
414+
| `fs/volumes/clickhouse-keeper-02/etc/clickhouse-keeper` | [`keeper_config.xml`](https://github.com/ClickHouse/examples/blob/main/docker-compose-recipes/recipes/cluster_2S_1R/fs/volumes/clickhouse-keeper-02/etc/clickhouse-keeper/keeper_config.xml) |
415+
| `fs/volumes/clickhouse-keeper-03/etc/clickhouse-keeper` | [`keeper_config.xml`](https://github.com/ClickHouse/examples/blob/main/docker-compose-recipes/recipes/cluster_2S_1R/fs/volumes/clickhouse-keeper-03/etc/clickhouse-keeper/keeper_config.xml) |
416416

417417
<KeeperConfigExplanation/>
418418

0 commit comments

Comments
 (0)