-
Notifications
You must be signed in to change notification settings - Fork 17
Added VPC Quickstart DA with predefined ACL profiles and optional VPC Flow Logs #1082
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.
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
Open
Khuzaima05
wants to merge
10
commits into
main
Choose a base branch
from
issue_15496
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+843
−1
Open
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
45fbddc
added vpc quickstart DA
6e1016f
init commit
469f0b5
Merge branch 'main' into issue_15496
Khuzaima05 7252064
SKIP UPGRADE TEST: upgrade test failing due to breaking change
eea4579
resolve review comments
24afd60
Merge branch 'main' into issue_15496
Khuzaima05 f3531a4
Updated PR as per discussion
03442a6
resolve conflicts
76df8dd
added readme.md
996d5b6
fix pre-commit
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
147 changes: 147 additions & 0 deletions
147
reference-architectures/deploy-arch-ibm-vpc-quickstart-vpc.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| --- | ||
|
|
||
| copyright: | ||
| years: 2025 | ||
| lastupdated: "2025-12-02" | ||
|
|
||
| keywords: | ||
|
|
||
| subcollection: deployable-reference-architectures | ||
|
|
||
| authors: | ||
| - name: "Khuzaima Shakeel" | ||
|
|
||
| # The release that the reference architecture describes | ||
| version: 1.0.0 | ||
|
|
||
| # Whether the reference architecture is published to Cloud Docs production. | ||
| # When set to false, the file is available only in staging. Default is false. | ||
| production: true | ||
|
|
||
| # Use if the reference architecture has deployable code. | ||
| # Value is the URL to land the user in the IBM Cloud catalog details page | ||
| # for the deployable architecture. | ||
| # See https://test.cloud.ibm.com/docs/get-coding?topic=get-coding-deploy-button | ||
| deployment-url: https://cloud.ibm.com/catalog/architecture/deploy-arch-ibm-slz-vpc-9fc0fa64-27af-4fed-9dce-47b3640ba739-global | ||
|
|
||
| docs: https://cloud.ibm.com/docs/secure-infrastructure-vpc | ||
|
|
||
| image_source: https://github.com/terraform-ibm-modules/terraform-ibm-landing-zone-vpc/blob/main/reference-architectures/deployable-architecture-quickstart-vpc.svg | ||
|
|
||
| related_links: | ||
| - title: "Cloud foundation for VPC (Standard - Integrated setup with configurable services)" | ||
| url: "https://cloud.ibm.com/docs/deployable-reference-architectures?topic=deployable-reference-architectures-vpc-fully-configurable" | ||
| description: "A deployable architecture that provides full control over VPC networking, security, and connectivity components." | ||
| - title: "Cloud foundation for VPC (Standard - Financial Services edition)" | ||
| url: "https://cloud.ibm.com/docs/deployable-reference-architectures?topic=deployable-reference-architectures-vpc-ra" | ||
| description: "A VPC architecture based on IBM Cloud for Financial Services controls." | ||
|
|
||
| use-case: Foundational Infrastructure | ||
| compliance: None | ||
|
|
||
| content-type: reference-architecture | ||
|
|
||
| --- | ||
|
|
||
| {{site.data.keyword.attribute-definition-list}} | ||
|
|
||
| # Cloud foundation for VPC – QuickStart (Basic and simple) | ||
| {: #vpc-quickstart-ra} | ||
| {: toc-content-type="reference-architecture"} | ||
| {: toc-industry="CrossIndustry"} | ||
| {: toc-use-case="Foundational Infrastructure"} | ||
| {: toc-version="1.0.0"} | ||
|
|
||
| The QuickStart variation provides a **simple and beginner-friendly** Virtual Private Cloud (VPC) deployment that requires minimal configuration. It helps users rapidly create a functional network environment on IBM Cloud without needing to define subnets, ACL rules, security groups, or connectivity patterns manually. | ||
| This variation is ideal for users who want a **basic VPC setup**, lightweight networking defaults, and the option to enable VPC Flow Logs. | ||
|
|
||
| Unlike the fully configurable architecture, QuickStart intentionally limits complexity and deploys a clean, minimal network footprint that can be used as a stepping stone toward more advanced architectures. | ||
|
|
||
| --- | ||
|
|
||
| ## Architecture diagram | ||
| {: #ra-vpc-quickstart-architecture} | ||
|
|
||
| {: caption="QuickStart VPC architecture" caption-side="bottom"}{: external download="deployable-architecture-quickstart-vpc.svg"} | ||
|
|
||
| --- | ||
|
|
||
| ## Design requirements | ||
| {: #ra-vpc-quickstart-design-requirements} | ||
|
|
||
| {: caption="Scope of the QuickStart design requirements" caption-side="bottom"} | ||
|
|
||
| --- | ||
|
|
||
| ## Components | ||
| {: #ra-vpc-quickstart-components} | ||
|
|
||
| ### VPC architecture decisions | ||
| {: #ra-vpc-quickstart-components-arch} | ||
|
|
||
| | Requirement | Component | Reasons for choice | Alternative | | ||
| |------------|-----------|--------------------|-------------| | ||
| | *Provide a basic, ready-to-use VPC with minimal inputs* | Predefined VPC | Deploys a VPC quickly without requiring the user to design the network | Use the fully configurable variation for deeper customization | | ||
| | *Create availability-zone redundancy* | Fixed three-zone subnets | One subnet per zone to ensure multi-AZ coverage | Single-zone deployment (not recommended) | | ||
| | *Basic traffic governance* | Network profile selector (open, common, ibm-internal, closed) | Users can choose the desired security posture without written ACL rules | Manually writing custom ACLs | | ||
|
|
||
| {: caption="VPC architecture decisions" caption-side="bottom"} | ||
|
|
||
| --- | ||
|
|
||
| ### Networking and connectivity decisions | ||
| {: #ra-vpc-quickstart-components-connectivity} | ||
|
|
||
| | Requirement | Component | Reason | Alternative | | ||
| |------------|-----------|--------|-------------| | ||
| | *Optional access to the internet* | Public gateways per zone (automatic) | Enabled only for `open` and `common` profiles | No public gateways for locked-down profiles | | ||
| | *Subnet-level traffic control* | Network ACL profiles | Simplifies security without requiring rule definitions | Fully customizable ACLs (in advanced variation) | | ||
| | *Instance-level default security* | Default VPC security group | Automatically cleaned when selecting restrictive profiles (`ibm-internal`, `closed`) | Custom security group rules | | ||
|
|
||
| {: caption="Networking and connectivity decisions" caption-side="bottom"} | ||
|
|
||
| --- | ||
|
|
||
| ### Simplicity and user experience decisions | ||
| {: #ra-vpc-quickstart-components-simplicity} | ||
|
|
||
| | Requirement | Component | Reasons | Alternative | | ||
| |------------|-----------|---------|-------------| | ||
| | *Zero-effort deployment* | Predefined subnets + ACL mapping | Users only pick prefix, region, and profile | Manual subnet planning | | ||
| | *Clear security posture options* | User-friendly “Network Profile” widget | Shows descriptions and recommendations | Plain text input | | ||
| | *Simple observability integration* | Optional VPC Flow Logs → COS | Enabled via toggle | External log collectors | | ||
|
|
||
| {: caption="Simplicity decision points" caption-side="bottom"} | ||
|
|
||
| --- | ||
|
|
||
| ## Key features | ||
| {: #ra-vpc-quickstart-features} | ||
|
|
||
| ### Core VPC Setup | ||
| - Automatically creates a new VPC with IBM-recommended defaults | ||
| - Deploys **one subnet per zone** (three total) | ||
|
|
||
| ### Built-in Network Profiles | ||
| - **Open** – Unrestricted | ||
| - **Standard (Common)** – SSH/HTTP/HTTPS + IBM internal rules | ||
| - **IBM Internal** – No inbound customer traffic | ||
| - **Closed** – Fully restricted | ||
|
|
||
| ### Security & Network Defaults | ||
| - ACLs applied according to selected network profile | ||
| - Security group automatically cleaned for restrictive profiles | ||
| - Public gateways created only when allowed by the profile | ||
|
|
||
| ### Optional Flow Logs | ||
| - Enable VPC Flow Logs to create a COS instance and bucket automatically | ||
|
|
||
|
|
||
| --- | ||
| <!-- | ||
| ## Next steps | ||
| {: #ra-vpc-fully-configurable-next-steps} | ||
|
|
||
| TODO: Decide what next steps to list, if any | ||
|
|
||
| Optional section. Include links to your deployment guide or next steps to get started with the architecture. --> |
4 changes: 4 additions & 0 deletions
4
reference-architectures/deployable-architecture-quickstart-vpc.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # Cloud foundation for VPC (Quickstart) | ||
|
|
||
| :exclamation: **Important:** This solution is not intended to be called by other modules because it contains a provider configuration and is not compatible with the `for_each`, `count`, and `depends_on` arguments. For more information, see [Providers Within Modules](https://developer.hashicorp.com/terraform/language/modules/develop/providers). |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "ibmcloud_api_key": $VALIDATION_APIKEY, | ||
| "region": "us-south", | ||
| "resource_tags": $TAGS, | ||
| "existing_resource_group_name": "geretain-test-resources", | ||
| "prefix": $PREFIX | ||
| } |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.