feat: added support for creating resource key with private endpoints

[Khuzaima05]

This PR adds support for creating Event Streams resource key scoped to private endpoints.

Previously, the module only created service credentials for public endpoints by default. Event Streams supports generating credentials for both public and private endpoints, and this functionality is enabled in Terraform by passing the parameters block to the ibm_resource_key resource.

Reference: Terraform IBM Provider – resource_key parameters

Changes:

• Updated the ibm_resource_key resource to allow passing the parameters argument so that service credentials can be created for private endpoints (e.g., {"service-endpoints" = "private"}).

• Updated the fs-cloud example to demonstrate creating Event Streams service credentials with private endpoints.

issue: #444

Release required?

• No release
• Patch release (x.x.X)
• Minor release (x.X.x)
• Major release (X.x.x)

Release notes content

• Added support for creating Event Streams resource key scoped to private endpoints. Updated the fs-cloud example to demonstrate this functionality.

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]

/run pipeline

[Khuzaima05]

Tested the TestFSCloudInSchematics test locally as it is added in other_test.go . Its passing successfully

[Ak-sky]

This also needs to be exposed to the DAs.

[Khuzaima05]

/run pipeline

[Ak-sky]

@Khuzaima05, did you the test the scenario with "public-and-private" endpoint as per this comment?

[Khuzaima05]

@Khuzaima05, did you the test the scenario with "public-and-private" endpoint as per this comment?

yes, I have tested the scenario for private-and-public service endpoints , Its successfully deploying for both private as well as public service credentials endpoints.

[Khuzaima05]

/run pipeline

[Ak-sky]

/run pipeline

[Khuzaima05]

/run pipeline

[Khuzaima05]

/run pipeline

[ocofaigh]

see comments

[ocofaigh]

@Khuzaima05 Something else I noticed is that we seem to have alot of duplication in the DA markdown docs. For inputs that are the same in both variations, don't duplicate the docs. Just have both variations pointing to the one doc. And if its easier to maintain and read, I would split it 1 doc per input type to avoid any confusion with inputs that might be in 1 variations and not in another

[Khuzaima05]

@Khuzaima05 Something else I noticed is that we seem to have alot of duplication in the DA markdown docs. For inputs that are the same in both variations, don't duplicate the docs. Just have both variations pointing to the one doc. And if its easier to maintain and read, I would split it 1 doc per input type to avoid any confusion with inputs that might be in 1 variations and not in another

@ocofaigh Yes, all complex variables in the quickstart are already documented in the DA_docs for the security_enforced version. Therefore, I’ve removed the DA_docs from the quickstart and updated the variable references accordingly.

[Khuzaima05]

/run pipeline

[Khuzaima05]

/run pipeline

[ocofaigh]

see latest comments

[Khuzaima05]

/run pipeline

[ocofaigh]

@Khuzaima05 See https://github.com/terraform-ibm-modules/terraform-ibm-event-streams/pull/472/files#r2522985789

[ocofaigh]

still not right #472 (comment)

[ocofaigh]

/run pipeline

[ocofaigh]

Addons test failed (Wesley is working on a workaround for this intermittent issue):

[TestEventStreamsDefaultConfiguration] Errors occurred during infrastructure deployment
[TestEventStreamsDefaultConfiguration] Note: IBM Cloud Projects workflow requires successful validation (terraform plan) before deployment (terraform apply)
[TestEventStreamsDefaultConfiguration] If validation failed, infrastructure was never deployed - only configurations were added to project
[TestEventStreamsDefaultConfiguration]   Schematics job logs for member: deploy-arch-ibm-activity-tracker-y28jkf, Schematics Workspace CRN: crn:v1:bluemix:public:schematics:us-south:a/abac0df06b644a9cabc6e44f55b3880e:678a3495-26a0-49cd-b858-2305016e1400:workspace:us-east.workspace.projects-service.362bbc98, Schematics Validate Job ID: c43c572601fce6f8046ffe54a7987e7f
Schematics workspace URL: https://cloud.ibm.com/schematics/workspaces/us-east.workspace.projects-service.362bbc98/jobs?region=us
Schematics Job URL: https://cloud.ibm.com/schematics/workspaces/us-east.workspace.projects-service.362bbc98/log/c43c572601fce6f8046ffe54a7987e7f
	(deploy-arch-ibm-activity-tracker-y28jkf) Validation result: failed
	(deploy-arch-ibm-activity-tracker-y28jkf) Note: Validation = terraform plan. Infrastructure deployment (terraform apply) cannot proceed without successful validation.

Going to retry..

[ocofaigh]

/run pipeline

[Khuzaima05]

The add-on test is failing again with the same intermittent error. I’m giving it another retry.

[Khuzaima05]

/run pipeline

addressed

[terraform-ibm-modules-ops]

🎉 This PR is included in version 4.6.0 🎉

The release is available on:

• GitHub release
• v4.6.0

Your semantic-release bot 📦🚀