You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/cloud/guides/best_practices/usagelimits.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,6 +38,10 @@ or look together at how we can increase them in a controlled manner.
38
38
39
39
For warehouse replica and scaling limits, see [warehouses](/cloud/reference/warehouses#scaling).
40
40
41
+
:::note
42
+
The values above are default guardrails. The limit enforced for a specific service may be higher than the value shown here, as larger services are configured with more headroom. The actual limit that applies to your service is included in the warning you receive as you approach it.
43
+
:::
44
+
41
45
:::note
42
46
For Single Replica Services, the maximum number of databases is restricted to
43
47
100, and the maximum number of tables is restricted to 500. In addition, storage
Copy file name to clipboardExpand all lines: docs/cloud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/01_standard.md
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,19 +53,23 @@ The initial BYOC setup can be performed using a [CloudFormation template (AWS)](
53
53
Storage buckets, VPC/VNet, Kubernetes cluster, and compute resources required for running ClickHouse aren't included in this initial setup. They will be provisioned in the next step.
54
54
:::
55
55
56
-
#### Alternative Terraform Module for AWS {#terraform-module-aws}
56
+
#### Terraform Module for AWS {#terraform-module-aws}
57
57
58
-
If you prefer to use Terraform instead of CloudFormation for AWS deployments, we also provide a [Terraform module for AWS](https://s3.us-east-2.amazonaws.com/clickhouse-public-resources.clickhouse.cloud/tf/byoc.tar.gz).
59
-
60
-
Usage:
58
+
If you prefer to use Terraform instead of CloudFormation for AWS deployments, use the [terraform-byoc-onboarding](https://github.com/ClickHouse/terraform-byoc-onboarding) module:
Replace `<version>` with the latest tag from the module's [releases page](https://github.com/ClickHouse/terraform-byoc-onboarding/releases) — always use the latest release.
68
+
69
+
:::note
70
+
The module was previously distributed as a tarball at `https://s3.us-east-2.amazonaws.com/clickhouse-public-resources.clickhouse.cloud/tf/byoc.tar.gz`. That URL remains available but is deprecated — use the GitHub module above.
71
+
:::
72
+
69
73
### Set up BYOC infrastructure {#setup-byoc-infrastructure}
70
74
71
75
You will be prompted to set up the infrastructure, including object storage buckets, VPC/VNet, and the Kubernetes cluster, from the ClickHouse Cloud console. Certain configurations must be determined at this stage, as they can't be changed later. Specifically:
@@ -86,7 +90,7 @@ After your BYOC infrastructure has been provisioned, you're ready to launch your
86
90
87
91
<Imageimg={byoc_new_service_1}size="md"alt="BYOC create new service"/>
88
92
89
-
During service creation, you’ll configure the following options:
93
+
During service creation, you'll configure the following options:
90
94
91
95
-**Service name**: Enter a clear, descriptive name for your ClickHouse service.
92
96
-**BYOC infrastructure**: Select the BYOC environment, including the cloud account and region, where your service will run.
Copy file name to clipboardExpand all lines: docs/cloud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/02_customization/01_aws.md
+11-5Lines changed: 11 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,26 +46,32 @@ Ensure your VPC has working DNS resolution and doesn't block, interfere with, or
46
46
47
47
### Configure your AWS account {#configure-aws-account}
48
48
49
-
The initial BYOC setup creates a privileged IAM role (`ClickHouseManagementRole`) that enables BYOC controllers from ClickHouse Cloud to manage your infrastructure. This can be performed using either a [CloudFormation template](https://s3.us-east-2.amazonaws.com/clickhouse-public-resources.clickhouse.cloud/cf-templates/byoc.yaml) or a [Terraform module](https://s3.us-east-2.amazonaws.com/clickhouse-public-resources.clickhouse.cloud/tf/byoc.tar.gz).
49
+
The initial BYOC setup creates a privileged IAM role (`ClickHouseManagementRole`) that enables BYOC controllers from ClickHouse Cloud to manage your infrastructure. This can be performed using either a [CloudFormation template](https://s3.us-east-2.amazonaws.com/clickhouse-public-resources.clickhouse.cloud/cf-templates/byoc.yaml) or a Terraform module (see below).
50
50
51
51
When deploying for a `BYO-VPC` setup, set the `IncludeVPCWritePermissions` parameter to `false` to ensure ClickHouse Cloud doesn't receive permissions to modify your customer-managed VPC.
52
52
53
53
:::note
54
54
Storage buckets, Kubernetes cluster, and compute resources required for running ClickHouse aren't included in this initial setup. They will be provisioned in a later step. While you control your VPC, ClickHouse Cloud still requires IAM permissions to create and manage the Kubernetes cluster, IAM roles for service accounts, S3 buckets, and other essential resources in your AWS account.
55
55
:::
56
56
57
-
#### Alternative Terraform module {#terraform-module-aws}
57
+
#### Terraform module {#terraform-module-aws}
58
58
59
-
If you prefer to use Terraform instead of CloudFormation, use the following module:
59
+
If you prefer to use Terraform instead of CloudFormation, use the [terraform-byoc-onboarding](https://github.com/ClickHouse/terraform-byoc-onboarding) module:
Replace `<version>` with the latest tag from the module's [releases page](https://github.com/ClickHouse/terraform-byoc-onboarding/releases) — always use the latest release.
70
+
71
+
:::note
72
+
The module was previously distributed as a tarball at `https://s3.us-east-2.amazonaws.com/clickhouse-public-resources.clickhouse.cloud/tf/byoc.tar.gz`. That URL remains available but is deprecated — use the GitHub module above.
73
+
:::
74
+
69
75
### Set up BYOC infrastructure {#set-up-byoc-infrastructure}
70
76
71
77
In the ClickHouse Cloud console, configure the following when setting up new infrastructure:
Copy file name to clipboardExpand all lines: docs/integrations/data-ingestion/clickpipes/aws-privatelink.md
+52-1Lines changed: 52 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,7 @@ integration:
10
10
- category: 'clickpipes'
11
11
---
12
12
13
+
import PrivatePreviewBadge from '@theme/badges/PrivatePreviewBadge';
13
14
import cp_service from '@site/static/images/integrations/data-ingestion/clickpipes/cp_service.png';
14
15
import cp_step0 from '@site/static/images/integrations/data-ingestion/clickpipes/cp_step0.png';
15
16
import cp_rpe_select from '@site/static/images/integrations/data-ingestion/clickpipes/cp_rpe_select.png';
@@ -189,6 +190,8 @@ It requires setting up a NLB (Network Load Balancer) in front of your data sourc
189
190
and configuring the VPC endpoint service to use the NLB.
190
191
191
192
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.
193
+
If your service can't use PrivateLink managed private DNS (for example, the provider requires
194
+
consumers to manage DNS resolution, as Confluent Cloud does), see [Custom private DNS](#custom-private-dns).
192
195
193
196
It's a preferred choice for:
194
197
@@ -208,6 +211,52 @@ See AWS guide for [managing permissions](https://docs.aws.amazon.com/vpc/latest/
208
211
can be configured for ClickPipes. Add [your ClickPipe region](#aws-privatelink-regions) to the allowed regions in your VPC endpoint service.
209
212
:::
210
213
214
+
## Custom private DNS {#custom-private-dns}
215
+
216
+
<PrivatePreviewBadge/>
217
+
218
+
:::info
219
+
Custom private DNS is in **Private Preview**. Reach out to the [ClickHouse support team](https://clickhouse.com/support/program) to enable it for your service.
for VPC endpoint services with a verified domain. Some services require each consumer to manage DNS resolution in their own VPC, e.g., Confluent Cloud requires consumers to resolve broker hostnames to the PrivateLink endpoint.
224
+
225
+
For these cases, ClickPipes supports attaching custom private DNS names to a reverse private
226
+
endpoint. ClickPipes resolves these names to the endpoint's private addresses, so your data
227
+
source can be reached by its own hostname over private connectivity.
228
+
229
+
Custom private DNS complements managed private DNS — it doesn't replace it. If your
230
+
PrivateLink service already provides private DNS names, you don't need custom names.
231
+
232
+
Custom private DNS names are supported for the [VPC endpoint service](#vpc-endpoint-service)
233
+
and [VPC resource](#vpc-resource) endpoint types. MSK multi-VPC provides managed private DNS
234
+
out-of-the-box and doesn't support custom names.
235
+
236
+
The following rules apply to custom private DNS names:
237
+
238
+
- Exact names (`kafka.internal.example.com`) and wildcard names (`*.example.com`) are
239
+
supported. A wildcard matches a single DNS label — for example,
Copy file name to clipboardExpand all lines: docs/integrations/data-ingestion/clickpipes/kafka/02_schema-registries.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ To integrate with a schema registry during ClickPipes configuration, you must us
36
36
37
37
ClickPipes connects to the schema registry over HTTPS at the URL you provide. The schema registry does not need to be publicly accessible.
38
38
39
-
If your Kafka brokers are reached through a [reverse private endpoint](/integrations/clickpipes/aws-privatelink) (AWS PrivateLink or GCP Private Service Connect), the schema registry can use the same private connectivity. ClickPipes resolves the registry hostname through the reverse private endpoint's private DNS, so a registry hosted privately alongside your brokers is reachable as long as its hostname resolves to the reverse private endpoint's private IP addresses (via the endpoint's private DNS support or a custom private DNS mapping).
39
+
If your Kafka brokers are reached through a [reverse private endpoint](/integrations/clickpipes/aws-privatelink) (AWS PrivateLink or GCP Private Service Connect), the schema registry can use the same private connectivity. ClickPipes resolves the registry hostname through the reverse private endpoint's private DNS, so a registry hosted privately alongside your brokers is reachable as long as its hostname resolves to the reverse private endpoint's private IP addresses (via the endpoint's private DNS support or a [custom private DNS mapping](/integrations/clickpipes/aws-privatelink#custom-private-dns)).
0 commit comments