Skip to content

Commit fff4088

Browse files
yiyang-shaoyiyang-shao
committed
[BYOC]Create separate pages for each section
1 parent 093d774 commit fff4088

7 files changed

+410
-0
lines changed

Diff for: ‎docs/cloud/reference/byoc-faq.md

+131
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
## FAQ {#faq}
2+
3+
### Compute {#compute}
4+
5+
#### Can I create multiple services in this single EKS cluster? {#can-i-create-multiple-services-in-this-single-eks-cluster}
6+
7+
Yes. The infrastructure only needs to be provisioned once for every AWS account and region combination.
8+
9+
### Which regions do you support for BYOC? {#which-regions-do-you-support-for-byoc}
10+
11+
BYOC supports the same set of [regions](/cloud/reference/supported-regions#aws-regions ) as ClickHouse Cloud.
12+
13+
#### Will there be some resource overhead? What are the resources needed to run services other than ClickHouse instances? {#will-there-be-some-resource-overhead-what-are-the-resources-needed-to-run-services-other-than-clickhouse-instances}
14+
15+
Besides Clickhouse instances (ClickHouse servers and ClickHouse Keeper), we run services such as `clickhouse-operator`, `aws-cluster-autoscaler`, Istio etc. and our monitoring stack.
16+
17+
Currently we have 3 m5.xlarge nodes (one for each AZ) in a dedicated node group to run those workloads.
18+
19+
### Network and Security {#network-and-security}
20+
21+
#### Can we revoke permissions set up during installation after setup is complete? {#can-we-revoke-permissions-set-up-during-installation-after-setup-is-complete}
22+
23+
This is currently not possible.
24+
25+
#### Have you considered some future security controls for ClickHouse engineers to access customer infra for troubleshooting? {#have-you-considered-some-future-security-controls-for-clickhouse-engineers-to-access-customer-infra-for-troubleshooting}
26+
27+
Yes. Implementing a customer controlled mechanism where customers can approve engineers' access to the cluster is on our roadmap. At the moment, engineers must go through our internal escalation process to gain just-in-time access to the cluster. This is logged and audited by our security team.
28+
29+
#### What is the size of the VPC IP range created? {#what-is-the-size-of-the-vpc-ip-range-created}
30+
31+
By default we use `10.0.0.0/16` for BYOC VPC. We recommend reserving at least /22 for potential future scaling,
32+
but if you prefer to limit the size, it is possible to use /23 if it is likely that you will be limited
33+
to 30 server pods.
34+
35+
#### Can I decide maintenance frequency {#can-i-decide-maintenance-frequency}
36+
37+
Contact support to schedule maintenance windows. Please expect a minimum of a weekly update schedule.
38+
39+
## Observability {#observability}
40+
41+
### Built-in Monitoring Tools {#built-in-monitoring-tools}
42+
43+
#### Observability Dashboard {#observability-dashboard}
44+
45+
ClickHouse Cloud includes an advanced observability dashboard that displays metrics such as memory usage, query rates, and I/O. This can be accessed in the **Monitoring** section of ClickHouse Cloud web console interface.
46+
47+
<br />
48+
49+
<Image img={byoc3} size="lg" alt="Observability dashboard" border />
50+
51+
<br />
52+
53+
#### Advanced Dashboard {#advanced-dashboard}
54+
55+
You can customize a dashboard using metrics from system tables like `system.metrics`, `system.events`, and `system.asynchronous_metrics` and more to monitor server performance and resource utilization in detail.
56+
57+
<br />
58+
59+
<Image img={byoc4} size="lg" alt="Advanced dashboard" border />
60+
61+
<br />
62+
63+
#### Prometheus Integration {#prometheus-integration}
64+
65+
ClickHouse Cloud provides a Prometheus endpoint that you can use to scrape metrics for monitoring. This allows for integration with tools like Grafana and Datadog for visualization.
66+
67+
**Sample request via https endpoint /metrics_all**
68+
69+
```bash
70+
curl --user <username>:<password> https://i6ro4qarho.mhp0y4dmph.us-west-2.aws.byoc.clickhouse.cloud:8443/metrics_all
71+
```
72+
73+
**Sample Response**
74+
75+
```bash
76+
# HELP ClickHouse_CustomMetric_StorageSystemTablesS3DiskBytes The amount of bytes stored on disk `s3disk` in system database
77+
# TYPE ClickHouse_CustomMetric_StorageSystemTablesS3DiskBytes gauge
78+
ClickHouse_CustomMetric_StorageSystemTablesS3DiskBytes{hostname="c-jet-ax-16-server-43d5baj-0"} 62660929
79+
# HELP ClickHouse_CustomMetric_NumberOfBrokenDetachedParts The number of broken detached parts
80+
# TYPE ClickHouse_CustomMetric_NumberOfBrokenDetachedParts gauge
81+
ClickHouse_CustomMetric_NumberOfBrokenDetachedParts{hostname="c-jet-ax-16-server-43d5baj-0"} 0
82+
# HELP ClickHouse_CustomMetric_LostPartCount The age of the oldest mutation (in seconds)
83+
# TYPE ClickHouse_CustomMetric_LostPartCount gauge
84+
ClickHouse_CustomMetric_LostPartCount{hostname="c-jet-ax-16-server-43d5baj-0"} 0
85+
# HELP ClickHouse_CustomMetric_NumberOfWarnings The number of warnings issued by the server. It usually indicates about possible misconfiguration
86+
# TYPE ClickHouse_CustomMetric_NumberOfWarnings gauge
87+
ClickHouse_CustomMetric_NumberOfWarnings{hostname="c-jet-ax-16-server-43d5baj-0"} 2
88+
# HELP ClickHouseErrorMetric_FILE_DOESNT_EXIST FILE_DOESNT_EXIST
89+
# TYPE ClickHouseErrorMetric_FILE_DOESNT_EXIST counter
90+
ClickHouseErrorMetric_FILE_DOESNT_EXIST{hostname="c-jet-ax-16-server-43d5baj-0",table="system.errors"} 1
91+
# HELP ClickHouseErrorMetric_UNKNOWN_ACCESS_TYPE UNKNOWN_ACCESS_TYPE
92+
# TYPE ClickHouseErrorMetric_UNKNOWN_ACCESS_TYPE counter
93+
ClickHouseErrorMetric_UNKNOWN_ACCESS_TYPE{hostname="c-jet-ax-16-server-43d5baj-0",table="system.errors"} 8
94+
# HELP ClickHouse_CustomMetric_TotalNumberOfErrors The total number of errors on server since the last restart
95+
# TYPE ClickHouse_CustomMetric_TotalNumberOfErrors gauge
96+
ClickHouse_CustomMetric_TotalNumberOfErrors{hostname="c-jet-ax-16-server-43d5baj-0"} 9
97+
```
98+
99+
**Authentication**
100+
101+
A ClickHouse username and password pair can be used for authentication. We recommend creating a dedicated user with minimal permissions for scraping metrics. At minimum, a `READ` permission is required on the `system.custom_metrics` table across replicas. For example:
102+
103+
```sql
104+
GRANT REMOTE ON *.* TO scraping_user
105+
GRANT SELECT ON system.custom_metrics TO scraping_user
106+
```
107+
108+
**Configuring Prometheus**
109+
110+
An example configuration is shown below. The `targets` endpoint is the same one used for accessing the ClickHouse service.
111+
112+
```bash
113+
global:
114+
scrape_interval: 15s
115+
116+
scrape_configs:
117+
- job_name: "prometheus"
118+
static_configs:
119+
- targets: ["localhost:9090"]
120+
- job_name: "clickhouse"
121+
static_configs:
122+
- targets: ["<subdomain1>.<subdomain2>.aws.byoc.clickhouse.cloud:8443"]
123+
scheme: https
124+
metrics_path: "/metrics_all"
125+
basic_auth:
126+
username: <KEY_ID>
127+
password: <KEY_SECRET>
128+
honor_labels: true
129+
```
130+
131+
Please also see [this blog post](https://clickhouse.com/blog/clickhouse-cloud-now-supports-prometheus-monitoring) and the [Prometheus setup docs for ClickHouse](/integrations/prometheus).

Diff for: ‎docs/cloud/reference/byoc-features.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## Features {#features}
2+
3+
### Supported features {#supported-features}
4+
5+
- **SharedMergeTree**: ClickHouse Cloud and BYOC use the same binary and configuration. Therefore all features from ClickHouse core are supported in BYOC such as SharedMergeTree.
6+
- **Console access for managing service state**:
7+
- Supports operations such as start, stop, and terminate.
8+
- View services and status.
9+
- **Backup and restore.**
10+
- **Manual vertical and horizontal scaling.**
11+
- **Idling.**
12+
- **Warehouses**: Compute-Compute Separation
13+
- **Zero Trust Network via Tailscale.**
14+
- **Monitoring**:
15+
- The Cloud console includes built-in health dashboards for monitoring service health.
16+
- Prometheus scraping for centralized monitoring with Prometheus, Grafana, and Datadog. See the [Prometheus documentation](/integrations/prometheus) for setup instructions.
17+
- **VPC Peering.**
18+
- **Integrations**: See the full list on [this page](/integrations).
19+
- **Secure S3.**
20+
- **[AWS PrivateLink](https://aws.amazon.com/privatelink/).**
21+
22+
### Planned features (currently unsupported) {#planned-features-currently-unsupported}
23+
24+
- [AWS KMS](https://aws.amazon.com/kms/) aka CMEK (customer-managed encryption keys)
25+
- ClickPipes for ingest
26+
- Autoscaling
27+
- MySQL interface

Diff for: ‎docs/cloud/reference/byoc-onboarding.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## Onboarding Process {#onboarding-process}
2+
3+
Customers can initiate the onboarding process by reaching out to [us](https://clickhouse.com/cloud/bring-your-own-cloud). Customers need to have a dedicated AWS account and know the region they will use. At this time, we are allowing users to launch BYOC services only in the regions that we support for ClickHouse Cloud.
4+
5+
### Prepare a Dedicated AWS Account {#prepare-a-dedicated-aws-account}
6+
7+
Customers must prepare a dedicated AWS account for hosting the ClickHouse BYOC deployment to ensure better isolation. With this and the initial organization admin email, you can contact ClickHouse support.
8+
9+
### Apply CloudFormation Template {#apply-cloudformation-template}
10+
11+
BYOC setup is initialized via a [CloudFormation stack](https://s3.us-east-2.amazonaws.com/clickhouse-public-resources.clickhouse.cloud/cf-templates/byoc.yaml), which creates only a role allowing BYOC controllers from ClickHouse Cloud to manage infrastructure. The S3, VPC, and compute resources for running ClickHouse are not included in this stack.
12+
13+
<!-- TODO: Add Screenshot for the rest of onboarding, once self-served onboarding is implemented. -->
14+
15+
### Setup BYOC Infrastructure {#setup-byoc-infrastructure}
16+
17+
After creating the CloudFormation stack, you will be prompted to set up the infrastructure, including S3, VPC, and the EKS cluster, from the cloud console. Certain configurations must be determined at this stage, as they cannot be changed later. Specifically:
18+
19+
- **The region you want to use**, you can choose one of any [public regions](/cloud/reference/supported-regions) we have for ClickHouse Cloud.
20+
- **The VPC CIDR range for BYOC**: By default, we use `10.0.0.0/16` for the BYOC VPC CIDR range. If you plan to use VPC peering with another account, ensure the CIDR ranges do not overlap. Allocate a proper CIDR range for BYOC, with a minimum size of `/22` to accommodate necessary workloads.
21+
- **Availability Zones for BYOC VPC**: If you plan to use VPC peering, aligning availability zones between the source and BYOC accounts can help reduce cross-AZ traffic costs. In AWS, availability zone suffixes (`a, b, c`) may represent different physical zone IDs across accounts. See the [AWS guide](https://docs.aws.amazon.com/prescriptive-guidance/latest/patterns/use-consistent-availability-zones-in-vpcs-across-different-aws-accounts.html) for details.

Diff for: ‎docs/cloud/reference/byoc-overview.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: 'BYOC (Bring Your Own Cloud) for AWS'
3+
slug: /cloud/reference/byoc
4+
sidebar_label: 'BYOC (Bring Your Own Cloud)'
5+
keywords: ['BYOC', 'cloud', 'bring your own cloud']
6+
description: 'Deploy ClickHouse on your own cloud infrastructure'
7+
---
8+
9+
import Image from '@theme/IdealImage';
10+
import byoc1 from '@site/static/images/cloud/reference/byoc-1.png';
11+
12+
## Overview {#overview}
13+
14+
BYOC (Bring Your Own Cloud) allows you to deploy ClickHouse Cloud on your own cloud infrastructure. This is useful if you have specific requirements or constraints that prevent you from using the ClickHouse Cloud managed service.
15+
16+
**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.
17+
18+
BYOC is currently only supported for AWS, with GCP and Microsoft Azure in development.
19+
20+
:::note
21+
BYOC is designed specifically for large-scale deployments, and requires customers to sign a committed contract.
22+
:::
23+
24+
## Glossary {#glossary}
25+
26+
- **ClickHouse VPC:** The VPC owned by ClickHouse Cloud.
27+
- **Customer BYOC VPC:** The VPC, owned by the customer’s cloud account, is provisioned and managed by ClickHouse Cloud and dedicated to a ClickHouse Cloud BYOC deployment.
28+
- **Customer VPC** Other VPCs owned by the customer cloud account used for applications that need to connect to the Customer BYOC VPC.
29+
30+
## Architecture {#architecture}
31+
32+
Metrics and logs are stored within the customer's BYOC VPC. Logs are currently stored in locally in EBS. In a future update, logs will be stored in LogHouse, which is a ClickHouse service in the customer's BYOC VPC. Metrics are implemented via a Prometheus and Thanos stack stored locally in the customer's BYOC VPC.
33+
34+
<br />
35+
36+
<Image img={byoc1} size="lg" alt="BYOC Architecture" background='black'/>
37+
38+
<br />

Diff for: ‎docs/cloud/reference/byoc-permission-network.md

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
## CloudFormation IAM Roles {#cloudformation-iam-roles}
2+
3+
### Bootstrap IAM role {#bootstrap-iam-role}
4+
5+
The bootstrap IAM role has the following permissions:
6+
7+
- **EC2 and VPC operations**: Required for setting up VPC and EKS clusters.
8+
- **S3 operations (e.g., `s3:CreateBucket`)**: Needed to create buckets for ClickHouse BYOC storage.
9+
- **`route53:*` permissions**: Required for external DNS to configure records in Route 53.
10+
- **IAM operations (e.g., `iam:CreatePolicy`)**: Needed for controllers to create additional roles (see the next section for details).
11+
- **EKS operations**: Limited to resources with names starting with the `clickhouse-cloud` prefix.
12+
13+
### Additional IAM roles created by the controller {#additional-iam-roles-created-by-the-controller}
14+
15+
In addition to the `ClickHouseManagementRole` created via CloudFormation, the controller will create several additional roles.
16+
17+
These roles are assumed by applications running within the customer's EKS cluster:
18+
- **State Exporter Role**
19+
- ClickHouse component that reports service health information to ClickHouse Cloud.
20+
- Requires permission to write to an SQS queue owned by ClickHouse Cloud.
21+
- **Load-Balancer Controller**
22+
- Standard AWS load balancer controller.
23+
- EBS CSI Controller to manage volumes for ClickHouse services.
24+
- **External-DNS**
25+
- Propagates DNS configurations to Route 53.
26+
- **Cert-Manager**
27+
- Provisions TLS certificates for BYOC service domains.
28+
- **Cluster Autoscaler**
29+
- Adjusts the node group size as needed.
30+
31+
**K8s-control-plane** and **k8s-worker** roles are meant to be assumed by AWS EKS services.
32+
33+
Lastly, **`data-plane-mgmt`** allows a ClickHouse Cloud Control Plane component to reconcile necessary custom resources, such as `ClickHouseCluster` and the Istio Virtual Service/Gateway.
34+
35+
## Network Boundaries {#network-boundaries}
36+
37+
This section covers different network traffic to and from the customer BYOC VPC:
38+
39+
- **Inbound**: Traffic entering the customer BYOC VPC.
40+
- **Outbound**: Traffic originating from the customer BYOC VPC and sent to an external destination.
41+
- **Public**: A network endpoint accessible from the public internet.
42+
- **Private**: A network endpoint accessible only through private connections, such as VPC peering, VPC Private Link, or Tailscale.
43+
44+
**Istio ingress is deployed behind an AWS NLB to accept ClickHouse client traffic.**
45+
46+
*Inbound, Public (can be Private)*
47+
48+
The Istio ingress gateway terminates TLS. The certificate, provisioned by CertManager with Let's Encrypt, is stored as a secret within the EKS cluster. Traffic between Istio and ClickHouse is [encrypted by AWS](https://docs.aws.amazon.com/whitepapers/latest/logical-separation/encrypting-data-at-rest-and--in-transit.html#:~:text=All%20network%20traffic%20between%20AWS,supported%20Amazon%20EC2%20instance%20types) since they reside in the same VPC.
49+
50+
By default, ingress is publicly accessible with IP allow list filtering. Customers can configure VPC peering to make it private and disable public connections. We highly recommend setting up an [IP filter](/cloud/security/setting-ip-filters) to restrict access.
51+
52+
### Troubleshooting access {#troubleshooting-access}
53+
54+
*Inbound, Public (can be Private)*
55+
56+
ClickHouse Cloud engineers require troubleshooting access via Tailscale. They are provisioned with just-in-time certificate-based authentication for BYOC deployments.
57+
58+
### Billing scraper {#billing-scraper}
59+
60+
*Outbound, Private*
61+
62+
The Billing scraper collects billing data from ClickHouse and sends it to an S3 bucket owned by ClickHouse Cloud.
63+
64+
It runs as a sidecar alongside the ClickHouse server container, periodically scraping CPU and memory metrics. Requests within the same region are routed through VPC gateway service endpoints.
65+
66+
### Alerts {#alerts}
67+
68+
*Outbound, Public*
69+
70+
AlertManager is configured to send alerts to ClickHouse Cloud when the customer's ClickHouse cluster is unhealthy.
71+
72+
Metrics and logs are stored within the customer's BYOC VPC. Logs are currently stored locally in EBS. In a future update, they will be stored in LogHouse, a ClickHouse service within the BYOC VPC. Metrics use a Prometheus and Thanos stack, stored locally in the BYOC VPC.
73+
74+
### Service state {#service-state}
75+
76+
*Outbound*
77+
78+
State Exporter sends ClickHouse service state information to an SQS owned by ClickHouse Cloud.

Diff for: ‎docs/cloud/reference/byoc-upgrade.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## Upgrade Process {#upgrade-process}
2+
3+
We regularly upgrade the software, including ClickHouse database version upgrades, ClickHouse Operator, EKS, and other components.
4+
5+
While we aim for seamless upgrades (e.g., rolling upgrades and restarts), some, such as ClickHouse version changes and EKS node upgrades, may impact service. Customers can specify a maintenance window (e.g., every Tuesday at 1:00 a.m. PDT), ensuring such upgrades occur only during the scheduled time.
6+
7+
:::note
8+
Maintenance windows do not apply to security and vulnerability fixes. These are handled as off-cycle upgrades, with timely communication to coordinate a suitable time and minimize operational impact.
9+
:::

0 commit comments

Comments
 (0)