Skip to content

[BYOC][AWS] Onboarding using terraform module #4038

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Blargian merged 2 commits into from
Jul 8, 2025
Merged

[BYOC][AWS] Onboarding using terraform module #4038

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c343bd
[BYOC][AWS] Onboarding using terraform module
kostyaplis Jul 8, 2025
51e5958
Update byoc.md
Blargian Jul 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions docs/cloud/reference/byoc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,24 @@

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

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

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

Check notice on line 63 in docs/cloud/reference/byoc.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.Contractions 

Suggestion: Use 'aren't' instead of 'are not'.

Check notice on line 63 in docs/cloud/reference/byoc.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.Wordy 

Suggestion: Remove the phrase 'note that'.

#### CloudFormation Template {#cloudformation-template}

[BYOC CloudFormation template](https://s3.us-east-2.amazonaws.com/clickhouse-public-resources.clickhouse.cloud/cf-templates/byoc.yaml)

#### Terraform Module {#terraform-module}

[BYOC Terraform module](https://s3.us-east-2.amazonaws.com/clickhouse-public-resources.clickhouse.cloud/tf/byoc.tar.gz)

```hcl
module "clickhouse_onboarding" {
source = "https://s3.us-east-2.amazonaws.com/clickhouse-public-resources.clickhouse.cloud/tf/byoc.tar.gz"
byoc_env = "production"
}
```

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

Expand Down