Skip to content

Conversation

@Khuzaima05
Copy link
Member

@Khuzaima05 Khuzaima05 commented Jul 21, 2025

Description

Changes made: ref

  • Renamed "VSI" to "subnet" for clarity
  • Updated service names: "Key Management" → "Key Management (Key Protect / Existing Hyper Protect Crypto Service)
  • "Object Storage" as "Cloud Object Storage" -> "Object Storage"
  • resource group in dotted box
  • Coloured box for subnet
  • some colour changes

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

Release required?

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

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 Jul 21, 2025
@Khuzaima05
Copy link
Member Author

/run pipeline

@Khuzaima05
Copy link
Member Author

/run pipeline

@Khuzaima05 Khuzaima05 requested review from maheshwarishikha and vburckhardt and removed request for Aashiq-J and toddgiguere July 23, 2025 06:21
Copy link
Member

@maheshwarishikha maheshwarishikha left a comment

Choose a reason for hiding this comment

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

  • Object Storage Storage is a wrong name
  • Subnet boxes (10.10../24 : Subnet) - seems to be small i.e. text inside this looks so compact. Please make boxes lil bigger then it will look better.

One open question - Not sure if Zone, subnet boxes was colored intentionally and we want to continue using that.

@maheshwarishikha
Copy link
Member

Also, please mention about the changes done in the issue clearly. Specially what was the change required as per SF guidelines. It will help us to understand.

@Khuzaima05
Copy link
Member Author

  • Object Storage Storage is a wrong name
  • Subnet boxes (10.10../24 : Subnet) - seems to be small i.e. text inside this looks so compact. Please make boxes lil bigger then it will look better.

One open question - Not sure if Zone, subnet boxes was colored intentionally and we want to continue using that.

Updated the PR as per comment.
Regarding coloured box ref: https://github.ibm.com/ibmcloud/ibm-cloud-stencils/tree/master?tab=readme-ov-file#colors

Examples mentioned in ibm-cloud-stensils:
Screenshot 2025-07-23 at 1 14 52 PM

@Khuzaima05
Copy link
Member Author

Khuzaima05 commented Jul 23, 2025

These are the changes made: ref

  • Renamed "VSI" to "subnet" for clarity
  • Updated service names: "Key Management" → "Key Protect
  • "Object Storage" as "Cloud Object Storage"
  • resource group in dotted box
  • Coloured box for subnet
  • some colour changes

@Khuzaima05
Copy link
Member Author

/run pipeline

@Khuzaima05
Copy link
Member Author

/run pipeline

@Khuzaima05
Copy link
Member Author

/run pipeline

@vburckhardt
Copy link
Member

You're getting only one cluster however in quick start. With 2 nodes. New diagram is showing 2 clusters.

@vburckhardt
Copy link
Member

Also, one of the sticking points is that there is no compute resource in the management VPC. We should explicitly indicate that the empty subnet is intentionally left vacant, allowing the user to deploy their preferred compute—whether VSI or OpenShift—for management purposes, in alignment with the FsCloud topology. Possibly put "Reserved for user-managed compute (per FsCloud topology)"

On the HPCS - do quick start support it? If not, remove HPCS from diagram.

Could we also loop back with Jose Monge to validate the new version. He's driving the stencil initiative and has been historically involved with our group.

@Khuzaima05
Copy link
Member Author

Khuzaima05 commented Aug 10, 2025

@vburckhardt

  • Management VPC: Added a comment inside the subnet stating "Reserved for user-managed compute (per FsCloud topology)" to clarify that it's intentionally left vacant for user-managed VSI or OpenShift deployments.

  • HPCS: In the quick start configuration, hpcs is hardcoded as false, meaning only Key Protect is supported for encryption. I've updated the diagram accordingly to reflect Key Protect only.

  • Cluster in Workload VPC: The configuration defines a single cluster with two worker nodes. The earlier diagram showed two separate clusters, which was misleading. I’ve updated it to show one cluster spanning both zones, with a worker node icon in each subnet. ref

Screenshot 2025-08-11 at 12 10 25 PM

Reviewed the updated diagram with Jose Monge . He confirmed the diagram looks good and suggested a few minor changes, which I’ve incorporated.

@Khuzaima05
Copy link
Member Author

/run pipeline

@vburckhardt
Copy link
Member

I believe it’s acceptable to proceed. Additionally, we should update the diagrams in the other variations (particularly the standard version) to align with the new version of the quick start. Most users prefer to quickly compare variations using the diagrams - could we make sure that this is tracked and prioritized.

@Khuzaima05
Copy link
Member Author

/run pipeline

@maheshwarishikha maheshwarishikha merged commit c9c2a0c into main Aug 11, 2025
2 checks passed
@maheshwarishikha maheshwarishikha deleted the issue_15100 branch August 11, 2025 12:20
@terraform-ibm-modules-ops
Copy link
Contributor

🎉 This PR is included in version 8.4.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants