Skip to content

feat: updated diagram and variable desc#305

Merged
ocofaigh merged 9 commits intomainfrom
da-diag
Apr 8, 2025
Merged

feat: updated diagram and variable desc#305
ocofaigh merged 9 commits intomainfrom
da-diag

Conversation

@Ak-sky
Copy link
Member

@Ak-sky Ak-sky commented Apr 2, 2025

Description

  • Updated ref. diagram and CBR related changes.
  • Updated the order for the CBR variable.
    Git Issue

Release required?

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

Drop down added for cbr_enforcement_mode, containing the values to enabled, disabled, or report for CBR rule.

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.

@Ak-sky
Copy link
Member Author

Ak-sky commented Apr 3, 2025

/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.

The ibm_catalog.json should have CBR mentioned in its feature list

MatthewLemmond
MatthewLemmond previously approved these changes Apr 4, 2025
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.

see comments

variable "cbr_enforcement_mode" {
type = string
description = "Enforcement mode of the CBR rules, valid values are `enabled`, `disabled`, or `report`. Default is report."
description = "Enforcement mode of the CBR rules, valid values are `enabled`, `disabled`, or `report`. When set to `enabled`, be aware that most traffic flow will be blocked. Default is report. [Learn more](https://cloud.ibm.com/docs/account?topic=account-context-restrictions-whatis#rule-enforcement)"
Copy link
Contributor

Choose a reason for hiding this comment

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

this is missing the full stop at the end of the sentence.

I'm not a fan of "be aware that most traffic flow will be blocked". Can we come up with some more descriptive. Or a link that actually explains what traffic is allowed

Copy link
Member Author

Choose a reason for hiding this comment

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

@ocofaigh,

OR

variable "cbr_enforcement_mode" {
  type        = string
  description = "Enforcement mode of the CBR rules. Valid values are `enabled`, `disabled`, or `report`. When set to `enabled`, traffic will be restricted according to [defined rules](https://github.com/terraform-ibm-modules/terraform-ibm-cbr/tree/main/modules/fscloud), allowing only permitted connections while blocking all others. `report` mode monitors CBR rules and logged in Activity Tracker without blocking traffic which is useful for testing. Default is report. [Learn more](https://cloud.ibm.com/docs/account?topic=account-context-restrictions-whatis#rule-enforcement)."
  default     = "report"
}

Please suggest.

@Ak-sky Ak-sky requested a review from ocofaigh April 4, 2025 18:09
@ocofaigh
Copy link
Contributor

ocofaigh commented Apr 8, 2025

/run pipeline

@ocofaigh ocofaigh merged commit 2578d6c into main Apr 8, 2025
2 checks passed
@ocofaigh ocofaigh deleted the da-diag branch April 8, 2025 13:35
@terraform-ibm-modules-ops
Copy link
Contributor

🎉 This PR is included in version 2.0.6 🎉

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.

4 participants