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/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:
0 commit comments