use parameters_json for provision parameters

[JunliWang]

Description

contribute to: #322
in order to support more complex provision parameters like mirroring.
eg.

parameters_json = jsonencode(
    {
      mirroring = {
        source_crn   = data.ibm_resource_instance.es_instance_source.id
        source_alias = "source-alias"
        target_alias = "target-alias"
        options = {
          topic_name_transform = {
             type = "rename" 
             rename = {
               add_prefix = "add_prefix"
               add_suffix = "add_suffix"
               remove_prefix = "remove_prefix"
               remove_suffix = "remove_suffix"
             }
          }
          group_id_transform = {
            type = "rename" 
            rename = {
              add_prefix = "add_prefix"
              add_suffix = "add_suffix"
              remove_prefix = "remove_prefix"
              remove_suffix = "remove_suffix"
            }
          }
        }
      }
    }
  )

Release required?

this change is not a feature or fix, and it is transparent to users.
and it is a prerequisite for adding mirroring support: #324 which will be a new release.

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

[JunliWang]

/run pipeline

[JunliWang]

/run pipeline

[JunliWang]

/run pipeline

[JunliWang]

/run pipeline

[JunliWang]

/run pipeline

[JunliWang]

/run pipeline

[JunliWang]

/run pipeline

[JunliWang]

/run pipeline

[JunliWang]

I used comment SKIP UPGRADE TEST to skip the upgrade test because standard plan instance does not support update parameters.

[ocofaigh]

@JunliWang I'm not comfortable with the upgrade test being skipped. It is there for a reason and that is to ensure there are no breaking changes being introduced. For example what will happen to an instance that a user already has when they upgrade to the module version with the proposed changes in this PR. Will it try to recreate the instance? Update in place?

Looking at the logs from before you skipped it, I see this:

        	Messages:   	Resource(s) identified to be updated 
        	            	Name: es_instance
        	            	Address: module.event_streams.ibm_resource_instance.es_instance
        	            	Actions: [update]
        	            	DIFF:
        	            	  Before: 
        	            		{"parameters":"SECURE_VALUE_HIDDEN_HASH:-1201b12b20dae655c9c7a45820ef41df2fc9d3e58956f6cad94a19c0"}
        	            	  After: 
        	            		{"parameters":"SECURE_VALUE_HIDDEN_HASH:-a03132ff4a763a07877a448acf19f9c4216d9159cb7cbc05ed016279"}

This would seem to indicate that it is an update. Can you confirm this would be a non disruptive update?

[JunliWang]

I did manual test with provider code, switching from parameters to parameters_json for Enterprise instance will update the instance in-place.
but I do not understand why the test in this module tests updating parameters for Standard instance, which does not support any provision/update parameters.

[ocofaigh]

/run pipeline

[ocofaigh]

@JunliWang Yea it seems the parameters were being passed regardless of what plan was used. But I guess the service was just ignoring them. Since this update is non disruptive, I approve this PR

[terraform-ibm-modules-ops]

🎉 This PR is included in version 2.7.0 🎉

The release is available on:

• GitHub release
• v2.7.0

Your semantic-release bot 📦🚀