Skip to content

Commit b87350c

Browse files
committed
Merge remote-tracking branch 'origin/main'
2 parents 76c5e36 + b57eb68 commit b87350c

File tree

1,294 files changed

+9763
-7554
lines changed

Some content is hidden

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

1,294 files changed

+9763
-7554
lines changed

docs/architecture/cluster-deployment.md

Lines changed: 0 additions & 153 deletions
This file was deleted.

docs/best-practices/minimize_optimize_joins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Follow these best practices to improve JOIN performance:
4141
When using dictionaries for JOINs in ClickHouse, it's important to understand that dictionaries, by design, do not allow duplicate keys. During data loading, any duplicate keys are silently deduplicated—only the last loaded value for a given key is retained. This behavior makes dictionaries ideal for one-to-one or many-to-one relationships where only the latest or authoritative value is needed. However, using a dictionary for a one-to-many or many-to-many relationship (e.g. joining roles to actors where an actor can have multiple roles) will result in silent data loss, as all but one of the matching rows will be discarded. As a result, dictionaries are not suitable for scenarios requiring full relational fidelity across multiple matches.
4242
:::
4343

44-
## Choosing the right JOIN Algorithm {#choosing-the-right-join-algorithm}
44+
## Choosing the correct JOIN Algorithm {#choosing-the-right-join-algorithm}
4545

4646
ClickHouse supports several JOIN algorithms that trade off between speed and memory:
4747

docs/cloud/manage/backups/configurable-backups.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ ClickHouse Cloud allows you to configure the schedule for your backups for **Sca
2424
The custom schedule will override the default backup policy in ClickHouse Cloud for your given service.
2525
:::
2626

27+
:::note
28+
In some rare scenarios, the backup scheduler will not respect the **Start Time** specified for backups. Specifically, this happens if there was a successful backup triggered < 24 hours from the time of the currently scheduled backup. This could happen due to a retry mechanism we have in place for backups. In such instances, the scheduler will skip over the backup for the current day, and will retry the backup the next day at the scheduled time.
29+
:::
30+
2731
To configure the backup schedule for a service, go to the **Settings** tab in the console and click on **Change backup configuration**.
2832

2933
<Image img={backup_settings} size="lg" alt="Configure backup settings" border/>

docs/cloud/manage/backups/export-backups-to-own-cloud-account.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ For details of how ClickHouse Cloud backups work, including "full" vs. "incremen
1515
Here we show examples of how to take full and incremental backups to AWS, GCP, Azure object storage as well as how to restore from the backups.
1616

1717
:::note
18-
Users should be aware that any usage where backups are being exported to a different region in the same cloud provider, or to another cloud provider (in the same or different region) will incur [data transfer](../network-data-transfer.mdx) charges.
18+
Users should be aware that any usage where backups are being exported to a different region in the same cloud provider, will incur [data transfer](../network-data-transfer.mdx) charges. Currently we do not support cross cloud backups.
1919
:::
2020

2121
## Requirements {#requirements}
@@ -26,19 +26,23 @@ You will need the following details to export/restore backups to your own CSP st
2626

2727
1. AWS S3 endpoint, in the format:
2828

29-
```text
30-
s3://<bucket_name>.s3.amazonaws.com/<directory>
31-
```
29+
```text
30+
s3://<bucket_name>.s3.amazonaws.com/<directory>
31+
```
3232

33-
For example:
34-
```text
35-
s3://testchbackups.s3.amazonaws.com/backups/
36-
```
37-
Where:
38-
- `testchbackups` is the name of the S3 bucket to export backups to.
39-
- `backups` is an optional subdirectory.
33+
For example:
34+
```text
35+
s3://testchbackups.s3.amazonaws.com/backups/
36+
```
37+
Where:
38+
- `testchbackups` is the name of the S3 bucket to export backups to.
39+
- `backups` is an optional subdirectory.
4040

