docs: clarify Terraform/CloudFormation deployment relationship#4747
Open
docs: clarify Terraform/CloudFormation deployment relationship#4747
Conversation
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 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4747 +/- ##
=======================================
Coverage 44.32% 44.32%
=======================================
Files 813 813
Lines 32734 32734
Branches 5722 5722
=======================================
Hits 14509 14509
Misses 16221 16221
Partials 2004 2004
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- 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 <noreply@anthropic.com>
- 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 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
### CloudFormation/### Terraformsplit explaining that both paths use a CloudFormation stack, but Terraform additionally provisions foundational infrastructure (VPC, RDS, OpenSearch) first and wires it in automatically### CloudFormationMotivation
The existing docs implied Terraform was simply a CLI alternative for deploying a CloudFormation stack. In reality, the Terraform path is a two-layer architecture where Terraform owns the infrastructure and CloudFormation owns the application. Non-technical admins had no way to understand why a Terraform-deployed stack shows up in the CloudFormation console, or why they should not update it there directly.
Test plan
## Installation Methodssection as a non-technical admin### CloudFormationand### Terraformare now independent subsections with no cross-references🤖 Generated with Claude Code
Greptile Summary
This PR improves the
Installation.mddocumentation by clarifying the architectural relationship between the CloudFormation and Terraform deployment paths for Quilt. The changes address a common point of confusion for non-technical admins.Key changes:
>prefix.Confidence Score: 5/5
Sequence Diagram
sequenceDiagram participant Admin participant Terraform participant CloudFormation participant AWS as AWS Resources Note over Admin,AWS: CloudFormation Path Admin->>CloudFormation: Deploy Quilt CFN template CloudFormation->>AWS: Provisions VPC, RDS, OpenSearch, App (single stack) AWS-->>Admin: Stack complete (CREATE_COMPLETE) Note over Admin,AWS: Terraform Path Admin->>Terraform: Apply Terraform modules Terraform->>AWS: Provisions VPC, RDS, OpenSearch (foundational infra) Terraform->>CloudFormation: Deploy Quilt CFN template (wired to infra) CloudFormation->>AWS: Provisions App layer (stack visible in console) AWS-->>Admin: Stack complete (CREATE_COMPLETE)Last reviewed commit: e684d00