Skip to content

Conversation

@Khuzaima05
Copy link
Member

@Khuzaima05 Khuzaima05 commented Nov 17, 2025

Description

Added VPC Quickstart Deployable Architecture with predefined ACL profiles and optional VPC Flow Logs.

Testing

  • TestQuickstartDefaultConfigSchematics
  • TestQuickstartDefaultConfigUpgradeSchematics

Both confirm VPC creation, subnet provisioning, ACL selection, and flow-log configuration.

issue: https://github.ibm.com/GoldenEye/issues/issues/15496

Release required?

  • No release
  • Patch release (x.x.X)
  • Minor release (x.X.x)
  • Major release (X.x.x)
Release notes content

This PR introduces a new VPC Quickstart DA designed to provide a minimal, beginner-friendly way to provision a Virtual Private Cloud on IBM Cloud. It includes simplified defaults, predefined ACL profiles, and an optional COS-backed VPC Flow Logs configuration.

Run the pipeline

If the CI pipeline doesn't run when you create the PR, the PR requires a user with GitHub collaborators access to run the pipeline.

Run the CI pipeline when the PR is ready for review and you expect tests to pass. Add a comment to the PR with the following text:

/run pipeline

Checklist for reviewers

  • If relevant, a test for the change is included or updated with this PR.
  • If relevant, documentation for the change is included or updated with this PR.

For mergers

  • Use a conventional commit message to set the release level. Follow the guidelines.
  • Include information that users need to know about the PR in the commit message. The commit message becomes part of the GitHub release notes.
  • Use the Squash and merge option.

@Khuzaima05 Khuzaima05 self-assigned this Nov 23, 2025
@Khuzaima05 Khuzaima05 changed the title [WIP] added vpc quickstart DA Added VPC Quickstart DA with predefined ACL profiles and optional VPC Flow Logs Nov 23, 2025
@Khuzaima05 Khuzaima05 marked this pull request as ready for review November 23, 2025 15:24
@Khuzaima05
Copy link
Member Author

/run pipeline

@Khuzaima05
Copy link
Member Author

Khuzaima05 commented Nov 23, 2025

Updated the PR as per deep dive discussion :

  • One subnet per zone (3 zones)
  • Predefined ACL profiles (open/common/ibm-internal/closed)
Profile Traffic Allowed
open Everything open — all inbound and outbound allowed.
common Common ports open… SSH (22), HTTP (80), HTTPS (443)
ibm-internal Only IBM internal traffic and platform connectivity, no user traffic
closed Completely restricted
  • Optional Flow Logs with COS
  • Minimal variables and no add-ons
  • Tests for create + upgrade included
  • Catalog definition updated

@Khuzaima05
Copy link
Member Author

Options for quickstart variation:

Screenshot 2025-11-23 at 9 12 36 PM

@Khuzaima05
Copy link
Member Author

@Khuzaima05
Copy link
Member Author

/run pipeline

1 similar comment
@Khuzaima05
Copy link
Member Author

/run pipeline

Copy link
Contributor

@ocofaigh ocofaigh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please show in todays playback for team feedback. I also left a few comments, but also the following are missing:

  • new variation needs to be added to .catalog-onboard-pipeline.yaml
  • new markdown doc needs to be created in the reference-architectures folder. Once this exists, we will need to update our cloud doc to point to it and mention the new variation

@@ -0,0 +1,3 @@
# Cloud automation for VPC (Quickstart)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The title is wrong - this is no the name of the DA

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done


variable "region" {
type = string
description = "The region to provision all resources in. [Learn more](https://terraform-ibm-modules.github.io/documentation/#/region) about how to select different regions for different services."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That Learn more link is only valid for variations using addons. This is a monolith so no applicable

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

ibm_catalog.json Outdated
"ignore_readme": true
},
{
"label": "QuickStart - Basic and Simple",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"label": "QuickStart - Basic and Simple",
"label": "QuickStart - Basic and simple",

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

ibm_catalog.json Outdated
"description": "The name of an existing resource group to provision the resources."
},
{
"key": "skip_vpc_cos_iam_auth_policy"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hide this

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

{
"key": "network_acls",
"description": "Select a predefined ACL profile for the VPC. Options: open (allow all inbound/outbound), common (allow SSH/HTTP/HTTPS with IBM internal + VPC connectivity), ibm-internal (only IBM internal + VPC connectivity), closed (fully restricted).",
"options": [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these options should be using the rich choice binary widget so more info can be provided in each of the options (instead of in the variable description). Same way we did for the VSI qs

"name": "quickstart",
"index": 2,
"install_type": "fullstack",
"working_directory": "solutions/quickstart",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both variations are missing the short_description. it should start with the text "Ideal for..." and should be used to differentiate between the two variations.

Currently the "Ideal for" text is showing in the feature list. So need to move out of that and into short_description

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants