Skip to content

Commit 97626bd

Browse files
committed
Merge remote-tracking branch 'origin/main' into raymond-entra-id-scim
2 parents 7133033 + 15423ea commit 97626bd

7 files changed

Lines changed: 82 additions & 15 deletions

File tree

docs/cloud/guides/best_practices/usagelimits.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,10 @@ or look together at how we can increase them in a controlled manner.
3838

3939
For warehouse replica and scaling limits, see [warehouses](/cloud/reference/warehouses#scaling).
4040

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+
4145
:::note
4246
For Single Replica Services, the maximum number of databases is restricted to
4347
100, and the maximum number of tables is restricted to 500. In addition, storage

docs/cloud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/01_standard.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -53,19 +53,23 @@ The initial BYOC setup can be performed using a [CloudFormation template (AWS)](
5353
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.
5454
:::
5555

56-
#### Alternative Terraform Module for AWS {#terraform-module-aws}
56+
#### Terraform Module for AWS {#terraform-module-aws}
5757

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:
6159

6260
```hcl
6361
module "clickhouse_onboarding" {
64-
source = "https://s3.us-east-2.amazonaws.com/clickhouse-public-resources.clickhouse.cloud/tf/byoc.tar.gz"
65-
byoc_env = "production"
62+
source = "github.com/ClickHouse/terraform-byoc-onboarding.git//modules/aws?ref=<version>"
63+
external_id = "<external-id-provided-by-clickhouse>"
6664
}
6765
```
6866

67+
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+
6973
### Set up BYOC infrastructure {#setup-byoc-infrastructure}
7074

7175
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
8690

8791
<Image img={byoc_new_service_1} size="md" alt="BYOC create new service"/>
8892

89-
During service creation, youll configure the following options:
93+
During service creation, you'll configure the following options:
9094

9195
- **Service name**: Enter a clear, descriptive name for your ClickHouse service.
9296
- **BYOC infrastructure**: Select the BYOC environment, including the cloud account and region, where your service will run.

docs/cloud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/02_customization/01_aws.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,26 +46,32 @@ Ensure your VPC has working DNS resolution and doesn't block, interfere with, or
4646

4747
### Configure your AWS account {#configure-aws-account}
4848

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).
5050

5151
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.
5252

5353
:::note
5454
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.
5555
:::
5656

57-
#### Alternative Terraform module {#terraform-module-aws}
57+
#### Terraform module {#terraform-module-aws}
5858

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:
6060

6161
```hcl
6262
module "clickhouse_onboarding" {
63-
source = "https://s3.us-east-2.amazonaws.com/clickhouse-public-resources.clickhouse.cloud/tf/byoc.tar.gz"
64-
byoc_env = "production"
63+
source = "github.com/ClickHouse/terraform-byoc-onboarding.git//modules/aws?ref=<version>"
64+
external_id = "<external-id-provided-by-clickhouse>"
6565
include_vpc_write_permissions = false
6666
}
6767
```
6868

69+
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+
6975
### Set up BYOC infrastructure {#set-up-byoc-infrastructure}
7076

7177
In the ClickHouse Cloud console, configure the following when setting up new infrastructure:

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

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ integration:
1010
- category: 'clickpipes'
1111
---
1212

13+
import PrivatePreviewBadge from '@theme/badges/PrivatePreviewBadge';
1314
import cp_service from '@site/static/images/integrations/data-ingestion/clickpipes/cp_service.png';
1415
import cp_step0 from '@site/static/images/integrations/data-ingestion/clickpipes/cp_step0.png';
1516
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
189190
and configuring the VPC endpoint service to use the NLB.
190191

191192
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).
192195

193196
It's a preferred choice for:
194197

