Skip to content

Commit 965948a

Browse files
authored
Merge pull request #4038 from ClickHouse/byoc-aws-onboarding
[BYOC][AWS] Onboarding using terraform module
2 parents 170850f + 51e5958 commit 965948a

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

docs/cloud/reference/byoc.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,24 @@ Customers are recommended to prepare a dedicated AWS account for hosting the Cli
5858

5959
With this account and the initial organization admin email, you can contact ClickHouse support.
6060

61-
### Apply CloudFormation Template {#apply-cloudformation-template}
61+
### Initialize BYOC setup {#initialize-byoc-setup}
6262

63-
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.
63+
The initial BYOC setup can be performed using either a CloudFormation template or a Terraform module. Both approaches create the same IAM role, enabling BYOC controllers from ClickHouse Cloud to manage your infrastructure. Note that S3, VPC, and compute resources required for running ClickHouse are not included in this initial setup.
64+
65+
#### CloudFormation Template {#cloudformation-template}
66+
67+
[BYOC CloudFormation template](https://s3.us-east-2.amazonaws.com/clickhouse-public-resources.clickhouse.cloud/cf-templates/byoc.yaml)
68+
69+
#### Terraform Module {#terraform-module}
70+
71+
[BYOC Terraform module](https://s3.us-east-2.amazonaws.com/clickhouse-public-resources.clickhouse.cloud/tf/byoc.tar.gz)
72+
73+
```hcl
74+
module "clickhouse_onboarding" {
75+
source = "https://s3.us-east-2.amazonaws.com/clickhouse-public-resources.clickhouse.cloud/tf/byoc.tar.gz"
76+
byoc_env = "production"
77+
}
78+
```
6479

6580
<!-- TODO: Add Screenshot for the rest of onboarding, once self-served onboarding is implemented. -->
6681

0 commit comments

Comments
 (0)