Skip to content

Commit 58ccb0e

Browse files
committed
Merge branch 'main' of https://github.com/ClickHouse/clickhouse-docs into ec2-host-logs
2 parents ab4ba37 + 4698586 commit 58ccb0e

34 files changed

+1111
-180
lines changed

.vale.ini

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
StylesPath = styles
2-
MinAlertLevel = warning
32

4-
[*.{md}]
3+
# Exclude with more specific patterns
4+
# [!docs/engines/**/*.md]
5+
# [!docs/development/**/*.md]
6+
# [!docs/interfaces/**/*.md]
7+
# [!docs/operations/**/*.md]
8+
# [!docs/sql-reference/**/*.md]
9+
[!docs/whats-new/**/*.md]
10+
[!docs/releases/**/*.md]
11+
12+
# Only check .md files (not .mdx)
13+
[docs/**/*.md]
514
BasedOnStyles = ClickHouse
15+
16+
ClickHouse.SentenceLength = NO
17+
ClickHouse.FutureTense = NO

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,11 @@ In addition to this ClickHouse Cloud changelog, please see the [Cloud Compatibil
3939
</a>
4040
:::
4141

42+
## November 21, 2025 {#november-21-2025}
43+
44+
- ClickHouse Cloud is now available in **AWS Israel (Tel Aviv) — il-central-1**
45+
- Improved the marketplace onboarding experience for setting up ClickHouse organizations to bill to marketplace pay-as-you-go subscriptions or private offers.
46+
4247
## November 14, 2025 {#november-14-2025}
4348
- We’re excited to announce that **ClickHouse Cloud** is now available in **two additional public regions**:
4449
- **GCP Japan (asia-northeast1)**

docs/cloud/reference/01_changelog/02_release_notes/25_08.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ doc_type: 'changelog'
4747
### Security and permissions {#security-and-permissions}
4848

4949
* `SYSTEM RESTART REPLICAS` will only restart replicas in the databases where you have permission to `SHOW TABLES`. Previously the query led to the wakeup of tables in the Lazy database, even without access to that database, while these tables were being concurrently dropped. [#83321](https://github.com/ClickHouse/ClickHouse/pull/83321) ([Alexey Milovidov](https://github.com/alexey-milovidov)).
50-
* Functions `azureBlobStorage`, `deltaLakeAzure`, and `icebergAzure` have been updated to properly validate `AZURE` permissions. All cluster-variant functions (`-Cluster` functions) now verify permissions against their corresponding non-clustered counterparts. Additionally, the `icebergLocal` and `deltaLakeLocal` functions now enforce `FILE` permission checks. [#84938](https://github.com/ClickHouse/ClickHouse/pull/84938) ([Nikita Mikhaylov](https://github.com/nikitamikhaylov
50+
* Functions `azureBlobStorage`, `deltaLakeAzure`, and `icebergAzure` have been updated to properly validate `AZURE` permissions. All cluster-variant functions (`-Cluster` functions) now verify permissions against their corresponding non-clustered counterparts. To prevent permission errors, make sure users invoking the `-Cluster` functions have the appropriate privileges (e.g., `GRANT S3 ON *.* TO user`). Additionally, the `icebergLocal` and `deltaLakeLocal` functions now enforce `FILE` permission checks. [#84938](https://github.com/ClickHouse/ClickHouse/pull/84938) ([Nikita Mikhaylov](https://github.com/nikitamikhaylov
5151

5252
## New features {#new-feature}
5353

docs/cloud/reference/03_billing/06_billing_compliance.md

Lines changed: 52 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ import Image from '@theme/IdealImage';
1414

1515
## Billing compliance {#billing-compliance}
1616

17-
Your use of ClickHouse Cloud requires your organization to have an active and
18-
valid billing method configured. After your 30 day trial ends or your trial
19-
credits are depleted, whichever occurs first, you have the following billing
17+
Your use of ClickHouse Cloud requires your organization to have an active and
18+
valid billing method configured. After your 30 day trial ends or your trial
19+
credits are depleted, whichever occurs first, you have the following billing
2020
options to continue using ClickHouse Cloud:
2121

2222
| Billing option | Description |
@@ -26,10 +26,10 @@ options to continue using ClickHouse Cloud:
2626
| [Committed spend contract](#committed-spend-contract) | Enter into a committed spend contract directly or through a supported cloud marketplace |
2727

2828
If your trial ends and no billing option has been configured for your organization,
29-
all your services will be stopped. If a billing method still has not been
29+
all your services will be stopped. If a billing method still hasn't been
3030
configured after two weeks, all your data will be deleted.
3131

32-
ClickHouse charges for services at the organization level. If we are ever unable
32+
ClickHouse charges for services at the organization level. If we're ever unable
3333
to process a payment using your current billing method, you must update it to one
3434
of the three options listed above to avoid service disruption. See below for more
3535
details about payment compliance based on your chosen billing method.
@@ -41,111 +41,109 @@ To add a credit card, follow these [instructions](#add-credit-card).
4141

4242
Your monthly billing cycle for ClickHouse begins on the day the organization tier
4343
(Basic, Scale, or Enterprise) is selected, and the first service is created within
44-
the organization.
44+
the organization.
4545

46-
The credit card on file normally will be charged at the end of your monthly
46+
The credit card on file normally will be charged at the end of your monthly
4747
billing cycle, but payment charges will be accelerated if the intracycle amount
4848
due reaches $10,000 USD (more info on payment thresholds [here](/cloud/billing/payment-thresholds)).
4949

50-
The credit card on file must be valid, not expired, and have enough available
51-
credit to cover your invoice total. If, for any reason, we are unable to charge
50+
The credit card on file must be valid, not expired, and have enough available
51+
credit to cover your invoice total. If, for any reason, we're unable to charge
5252
the full amount due, the following unpaid invoice restrictions will immediately
5353
apply:
5454

55-
* You will only be able to scale up to 120 GiB per replica
56-
* You will not be able to start your services if stopped
57-
* You will not be able to start or create new services
55+
* You can only scale up to 120 GiB per replica
56+
* You can't start your services if stopped
57+
* You can't start or create new services
5858

59-
We will attempt to process payment using the organization's configured billing
60-
method for up to 30 days. If payment is not successful after 14 days, all services
61-
within the organization will be stopped. If payment is still not received by the
62-
end of this 30 day period and we have not granted an extension, all data and
59+
We will attempt to process payment using the organization's configured billing
60+
method for up to 30 days. If payment isn't successful after 14 days, all services
61+
within the organization will be stopped. If payment is still not received by the
62+
end of this 30 day period and we've not granted an extension, all data and
6363
services associated with your organization will be deleted.
6464

6565
### Cloud marketplace pay-as-you-go billing {#cloud-marketplace-payg}
6666

67-
Pay-As-You-Go billing can also be configured to charge an organization through one of our supported cloud marketplaces
68-
(AWS, GCP, or Azure). To sign up for Marketplace PAYG billing, follow these
67+
Pay-As-You-Go billing can also be configured to charge an organization through one of our supported cloud marketplaces
68+
(AWS, GCP, or Azure). To sign up for Marketplace PAYG billing, follow these
6969
[instructions](#marketplace-payg).
7070

71-
Similar to billing via Direct PAYG, your monthly billing cycle with ClickHouse
72-
under Marketplace PAYG begins on the day the organization tier (Basic, Scale,
73-
or Enterprise) is selected and the first service is created within the
71+
Similar to billing via Direct PAYG, your monthly billing cycle with ClickHouse
72+
under Marketplace PAYG begins on the day the organization tier (Basic, Scale,
73+
or Enterprise) is selected and the first service is created within the
7474
organization.
7575

76-
However, because of the requirements of the marketplaces, we report the charges
77-
for your Pay-As-You-Go usage on an hour-by-hour basis. Note that you will be
76+
However, because of the requirements of the marketplaces, we report the charges
77+
for your Pay-As-You-Go usage on an hour-by-hour basis. You will be
7878
invoiced according to the terms of your agreement with that marketplace - typically
79-
on a calendar-month billing cycle.
79+
on a calendar-month billing cycle.
8080

81-
As an example, if you create your first organization service on January 18, your
81+
As an example, if you create your first organization service on January 18, your
8282
first billing usage cycle in ClickHouse Cloud will run from January 18 until the
83-
end of the day on February 17. However, you may receive your first invoice from
83+
end of the day on February 17. However, you may receive your first invoice from
8484
the cloud marketplace at the beginning of the month of February.
8585

86-
However, if your PAYG marketplace subscription is canceled or fails to renew
87-
automatically, billing will fall back to the credit card on file for the
88-
organization, if any. To add a credit card, please [contact support](/about-us/support)
89-
for help. If a valid credit card has not been provided, the same unpaid invoice
90-
restrictions outlined above for [Direct PAYG](#direct-payg) will apply - this
86+
However, if your PAYG marketplace subscription is canceled or fails to renew
87+
automatically, billing will fall back to the credit card on file for the
88+
organization, if any. To add a credit card, [contact support](/about-us/support)
89+
for help. If a valid credit card hasn't been provided, the same unpaid invoice
90+
restrictions outlined above for [Direct PAYG](#direct-payg) will apply - this
9191
includes service suspension and eventual data deletion.
9292

9393
### Committed contract billing {#committed-spend-contract}
9494

9595
You may purchase credits for your organization through a committed contract by:
9696

97-
1. Contacting sales to buy credits directly, with payment options including ACH
97+
1. Contacting sales to buy credits directly, with payment options including ACH
9898
or wire transfer. Payment terms will be set forth in the applicable order form.
9999
2. Contacting sales to buy credits through a subscription on one of our supported
100100
cloud marketplaces (AWS, GCP, or Azure). Fees will be reported to the applicable
101-
marketplace upon acceptance of the private offer and thereafter in accordance
101+
marketplace upon acceptance of the private offer and thereafter in accordance
102102
with the offer terms, but you will be invoiced according to the terms of your
103103
agreement with that marketplace. To pay through a marketplace, follow these
104104
[instructions](#marketplace-payg).
105105

106106
Credits applied to an organization (e.g. through committed contracts or refunds) are
107-
available for your use for the term specified in the order form or accepted private
107+
available for your use for the term specified in the order form or accepted private
108108
offer.
109-
Credits are consumed starting on the day credit was granted in billing periods
110-
based on the date the first organization tier (Basic, Scale, or Enterprise) is
109+
Credits are consumed starting on the day credit was granted in billing periods
110+
based on the date the first organization tier (Basic, Scale, or Enterprise) is
111111
selected.
112112

113-
If an organization is **not** on a cloud marketplace committed contract and runs
114-
out of credits or the credits expire, the organization will automatically switch
115-
to Pay-As-You-Go (PAYG) billing. In this case, we will attempt to process payment
113+
If an organization is **not** on a cloud marketplace committed contract and runs
114+
out of credits or the credits expire, the organization will automatically switch
115+
to Pay-As-You-Go (PAYG) billing. In this case, we will attempt to process payment
116116
using the credit card on file for the organization, if any.
117117

118118
If an organization **is** on a cloud marketplace committed contract and runs out
119-
of credits, it will also automatically switch to PAYG billing via the same
120-
marketplace for the remainder of the subscription. However, if the subscription
121-
is not renewed and expires, we will then attempt to process payment using the
119+
of credits, it will also automatically switch to PAYG billing via the same
120+
marketplace for the remainder of the subscription. However, if the subscription
121+
isn't renewed and expires, we will then attempt to process payment using the
122122
credit card on file for the organization, if any.
123123

124-
In either scenario, if we are unable to charge the configured credit card, the
124+
In either scenario, if we're unable to charge the configured credit card, the
125125
unpaid invoice restrictions outlined above for [Pay-as-you-go (PAYG)](#direct-payg)
126-
billing with a credit card will apply—this includes the suspension of services.
127-
For more details on moving from your committed contract to PAYG billing, please refer to the “Overconsumption” section in our [Terms and Conditions](https://clickhouse.com/legal/agreements/terms-of-service).
128-
However, for committed contract customers, we will contact you regarding any
129-
unpaid invoices before initiating data deletion. Data is not automatically
126+
billing with a credit card will apply—this includes the suspension of services.
127+
For more details on moving from your committed contract to PAYG billing, refer to the “Overconsumption” section in our [Terms and Conditions](https://clickhouse.com/legal/agreements/terms-of-service).
128+
However, for committed contract customers, we will contact you regarding any
129+
unpaid invoices before initiating data deletion. Data isn't automatically
130130
deleted after any period of time.
131131

132-
If you’d like to add additional credits before your existing ones expire or are
133-
depleted, please [contact us](https://clickhouse.com/company/contact).
132+
If you’d like to add additional credits before your existing ones expire or are
133+
depleted, [contact us](https://clickhouse.com/company/contact).
134134

135135
### How to pay using a credit card {#add-credit-card}
136136

137137
Go to the Billing section in the ClickHouse Cloud UI and click the 'Add Credit Card'
138-
button (shown below) to complete the setup. If you have any questions, please
139-
[contact support](/about-us/support) for help.
138+
button (shown below) to complete the setup. If you have any questions, [contact support](/about-us/support) for help.
140139

141140
<Image img={billing_compliance} size="md" alt="How to add a credit card" />
142141

143142
## How to pay via marketplaces {#marketplace-payg}
144143

145144
If you want to pay through one of our supported marketplaces (AWS, GCP, or Azure),
146-
you can follow the steps [here](/cloud/marketplace/marketplace-billing) for help.
147-
For any questions related specifically to cloud marketplace billing, please
148-
contact the cloud service provider directly.
145+
you can follow the steps [here](/cloud/marketplace/marketplace-billing) for help.
146+
For any questions related specifically to cloud marketplace billing, contact the cloud service provider directly.
149147

150148
Helpful links for resolving issues with marketplace billing:
151149
* [AWS Billing FAQs](https://aws.amazon.com/aws-cost-management/aws-billing/faqs/)

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ import EnterprisePlanFeatureBadge from '@theme/badges/EnterprisePlanFeatureBadge
2525
- us-east-1 (N. Virginia)
2626
- us-east-2 (Ohio)
2727
- us-west-2 (Oregon)
28+
- il-central-1 (Israel, Tel Aviv)
2829

2930
**Private Region:**
3031
- ca-central-1 (Canada)

docs/integrations/data-ingestion/clickpipes/aws-privatelink.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,21 +33,25 @@ data source types:
3333
- Kafka
3434
- Postgres
3535
- MySQL
36+
- MongoDB
3637

3738
## Supported AWS PrivateLink endpoint types {#aws-privatelink-endpoint-types}
3839

3940
ClickPipes reverse private endpoint can be configured with one of the following AWS PrivateLink approaches:
4041

41-
- [VPC resource](https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-access-resources.html)
42-
- [MSK multi-VPC connectivity for MSK ClickPipe](https://docs.aws.amazon.com/msk/latest/developerguide/aws-access-mult-vpc.html)
43-
- [VPC endpoint service](https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html)
42+
- [VPC resource](#vpc-resource)
43+
- [MSK multi-VPC connectivity for MSK ClickPipe](#msk-multi-vpc)
44+
- [VPC endpoint service](#vpc-endpoint-service)
4445

4546
### VPC resource {#vpc-resource}
4647

48+
:::info
49+
Cross-region is not supported.
50+
:::
51+
4752
Your VPC resources can be accessed in ClickPipes using [PrivateLink](https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-access-resources.html). This approach doesn't require setting up a load balancer in front of your data source.
4853

4954
Resource configuration can be targeted with a specific host or RDS cluster ARN.
50-
Cross-region is not supported.
5155

5256
It's the preferred choice for Postgres CDC ingesting data from an RDS cluster.
5357

@@ -171,8 +175,7 @@ Follow our [MSK setup guide for ClickPipes](/knowledgebase/aws-privatelink-setup
171175
It requires setting up a NLB (Network Load Balancer) in front of your data source
172176
and configuring the VPC endpoint service to use the NLB.
173177

174-
VPC endpoint service can be [configured with a private DNS](https://docs.aws.amazon.com/vpc/latest/privatelink/manage-dns-names.html),
175-
that will be accessible in a ClickPipes VPC.
178+
VPC endpoint service can be [configured with a private DNS](https://docs.aws.amazon.com/vpc/latest/privatelink/manage-dns-names.html), that will be accessible in a ClickPipes VPC.
176179

177180
It's a preferred choice for:
178181

docs/integrations/data-ingestion/clickpipes/mongodb/faq.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ For more examples, see our [Working with JSON guide](./quickstart).
5252

5353
### How do I handle `resume of change stream was not possible, as the resume point may no longer be in the oplog.` error? {#resume-point-may-no-longer-be-in-the-oplog-error}
5454

55-
This error typically occurs when the oplog is truncated and ClickPipe is unable to resume the change stream at the expected point. To resolve this issue, [resync the ClickPipe](./resync.md). To avoid this issue from recurring, we recommend [increasing the oplog retention period](./source/atlas#enable-oplog-retention) (or [here](./source/generic#enable-oplog-retention) if you are on a self-managed MongoDB).
55+
This error typically occurs when the oplog is truncated and ClickPipe is unable to resume the change stream at the expected point. To resolve this issue, [resync the ClickPipe](./resync.md). To avoid this issue from recurring, we recommend increasing the oplog retention period. See instructions for [MongoDB Atlas](./source/atlas#enable-oplog-retention), [self-managed MongoDB](./source/generic#enable-oplog-retention), or [Amazon DocumentDB](./source/documentdb#configure-change-stream-log-retention).
5656

5757
### How is replication managed? {#how-is-replication-managed}
5858

@@ -63,4 +63,21 @@ We use MongoDB's native Change Streams API to track changes in the database. Cha
6363
Which read preference to use depends on your specific use case. If you want to minimize the load on your primary node, we recommend using `secondaryPreferred` read preference. If you want to optimize ingestion latency, we recommend using `primaryPreferred` read preference. For more details, see [MongoDB documentation](https://www.mongodb.com/docs/manual/core/read-preference/#read-preference-modes-1).
6464

6565
### Does the MongoDB ClickPipe support Sharded Cluster? {#does-the-mongodb-clickpipe-support-sharded-cluster}
66+
6667
Yes, the MongoDB ClickPipe supports both Replica Set and Sharded Cluster.
68+
69+
### Does MongoDB ClickPipe support Amazon DocumentDB? {#documentdb-support}
70+
71+
Yes, MongoDB ClickPipe supports Amazon DocumentDB 5.0. See [Amazon DocumentDB source setup guide](./source/documentdb.md) for details.
72+
73+
### Does MongoDB ClickPipe support PrivateLink? {#privatelink-support}
74+
75+
We support PrivateLink for MongoDB (and DocumentDB) cluster in AWS only.
76+
77+
Note that unlike single-node relational database, MongoDB client requires successful replica set discovery to be able to respect the configured `ReadPreference`. This requires setting up PrivateLink with all the nodes in the cluster so the MongoDB client can successfully establish replica set connection, as well as redirect to another node when the connected node goes down.
78+
79+
If you prefer to connect to a single node in your cluster, you can skip replica set discovery by specifying `/?directConnection=true` in the connection string during ClickPipes setup. The PrivateLink setup in this case will be similar to a single-node relational database, and is the simplest option for PrivateLink support.
80+
81+
For replica set connection, you can set up PrivateLink for MongoDB with either VPC Resource or VPC Endpoint Service. If you go with VPC Resource, you would need to create a `GROUP` resource configuration, plus a `CHILD` resource configuration for each node in the cluster. If you go with VPC Endpoint Service, you would need to create a separate Endpoint Service (and a separate NLB) for each node in the cluster.
82+
83+
See [AWS PrivateLink for ClickPipes](../aws-privatelink.md) documentation for more details. Please reach out to ClickHouse support for assistance.

0 commit comments

Comments
 (0)