@@ -208,6 +211,52 @@ See AWS guide for [managing permissions](https://docs.aws.amazon.com/vpc/latest/
208211
can be configured for ClickPipes. Add [your ClickPipe region](#aws-privatelink-regions) to the allowed regions in your VPC endpoint service.
209212
:::
210213

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.
220+
:::
221+
222+
AWS PrivateLink provides [managed private DNS](https://docs.aws.amazon.com/vpc/latest/privatelink/manage-dns-names.html)
223+
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,
240+
`*.abcde12345.us-east-1.aws.confluent.cloud` matches
241+
`b0-lkc123.abcde12345.us-east-1.aws.confluent.cloud`.
242+
- Names must be unique across all reverse private endpoints of a ClickHouse service,
243+
including overlaps between wildcard and exact names.
244+
- Names under reserved suffixes (e.g., `local`, `localhost`, `internal`, `corp`,
245+
`private`) are rejected.
246+
247+
To configure custom private DNS names:
248+
249+
- In the ClickHouse Cloud console, fill in the `Custom private DNS name` field when
250+
[creating a reverse private endpoint](#creating-clickpipe). The field is shown once the
251+
feature is enabled for your service.
252+
- With [OpenAPI](https://clickhouse.com/docs/cloud/manage/api/swagger), set
253+
`customPrivateDnsMappings` when creating a reverse private endpoint, or update an existing
254+
endpoint with a `PATCH` request. Updates replace the full list of mappings; an empty list
255+
removes all custom names.
256+
- With Terraform, use the
257+
[`clickhouse_clickpipes_reverse_private_endpoint_custom_private_dns`](https://registry.terraform.io/providers/ClickHouse/clickhouse/latest/docs/resources/clickpipes_reverse_private_endpoint_custom_private_dns)
258+
resource to manage mappings on an existing reverse private endpoint.
259+
211260
## Creating a ClickPipe with reverse private endpoint {#creating-clickpipe}
212261

213262
<VerticalStepper headerLevel="list">
@@ -246,6 +295,7 @@ For same-region access, creating a VPC Resource is the recommended approach.
246295
- For VPC resource, provide the configuration share ARN and configuration ID.
247296
- For MSK multi-VPC, provide the cluster ARN and authentication method used with a created endpoint.
248297
- For VPC endpoint service, provide the service name.
298+
- Optionally, provide a [custom private DNS](#custom-private-dns) name.
249299

250300
7. Click on `Create` and wait for the reverse private endpoint to be ready.
251301

@@ -258,7 +308,8 @@ For same-region access, creating a VPC Resource is the recommended approach.
258308
8. Once the endpoint is ready, you can use a DNS name to connect to the data source.
259309

260310
On a list of endpoints, you can see the DNS name for the available endpoint.
261-
It can be either an internally ClickPipes provisioned DNS name or a private DNS name supplied by a PrivateLink service.
311+
It can be an internally ClickPipes provisioned DNS name, a private DNS name supplied by a PrivateLink service,
312+
or a [custom private DNS name](#custom-private-dns).
262313
DNS name isn't a complete network address.
263314
Add the port according to the data source.
264315

docs/integrations/data-ingestion/clickpipes/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,9 +118,10 @@ For other services, ClickPipes traffic will originate from a default region base
118118
|--------------------------------------------------|------------------------------------------------------------------------------------------------------------|
119119
| **asia-northeast1** - Tokyo (from 27 May 2026) | `104.198.114.210`, `35.221.66.81`, `35.243.126.127`, `136.110.107.86`, `34.85.18.112` |
120120
| **asia-southeast1** - Singapore (from 27 May 2026) | `34.21.197.28`, `35.197.141.23`, `35.197.157.90`, `136.110.17.200`, `35.185.179.231` |
121+
| **australia-southeast1** - Sydney (from 7 Jul 2026) | `34.40.200.47`, `34.151.85.215`, `34.151.163.22`, `34.87.195.243`, `34.40.243.42` |
121122
| **europe-west2** - London (from 27 May 2026) | `35.242.131.178`, `34.39.77.101`, `34.39.47.179`, `34.89.53.234`, `8.228.63.151` |
122123
| **europe-west4** - Netherlands (from 27 May 2026) | `34.34.86.3`, `34.6.175.56`, `34.178.6.187`, `34.91.204.220`, `34.12.85.206` |
123-
| **us-central1** - Iowa (from 27 May 2026) | `34.28.24.54`, `34.42.56.195`, `34.63.141.9`, `35.238.146.37`, `34.10.251.49` |
124+
| **us-central1** - Iowa (from 7 Jul 2026) | `34.28.24.54`, `34.42.56.195`, `34.63.141.9`, `35.238.146.37`, `34.10.251.49` |
124125
| **us-east1** - South Carolina (from 27 May 2026) | `34.24.134.232`, `34.24.214.165`, `34.24.20.1`, `35.243.193.248`, `34.23.98.76` |
125126
| **us-west1** - Oregon (from 1 Jul 2026) | `136.118.254.175`, `8.229.115.2`, `34.83.0.219`, `35.247.34.28`, `35.199.165.121` |
126127

docs/integrations/data-ingestion/clickpipes/kafka/02_schema-registries.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ To integrate with a schema registry during ClickPipes configuration, you must us
3636

3737
ClickPipes connects to the schema registry over HTTPS at the URL you provide. The schema registry does not need to be publicly accessible.
3838

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)).
4040

4141
Keep the following in mind:
4242

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1671,6 +1671,7 @@ const sidebars = {
16711671
'operations/settings/composable-protocols',
16721672
'operations/settings/constraints-on-settings',
16731673
'operations/settings/memory-overcommit',
1674+
'operations/settings/oom-canary',
16741675
// "operations/settings/mysql-binlog-client",
16751676
'operations/settings/permissions-for-queries',
16761677
'operations/settings/query-complexity',

0 commit comments

Comments
 (0)