Skip to content
This repository has been archived by the owner on Dec 17, 2024. It is now read-only.

fix: update architecture diagrams and reorder DAs deployment #26

Merged
merged 5 commits into from
Aug 23, 2024

Conversation

akocbek
Copy link

@akocbek akocbek commented Aug 20, 2024

Description

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.

@akocbek
Copy link
Author

akocbek commented Aug 20, 2024

/run pipeline

@akocbek akocbek requested review from in-1911 and removed request for daniel-butler-irl and ocofaigh August 20, 2024 15:41
@toddgiguere
Copy link

/run pipeline

Copy link

@in-1911 in-1911 left a comment

Choose a reason for hiding this comment

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

A couple of suggestions on the order change and a point about using numbers in DA names in general.

@@ -383,7 +309,7 @@
},
{
"name": "existing_kms_instance_crn",
"value": "ref:../../members/2a - Security Service - Key Management/outputs/kms_instance_crn"
"value": "ref:../../members/2 - Security Service - Key Management/outputs/kms_instance_crn"
Copy link

Choose a reason for hiding this comment

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

I think this should follow the ref scheme we used in other places - i.e. ref:../2 - Security Service - Key Management/outputs/kms_instance_crn

"3a - Observability - Logging Monitoring Activity Tracker",
"3b - Databases for Elasticsearch",
"4 - Event Notifications",
"5a - Security Service - Secret Manager",
"5b - Security Service - Security Compliance Center",
"6 - Sample RAG app - Application Lifecycle Management",
"7 - Sample RAG app configuration"
"6 - WatsonX SaaS services",
Copy link

Choose a reason for hiding this comment

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

Logically the Elastic DA should be next to Watson (probably right before that). As is, Elastic sits in the middle of the Security / Observability DAs.

From the same perspective, may be we should put the Security Service DAs together, even though some of them are dependent on Event Notififcations and will not be deployed in that exact order.

Overall, I am starting to think that we might consider dropping the numbering from the member DA names - otherwise we get massive changes every time we change the order or add something in the middle. May be we should hold a vote on that.

Copy link

Choose a reason for hiding this comment

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

@toddgiguere
Copy link

@in-1911 should we wait for the new secrets manger and event notify DA versions and include those in this PR, along with above changes?

@in-1911
Copy link

in-1911 commented Aug 21, 2024

@in-1911 should we wait for the new secrets manger and event notify DA versions and include those in this PR, along with above changes?

I would wait at least until terraform-ibm-modules/terraform-ibm-secrets-manager#178 is merged and a new release is published to the catalog.
The other one (event notifications) is less critical.

@ajainghub
Copy link

As discussed here is the new suggested naming and sequence:

  • Account Infrastructure Base
  • Baseline Security - Encryption Key Management
  • Baseline Security - Logging Monitoring Activity Tracker
  • Baseline Security - Observability Event Notifications
  • Baseline Security - Secrets Manager
  • Baseline Security - Security Compliance Center
  • Gen AI - Databases for Elasticsearch
  • Gen AI - WatsonX SaaS services
  • Workload - Application Lifecycle Management
  • Workload - CodeEngine
  • Workload - ROKS
  • Workload - Sample RAG App Configuration

@toddgiguere
Copy link

/run pipeline

@toddgiguere
Copy link

/run pipeline

@toddgiguere toddgiguere merged commit ef8db74 into main Aug 23, 2024
2 checks passed
@toddgiguere toddgiguere deleted the small_fix branch August 23, 2024 14:30
@terraform-ibm-modules-ops

🎉 This issue has been resolved in version 0.3.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

akocbek added a commit that referenced this pull request Aug 29, 2024
…> - updated architecture diagrams<br> - new naming scheme for stack steps, removed numbering in names<br> - changed order of some steps<br> - updated secrets manager DA to latest

* fix: update architecture diagrams

* fix: remove extra region param in kms

* fix(deps): update to latest version of secret manager

* refactor: rename and reorder stack members

---------

Co-authored-by: akocbek@ie.ibm.com <akocbek@ie.ibm.com>
Co-authored-by: Todd Giguere <todd.giguere@ibm.com>
akocbek added a commit that referenced this pull request Sep 2, 2024
…> - updated architecture diagrams<br> - new naming scheme for stack steps, removed numbering in names<br> - changed order of some steps<br> - updated secrets manager DA to latest

* fix: update architecture diagrams

* fix: remove extra region param in kms

* fix(deps): update to latest version of secret manager

* refactor: rename and reorder stack members

---------

Co-authored-by: akocbek@ie.ibm.com <akocbek@ie.ibm.com>
Co-authored-by: Todd Giguere <todd.giguere@ibm.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants