Skip to content

Commit 322fe3a

Browse files
committed
Merge main and fix conflict
2 parents 1bc180b + 99c1859 commit 322fe3a

File tree

957 files changed

+42789
-34325
lines changed

Some content is hidden

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

957 files changed

+42789
-34325
lines changed

.gitignore

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,10 @@ docs/cloud/manage/api/prometheus-api-reference.md
5050
docs/cloud/manage/api/usageCost-api-reference.md
5151
docs/whats-new/changelog/index.md
5252
docs/about-us/beta-and-experimental-features.md
53+
static/knowledgebase_toc.json
54+
.floating-pages-validation-failed
55+
.frontmatter-validation-failed
56+
logs/
5357

5458
.vscode
5559
.aspell.en.prepl
@@ -59,8 +63,8 @@ docs/about-us/beta-and-experimental-features.md
5963
**.translate
6064
/ClickHouse/
6165

62-
6366
# Ignore table of contents files
6467
docs/cloud/reference/release-notes-index.md
6568
docs/whats-new/changelog/index.md
66-
docs/cloud/manage/api/api-reference-index.md
69+
docs/cloud/manage/api/api-reference-index.md
70+
docs/getting-started/index.md

docs/about-us/beta-and-experimental-features.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,10 @@ Note: please be sure to be using a current version of the ClickHouse [compatibil
3838
- Cannot be enabled in the cloud
3939

4040
Please note: no additional experimental features are allowed to be enabled in ClickHouse Cloud other than those listed above as Beta.
41+
42+
<!-- The inner content of the tags below are replaced at build time with a table generated from source
43+
Please do not modify or remove the tags
44+
-->
45+
46+
<!--AUTOGENERATED_START-->
47+
<!--AUTOGENERATED_END-->

docs/architecture/cluster-deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: 'Cluster Deployment'
66
description: 'By going through this tutorial, you will learn how to set up a simple ClickHouse cluster.'
77
---
88

9-
This tutorial assumes you've already set up a [local ClickHouse server](../getting-started/install.md)
9+
This tutorial assumes you've already set up a [local ClickHouse server](../getting-started/install/install.mdx)
1010

1111
By going through this tutorial, you'll learn how to set up a simple ClickHouse cluster. It'll be small, but fault-tolerant and scalable. Then we will use one of the example datasets to fill it with data and execute some demo queries.
1212

docs/guides/sizing-and-hardware-recommendations.md renamed to docs/best-practices/sizing-and-hardware-recommendations.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,14 @@ As an example, when using M-type CPUs, we recommend provisioning 100GB of memory
6969

7070
## Memory {#memory}
7171

72-
Like your choice of CPU, your choice of memory to storage ratio and memory to CPU ratio is dependent on your case. In general, however, the more memory you have, the faster your queries will run. If your use case is sensitive to price, lower amounts of memory will work as it is possible to enable settings ([`max_bytes_before_external_group_by`](/operations/settings/settings#max_bytes_before_external_group_by) and [`max_bytes_before_external_sort`](/operations/settings/settings#max_bytes_before_external_sort)) to allow spilling data to disk, but note that this may significantly affect query performance.
72+
Like your choice of CPU, your choice of memory to storage ratio and memory to CPU ratio is dependent on your use-case.
73+
74+
The required volume of RAM generally depends on:
75+
- The complexity of queries.
76+
- The amount of data that is processed in queries.
77+
78+
In general, however, the more memory you have, the faster your queries will run.
79+
If your use case is sensitive to price, lower amounts of memory will work as it is possible to enable settings ([`max_bytes_before_external_group_by`](/operations/settings/settings#max_bytes_before_external_group_by) and [`max_bytes_before_external_sort`](/operations/settings/settings#max_bytes_before_external_sort)) to allow spilling data to disk, but note that this may significantly affect query performance.
7380

7481
### What should the memory to storage ratio be? {#what-should-the-memory-to-storage-ratio-be}
7582

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,6 @@ See: [Configuring BACKUP/RESTORE to use an S3 Endpoint](/operations/backup#confi
9797

9898
## Backup / Restore to Azure Blob Storage {#backup--restore-to-azure-blob-storage}
9999

100-
:::note
101-
Exporting backups to you own bucket on Azure Blob Storage is not available yet. We will update this page when the feature is available.
102-
:::
103-
104100
### Take a DB Backup {#take-a-db-backup-1}
105101

106102
**Full Backup**

docs/cloud/manage/openapi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import Image from '@theme/IdealImage';
1717
ClickHouse Cloud provides an API utilizing OpenAPI that allows you to programmatically manage your account and aspects of your services.
1818

1919
:::note
20-
This document covers the ClickHouse Cloud API. For database API endpoints, please see [Cloud Endpoints API](//cloud/get-started/query-endpoints.md)
20+
This document covers the ClickHouse Cloud API. For database API endpoints, please see [Cloud Endpoints API](/cloud/get-started/query-endpoints.md)
2121
:::
2222

2323
1. You can use the **API Keys** tab on the left menu to create and manage your API keys.

docs/cloud/manage/troubleshooting-billing-issues.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
sidebar_label: 'Troubleshooting Billing Issues'
33
slug: /manage/troubleshooting-billing-issues
4-
title: 'Troubleshooting Billing Issues'
4+
title: 'Troubleshooting billing issues'
55
description: 'Troubleshooting article for common billing issues'
66
---
77

88
import trial_expired from '@site/static/images/cloud/manage/trial-expired.png';
99
import Image from '@theme/IdealImage';
1010

11-
# Troubleshooting Billing Issues
11+
# Troubleshooting billing issues
1212

1313
## Fixing non-working payment details {#fixing-non-working-payment-details}
1414

docs/cloud/reference/byoc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ BYOC (Bring Your Own Cloud) allows you to deploy ClickHouse Cloud on your own cl
2424

2525
**If you would like access, please [contact us](https://clickhouse.com/cloud/bring-your-own-cloud).** Refer to our [Terms of Service](https://clickhouse.com/legal/agreements/terms-of-service) for additional information.
2626

27-
BYOC is currently only supported for AWS, with GCP and Microsoft Azure in development.
27+
BYOC is currently only supported for AWS. You can join the wait list for GCP and Azure [here](https://clickhouse.com/cloud/bring-your-own-cloud).
2828

2929
:::note
3030
BYOC is designed specifically for large-scale deployments, and requires customers to sign a committed contract.

docs/cloud/reference/changelog.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,21 @@ import query_endpoints from '@site/static/images/cloud/reference/may-17-query-en
3030

3131
In addition to this ClickHouse Cloud changelog, please see the [Cloud Compatibility](/cloud/reference/cloud-compatibility.md) page.
3232

33+
## May 16, 2025 {#may-16-2025}
34+
35+
- Introduced the Resource Utilization Dashboard which provides a view of
36+
resources being used by a service in ClickHouse Cloud. The following metrics
37+
are scraped from system tables, and displayed on this dashboard:
38+
* Memory & CPU: Graphs for `CGroupMemoryTotal` (Allocated Memory), `CGroupMaxCPU` (allocated CPU),
39+
`MemoryResident` (memory used), and `ProfileEvent_OSCPUVirtualTimeMicroseconds` (CPU used)
40+
* Data Transfer: Graphs showing data ingress and egress from ClickHouse Cloud. Learn more [here](/cloud/manage/network-data-transfer).
41+
- We’re excited to announce the launch of our new ClickHouse Cloud Prometheus/Grafana mix-in,
42+
built to simplify monitoring for your ClickHouse Cloud services.
43+
This mix-in uses our Prometheus-compatible API endpoint to seamlessly integrate
44+
ClickHouse metrics into your existing Prometheus and Grafana setup. It includes
45+
a pre-configured dashboard that gives you real-time visibility into the health
46+
and performance of your services. Refer to the launch [blog](https://clickhouse.com/blog/monitor-with-new-prometheus-grafana-mix-in) to read more.
47+
3348
## April 18, 2025 {#april-18-2025}
3449

3550
- Introduced a new **Member** organization level role and two new service level

docs/cloud/reference/warehouses.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Each compute node group will have its own endpoint so you can choose which set o
4545

4646
_Fig. 2 - compute separation in ClickHouse Cloud_
4747

48-
In this private preview program, you will have the ability to create extra services that share the same data with your existing services, or create a completely new setup with multiple services sharing the same data.
48+
It is possible to create extra services that share the same data with your existing services, or create a completely new setup with multiple services sharing the same data.
4949

5050
## What is a Warehouse? {#what-is-a-warehouse}
5151

@@ -122,8 +122,6 @@ Once compute-compute is enabled for a service (at least one secondary service wa
122122

123123
## Limitations {#limitations}
124124

125-
Because this compute-compute separation is currently in private preview, there are some limitations to using this feature. Most of these limitations will be removed once the feature is released to GA (general availability):
126-
127125
1. **Primary service should always be up and should not be idled (limitation will be removed some time after GA).** During the private preview and some time after GA, the primary service (usually the existing service that you want to extend by adding other services) will be always up and will have the idling setting disabled. You will not be able to stop or idle the primary service if there is at least one secondary service. Once all secondary services are removed, you can stop or idle the original service again.
128126

129127
2. **Sometimes workloads cannot be isolated.** Though the goal is to give you an option to isolate database workloads from each other, there can be corner cases where one workload in one service will affect another service sharing the same data. These are quite rare situations that are mostly connected to OLTP-like workloads.
@@ -146,7 +144,7 @@ settings distributed_ddl_task_timeout=0
146144

147145
## Pricing {#pricing}
148146

149-
Extra services created during the private preview are billed as usual. Compute prices are the same for all services in a warehouse (primary and secondary). Storage is billed only once - it is included in the first (original) service.
147+
Compute prices are the same for all services in a warehouse (primary and secondary). Storage is billed only once - it is included in the first (original) service.
150148

151149
## Backups {#backups}
152150

0 commit comments

Comments
 (0)