From e684d0028dc38bddfc35a0cf074b1064b3e54935 Mon Sep 17 00:00:00 2001 From: "Dr. Ernie Prabhakar" Date: Tue, 3 Mar 2026 07:47:16 -0800 Subject: [PATCH 1/6] docs: clarify Terraform/CloudFormation deployment relationship Explain that both deployment paths ultimately run a CloudFormation stack, but with Terraform the foundational infrastructure (VPC, RDS, OpenSearch) is provisioned first by Terraform and then wired into CFT automatically. Moves the deployment path intro before the CF/TF section split so the architecture is clear before readers dive into either method. Also removes the misleading mention of Terraform as a CFT driver under ### CloudFormation. Co-Authored-By: Claude Sonnet 4.6 --- docs/Catalog/Installation.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/docs/Catalog/Installation.md b/docs/Catalog/Installation.md index dde180ad05b..a7917f04baf 100644 --- a/docs/Catalog/Installation.md +++ b/docs/Catalog/Installation.md @@ -133,10 +133,21 @@ Quilt when a new version is released.) Note: the following screenshots may differ slightly from what you see in Service Catalog. +Quilt supports two deployment paths: **CloudFormation** and **Terraform**. +In both cases, the Quilt application runs as a CloudFormation stack. With +Terraform, an outer Terraform layer first provisions the foundational +infrastructure (VPC, database, search cluster), then deploys the CloudFormation +stack automatically, wiring in those resources. With CloudFormation alone, +all resources are managed within a single stack. + +Use CloudFormation if you want a straightforward, self-contained deployment. +Use Terraform if you need infrastructure-as-code control over the underlying +network, database, and search resources. + ### CloudFormation You can perform stack update and creation with the AWS Console, AWS CLI, -Terraform, or other means. +or other means. > **Important:** Use Quilt-provided CloudFormation templates without modification. > Customizing templates may result in deployment issues and can affect your service @@ -188,8 +199,8 @@ which enables more granular infrastructure-as-code control. Terraform users **must** request a compatible CloudFormation template from Quilt: > Contact your account manager to obtain a template that works with Terraform and -includes necessary variables. - +> includes necessary variables. +> > **Important:** Use Quilt-provided Terraform modules and CloudFormation templates > without modification. Customizing these resources may result in deployment issues > and can affect your service agreement coverage. If you require specific From 825146f4b749623f4b18ee79697fd3752409fbf5 Mon Sep 17 00:00:00 2001 From: "Dr. Ernie Prabhakar" Date: Tue, 3 Mar 2026 07:52:09 -0800 Subject: [PATCH 2/6] docs: reorder CF/TF sentences (CF first, then TF) Co-Authored-By: Claude Sonnet 4.6 --- docs/Catalog/Installation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Catalog/Installation.md b/docs/Catalog/Installation.md index a7917f04baf..88b4de174e9 100644 --- a/docs/Catalog/Installation.md +++ b/docs/Catalog/Installation.md @@ -135,10 +135,10 @@ you see in Service Catalog. Quilt supports two deployment paths: **CloudFormation** and **Terraform**. In both cases, the Quilt application runs as a CloudFormation stack. With +CloudFormation alone, all resources are managed within a single stack. With Terraform, an outer Terraform layer first provisions the foundational infrastructure (VPC, database, search cluster), then deploys the CloudFormation -stack automatically, wiring in those resources. With CloudFormation alone, -all resources are managed within a single stack. +stack automatically, wiring in those resources. Use CloudFormation if you want a straightforward, self-contained deployment. Use Terraform if you need infrastructure-as-code control over the underlying From 83eef5caf33af3cd74640382c1c22f1032f4ee33 Mon Sep 17 00:00:00 2001 From: "Dr. Ernie Prabhakar" Date: Tue, 3 Mar 2026 07:53:24 -0800 Subject: [PATCH 3/6] docs: move deployment path intro to top of Installation Methods Co-Authored-By: Claude Sonnet 4.6 --- docs/Catalog/Installation.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/Catalog/Installation.md b/docs/Catalog/Installation.md index 88b4de174e9..cc07e83147d 100644 --- a/docs/Catalog/Installation.md +++ b/docs/Catalog/Installation.md @@ -99,6 +99,17 @@ following Bucket characteristics: ## Installation Methods +Quilt supports two deployment paths: **CloudFormation** and **Terraform**. +In both cases, the Quilt application runs as a CloudFormation stack. With +CloudFormation alone, all resources are managed within a single stack. With +Terraform, an outer Terraform layer first provisions the foundational +infrastructure (VPC, database, search cluster), then deploys the CloudFormation +stack automatically, wiring in those resources. + +Use CloudFormation if you want a straightforward, self-contained deployment. +Use Terraform if you need infrastructure-as-code control over the underlying +network, database, and search resources. + ### AWS Marketplace You can install Quilt via AWS Marketplace. As indicated above, we @@ -133,17 +144,6 @@ Quilt when a new version is released.) Note: the following screenshots may differ slightly from what you see in Service Catalog. -Quilt supports two deployment paths: **CloudFormation** and **Terraform**. -In both cases, the Quilt application runs as a CloudFormation stack. With -CloudFormation alone, all resources are managed within a single stack. With -Terraform, an outer Terraform layer first provisions the foundational -infrastructure (VPC, database, search cluster), then deploys the CloudFormation -stack automatically, wiring in those resources. - -Use CloudFormation if you want a straightforward, self-contained deployment. -Use Terraform if you need infrastructure-as-code control over the underlying -network, database, and search resources. - ### CloudFormation You can perform stack update and creation with the AWS Console, AWS CLI, From 17fce51eb04baa0727a2087e86e56bca4f525342 Mon Sep 17 00:00:00 2001 From: "Dr. Ernie Prabhakar" Date: Tue, 3 Mar 2026 07:56:41 -0800 Subject: [PATCH 4/6] revert --- docs/Catalog/Installation.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/Catalog/Installation.md b/docs/Catalog/Installation.md index cc07e83147d..88b4de174e9 100644 --- a/docs/Catalog/Installation.md +++ b/docs/Catalog/Installation.md @@ -99,17 +99,6 @@ following Bucket characteristics: ## Installation Methods -Quilt supports two deployment paths: **CloudFormation** and **Terraform**. -In both cases, the Quilt application runs as a CloudFormation stack. With -CloudFormation alone, all resources are managed within a single stack. With -Terraform, an outer Terraform layer first provisions the foundational -infrastructure (VPC, database, search cluster), then deploys the CloudFormation -stack automatically, wiring in those resources. - -Use CloudFormation if you want a straightforward, self-contained deployment. -Use Terraform if you need infrastructure-as-code control over the underlying -network, database, and search resources. - ### AWS Marketplace You can install Quilt via AWS Marketplace. As indicated above, we @@ -144,6 +133,17 @@ Quilt when a new version is released.) Note: the following screenshots may differ slightly from what you see in Service Catalog. +Quilt supports two deployment paths: **CloudFormation** and **Terraform**. +In both cases, the Quilt application runs as a CloudFormation stack. With +CloudFormation alone, all resources are managed within a single stack. With +Terraform, an outer Terraform layer first provisions the foundational +infrastructure (VPC, database, search cluster), then deploys the CloudFormation +stack automatically, wiring in those resources. + +Use CloudFormation if you want a straightforward, self-contained deployment. +Use Terraform if you need infrastructure-as-code control over the underlying +network, database, and search resources. + ### CloudFormation You can perform stack update and creation with the AWS Console, AWS CLI, From c3374d0001af5aa19389f6968682a754a1979677 Mon Sep 17 00:00:00 2001 From: "Dr. Ernie Prabhakar" Date: Tue, 3 Mar 2026 08:04:16 -0800 Subject: [PATCH 5/6] docs: improve Installation.md flow and clarity - Add AWS Service Catalog to intro deployment methods list; reorder to match doc structure - Move CloudFormation/Terraform comparison paragraph to just before the CloudFormation section - Clarify CNAMEs step applies to both CloudFormation and Terraform deployments - Replace vague "See above" in Terraform updates with actual commands and a link Co-Authored-By: Claude Sonnet 4.6 --- docs/Catalog/Installation.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/Catalog/Installation.md b/docs/Catalog/Installation.md index 88b4de174e9..5c3e541eaea 100644 --- a/docs/Catalog/Installation.md +++ b/docs/Catalog/Installation.md @@ -7,8 +7,8 @@ find, understand, and file discoveries based on data of any size or in any forma A Quilt _instance_ is a private portal that runs in your virtual private cloud (VPC). -Quilt supports multiple deployment methods including CloudFormation, -AWS Marketplace, and Terraform. +Quilt supports multiple deployment methods including AWS Marketplace, +AWS Service Catalog, CloudFormation, and Terraform. ## Help and Advice @@ -248,6 +248,8 @@ see the [Terraform README](https://github.com/quiltdata/iac/blob/main/README.md) ### CNAMEs +This step applies to both CloudFormation and Terraform deployments. + In order for your users to reach the Quilt catalog you must set three CNAMEs that point to the `LoadBalancerDNSName` as shown below and in the Outputs of your stack. @@ -282,7 +284,8 @@ CloudFormation console as follows. ### Terraform updates -> See above. +Run `terraform plan -out=tfplan && terraform apply tfplan` with the updated +module version. See [Terraform](#terraform) for initial setup details. ## Upgrading from network 1.0 to network 2.0 From 4a865cd96ecf15e69d868552370a238c3e419d0c Mon Sep 17 00:00:00 2001 From: "Dr. Ernie Prabhakar" Date: Tue, 3 Mar 2026 08:06:25 -0800 Subject: [PATCH 6/6] docs: remove redundancy and fix misdirects in Installation.md - Remove "Perform the following steps:" before numbered list - Deduplicate Terraform template request; reference earlier section instead - Fix "You can also install" misdirect now that CF/TF paths are introduced earlier Co-Authored-By: Claude Sonnet 4.6 --- docs/Catalog/Installation.md | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/docs/Catalog/Installation.md b/docs/Catalog/Installation.md index 5c3e541eaea..dfc412f3674 100644 --- a/docs/Catalog/Installation.md +++ b/docs/Catalog/Installation.md @@ -129,10 +129,6 @@ Quilt when a new version is released.) ![Products list page](../imgs/products-list.png) -1. Continue to the [CloudFormation](#cloudformation) section. -Note: the following screenshots may differ slightly from what -you see in Service Catalog. - Quilt supports two deployment paths: **CloudFormation** and **Terraform**. In both cases, the Quilt application runs as a CloudFormation stack. With CloudFormation alone, all resources are managed within a single stack. With @@ -193,8 +189,7 @@ You can monitor progress under Events. On completion you will see `CREATE_COMPLE ### Terraform -You can also install Quilt using [Terraform](https://developer.hashicorp.com/terraform), -which enables more granular infrastructure-as-code control. +To install Quilt using [Terraform](https://developer.hashicorp.com/terraform): Terraform users **must** request a compatible CloudFormation template from Quilt: @@ -304,9 +299,8 @@ stack. This is typically useful when upgrading to the 2.0 network. > _Configuration_ refers to the Quilt stack buckets, roles, policies, > and other administrative settings, all of which are stored in RDS. -Perform the following steps: - -1. Contact your Quilt account manager for a template that supports Terraform. +1. Use the Terraform-compatible template obtained in the +[Terraform](#terraform) section. 1. Take a manual snapshot of the current Quilt database instance. For an existing Quilt stack this resource has the logical ID "DB". Note the snapshot identifier