41-
2. AWS access key and secret.
41+
2. AWS access key and secret. AWS role based authentication is also supported and can be used in place of AWS access key and secret.
42+
43+
:::note
44+
In order to use role based authentication, please follow the Secure s3 [setup](https://clickhouse.com/docs/cloud/security/secure-s3). In addition, you will need to add `s3:PutObject`, and `s3:DeleteObject` permissions to the IAM policy decribed [here.](https://clickhouse.com/docs/cloud/security/secure-s3#option-2-manually-create-iam-role)
45+
:::
4246

4347
### Azure {#azure}
4448

docs/cloud/manage/billing.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,10 @@ ClickHouse Cloud supports the following billing options:
223223
- Direct-sales annual / multi-year (through pre-paid "ClickHouse Credits", in USD, with additional payment options).
224224
- Through the AWS, GCP, and Azure marketplaces (either pay-as-you-go (PAYG) or commit to a contract with ClickHouse Cloud through the marketplace).
225225

226+
:::note
227+
ClickHouse Cloud credits for PAYG are invoiced in \$0.01 units, allowing us to charge customers for partial ClickHouse credits based on their usage. This differs from committed spend ClickHouse credits, which are purchased in advance in whole \$1 units.
228+
:::
229+
226230
### How long is the billing cycle? {#how-long-is-the-billing-cycle}
227231

228232
Billing follows a monthly billing cycle and the start date is tracked as the date when the ClickHouse Cloud organization was created.
@@ -454,12 +458,12 @@ This section outlines the pricing model of ClickPipes for streaming and object s
454458

455459
#### What does the ClickPipes pricing structure look like? {#what-does-the-clickpipes-pricing-structure-look-like}
456460

457-
It consists of two dimensions
461+
It consists of two dimensions:
458462

459-
- **Compute**: Price per unit per hour
463+
- **Compute**: Price **per unit per hour**.
460464
Compute represents the cost of running the ClickPipes replica pods whether they actively ingest data or not.
461465
It applies to all ClickPipes types.
462-
- **Ingested data**: per GB pricing
466+
- **Ingested data**: Price **per GB**.
463467
The ingested data rate applies to all streaming ClickPipes
464468
(Kafka, Confluent, Amazon MSK, Amazon Kinesis, Redpanda, WarpStream, Azure Event Hubs)
465469
for the data transferred via the replica pods. The ingested data size (GB) is charged based on bytes received from the source (uncompressed or compressed).
@@ -472,17 +476,27 @@ For this reason, it uses dedicated compute replicas.
472476

473477
#### What is the default number of replicas and their size? {#what-is-the-default-number-of-replicas-and-their-size}
474478

475-
Each ClickPipe defaults to 1 replica that is provided with 2 GiB of RAM and 0.5 vCPU.
476-
This corresponds to **0.25** ClickHouse compute units (1 unit = 8 GiB RAM, 2 vCPUs).
479+
Each ClickPipe defaults to 1 replica that is provided with 512 MiB of RAM and 0.125 vCPU (XS).
480+
This corresponds to **0.0625** ClickHouse compute units (1 unit = 8 GiB RAM, 2 vCPUs).
477481

478482
#### What are the ClickPipes public prices? {#what-are-the-clickpipes-public-prices}
479483

480-
- Compute: \$0.20 per unit per hour (\$0.05 per replica per hour)
484+
- Compute: \$0.20 per unit per hour (\$0.0125 per replica per hour for the default replica size)
481485
- Ingested data: \$0.04 per GB
482486

487+
The price for the Compute dimension depends on the **number** and **size** of replica(s) in a ClickPipe. The default replica size can be adjusted using vertical scaling, and each replica size is priced as follows:
488+
489+
| Replica Size | Compute Units | RAM | vCPU | Price per Hour |
490+
|----------------------------|---------------|---------|--------|----------------|
491+
| Extra Small (XS) (default) | 0.0625 | 512 MiB | 0.125. | $0.0125 |
492+
| Small (S) | 0.125 | 1 GiB | 0.25 | $0.025 |
493+
| Medium (M) | 0.25 | 2 GiB | 0.5 | $0.05 |
494+
| Large (L) | 0.5 | 4 GiB | 1.0 | $0.10 |
495+
| Extra Large (XL) | 1.0 | 8 GiB | 2.0 | $0.20 |
496+
483497
#### How does it look in an illustrative example? {#how-does-it-look-in-an-illustrative-example}
484498

485-
The following examples assume a single replica unless explicitly mentioned.
499+
The following examples assume a single M-sized replica, unless explicitly mentioned.
486500

487501
<table><thead>
488502
<tr>

docs/cloud/manage/billing/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ This section of the documentation covers topics related to billing, and contains
1111
|---------------------------------------|----------------------------------------------------------------------|
1212
| [Overview](/cloud/marketplace/marketplace-billing) | Overview and FAQ pages for marketplace billing. |
1313
| [Payment Thresholds](/cloud/billing/payment-thresholds) | Learn more about how payment thresholds work and how to adjust them. |
14-
| [Troubleshooting Billing Issues](/manage/troubleshooting-billing-issues) | Troubleshoot common billing issues. |
14+
| [Troubleshooting Billing Issues](/manage/clickhouse-cloud-billing-compliance) | Troubleshoot common billing issues. |
1515
| [Marketplace](/cloud/manage/) | Landing page for further marketplace related topics. |

docs/cloud/manage/billing/marketplace/aws-marketplace-committed.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@ Get started with ClickHouse Cloud on the [AWS Marketplace](https://aws.amazon.co
2020
## Prerequisites {#prerequisites}
2121

2222
- A Private Offer from ClickHouse based on specific contract terms.
23+
- To connect a ClickHouse organization to your committed spend offer, you must be an admin of that organization.
24+
25+
[Required permissions to view and accept your committed contract in AWS](https://docs.aws.amazon.com/marketplace/latest/buyerguide/private-offers-page.html#private-offers-page-permissions):
26+
- If you use AWS managed policies it is required to have the following permissions: `AWSMarketplaceRead-only`, `AWSMarketplaceManageSubscriptions`, or `AWSMarketplaceFullAccess`.
27+
- If you aren't using AWS managed policies it is required to have the following permissions: IAM action `aws-marketplace:ListPrivateListings` and `aws-marketplace:ViewSubscriptions`.
2328

2429
## Steps to sign up {#steps-to-sign-up}
2530

docs/cloud/manage/jan2025_faq/_snippets/_clickpipes_faq.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ This corresponds to **0.25** ClickHouse compute units (1 unit = 8 GiB RAM, 2 vCP
5252

5353
<summary>Can ClickPipes replicas be scaled?</summary>
5454

55-
ClickPipes for streaming can be scaled horizontally
56-
by adding more replicas each with a base unit of **0.25** ClickHouse compute units.
57-
Vertical scaling is also available on demand for specific use cases (adding more CPU and RAM per replica).
55+
Yes, ClickPipes for streaming can be scaled both horizontally and vertically.
56+
Horizontal scaling adds more replicas to increase throughput, while vertical scaling increases the resources (CPU and RAM) allocated to each replica to handle more intensive workloads.
57+
This can be configured during ClickPipe creation, or at any other point under **Settings** -> **Advanced Settings** -> **Scaling**.
5858

5959
</details>
6060

@@ -142,4 +142,4 @@ The philosophy behind ClickPipes pricing is
142142
to cover the operating costs of the platform while offering an easy and reliable way to move data to ClickHouse Cloud.
143143
From that angle, our market analysis revealed that we are positioned competitively.
144144

145-
</details>
145+
</details>

docs/cloud/manage/replica-aware-routing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ Customers need to manually add a DNS entry to make name resolution work for the
3333

3434
## Configuring replica-aware routing {#configuring-replica-aware-routing}
3535

36-
To enable Replica-aware routing, please contact [our support team](https://clickhouse.com/support).
36+
To enable Replica-aware routing, please contact [our support team](https://clickhouse.com/support/program).

0 commit comments

Comments
 (0)