Skip to content

Commit f8c48b9

Browse files
authored
Merge pull request #6497 from ClickHouse/byoc-aws-onboarding-module-docs
docs: point AWS BYOC onboarding Terraform at terraform-byoc-onboarding module
2 parents c67dc3d + 0ecc96a commit f8c48b9

2 files changed

Lines changed: 22 additions & 12 deletions

File tree

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:

0 commit comments

Comments
 (0)