magic-modules icon indicating copy to clipboard operation
magic-modules copied to clipboard

Remove relay_mode field support

Open siwiutki opened this issue 11 months ago • 15 comments

fixes https://github.com/hashicorp/terraform-provider-google/issues/17997

relay_mode field from AdvancedDatapathObservabilityConfig is superseded by enable_relay field and will be deprecated on the provider side in near future.

This is a breaking change according to TF docs and as such, should be released in the next major release. Deprecation of relay_mode field on TF side has already happened more than a month ago, foreshadowing this change through deprecation message.

This field is part of a provider feature that is still in Public Preview and yet to go GA.

container: remove support for `relay_mode` field in `advanced_datapath_observability_config`, users are expected to use `enable_relay` field instead
Fixes b/325234971

siwiutki avatar Mar 25 '24 12:03 siwiutki

Hello! I am a robot. Tests will require approval from a repository maintainer to run.

@zli82016, a repository maintainer, has been assigned to review your changes. If you have not received review feedback within 2 business days, please leave a comment on this PR asking them to take a look.

You can help make sure that review is quick by doing a self-review and by running impacted tests locally.

github-actions[bot] avatar Mar 25 '24 12:03 github-actions[bot]

/gcbrun

zli82016 avatar Mar 25 '24 15:03 zli82016

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 2 files changed, 7 insertions(+), 166 deletions(-)) google-beta provider: Diff ( 2 files changed, 7 insertions(+), 166 deletions(-))

Breaking Change(s) Detected

The following breaking change(s) were detected within your pull request.

  • Field monitoring_config.advanced_datapath_observability_config.enable_relay changed from optional to required on google_container_cluster - reference
  • Field monitoring_config.advanced_datapath_observability_config.enable_relay default value changed from false to on google_container_cluster - reference
  • Field monitoring_config.advanced_datapath_observability_config.relay_mode within resource google_container_cluster was either removed or renamed - reference

If you believe this detection to be incorrect please raise the concern with your reviewer. If you intend to make this change you will need to wait for a major release window. An override-breaking-change label can be added to allow merging.

modular-magician avatar Mar 25 '24 15:03 modular-magician

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 2 files changed, 7 insertions(+), 166 deletions(-)) google-beta provider: Diff ( 2 files changed, 7 insertions(+), 166 deletions(-))

Breaking Change(s) Detected

The following breaking change(s) were detected within your pull request.

  • Field monitoring_config.advanced_datapath_observability_config.enable_relay changed from optional to required on google_container_cluster - reference
  • Field monitoring_config.advanced_datapath_observability_config.enable_relay default value changed from false to on google_container_cluster - reference
  • Field monitoring_config.advanced_datapath_observability_config.relay_mode within resource google_container_cluster was either removed or renamed - reference

If you believe this detection to be incorrect please raise the concern with your reviewer. If you intend to make this change you will need to wait for a major release window. An override-breaking-change label can be added to allow merging.

modular-magician avatar Mar 25 '24 15:03 modular-magician

Tests analytics

Total tests: 185 Passed tests: 171 Skipped tests: 12 Affected tests: 2

Click here to see the affected service packages
  • container

Action taken

Found 2 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests
TestAccContainerCluster_withMonitoringConfig|TestAccContainerCluster_withMonitoringConfigAdvancedDatapathObservabilityConfig

Get to know how VCR tests work

modular-magician avatar Mar 25 '24 15:03 modular-magician

Tests analytics

Total tests: 185 Passed tests: 171 Skipped tests: 12 Affected tests: 2

Click here to see the affected service packages
  • container

Action taken

Found 2 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests
TestAccContainerCluster_withMonitoringConfig|TestAccContainerCluster_withMonitoringConfigAdvancedDatapathObservabilityConfig

Get to know how VCR tests work

modular-magician avatar Mar 25 '24 15:03 modular-magician

The breaking change should be put in the next major release 6.0. The target date for major release is Aug 2024. It is a little bit earlier to work on release 6.0 now. You can close this PR and then open a new PR later for release 6.0.

zli82016 avatar Mar 25 '24 16:03 zli82016

$\textcolor{green}{\textsf{Tests passed during RECORDING mode:}}$ TestAccContainerCluster_withMonitoringConfig[Debug log] TestAccContainerCluster_withMonitoringConfigAdvancedDatapathObservabilityConfig[Debug log]

$\textcolor{green}{\textsf{No issues found for passed tests after REPLAYING rerun.}}$


$\textcolor{green}{\textsf{All tests passed!}}$ View the build log or the debug log for each test

modular-magician avatar Mar 25 '24 16:03 modular-magician

$\textcolor{green}{\textsf{Tests passed during RECORDING mode:}}$ TestAccContainerCluster_withMonitoringConfig[Debug log] TestAccContainerCluster_withMonitoringConfigAdvancedDatapathObservabilityConfig[Debug log]

$\textcolor{green}{\textsf{No issues found for passed tests after REPLAYING rerun.}}$


$\textcolor{green}{\textsf{All tests passed!}}$ View the build log or the debug log for each test

modular-magician avatar Mar 25 '24 16:03 modular-magician

The change needs to be made for 6.0 release.

zli82016 avatar May 01 '24 17:05 zli82016

We can keep it open and move it to the eventual major release branch when it gets closer to time?

c2thorn avatar May 01 '24 17:05 c2thorn

Created a Github issue https://github.com/hashicorp/terraform-provider-google/issues/17997

zli82016 avatar May 01 '24 18:05 zli82016

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 2 files changed, 7 insertions(+), 166 deletions(-)) google-beta provider: Diff ( 2 files changed, 7 insertions(+), 166 deletions(-))

Breaking Change(s) Detected

The following breaking change(s) were detected within your pull request.

  • Field monitoring_config.advanced_datapath_observability_config.enable_relay changed from optional to required on google_container_cluster - reference
  • Field monitoring_config.advanced_datapath_observability_config.enable_relay default value changed from false to on google_container_cluster - reference
  • Field monitoring_config.advanced_datapath_observability_config.relay_mode within resource google_container_cluster was either removed or renamed - reference

If you believe this detection to be incorrect please raise the concern with your reviewer. If you intend to make this change you will need to wait for a major release window. An override-breaking-change label can be added to allow merging.

modular-magician avatar May 01 '24 18:05 modular-magician

Tests analytics

Total tests: 190 Passed tests: 180 Skipped tests: 10 Affected tests: 0

Click here to see the affected service packages
  • container

$\textcolor{green}{\textsf{All tests passed!}}$ View the build log

modular-magician avatar May 01 '24 18:05 modular-magician

@GoogleCloudPlatform/terraform-team This PR has been waiting for review for 3 weeks. Please take a look! Use the label disable-review-reminders to disable these notifications.

github-actions[bot] avatar May 22 '24 09:05 github-actions[bot]

@siwiutki , the window to contribute to the provider 6.0 release is open now. Feel free to move this PR to https://github.com/GoogleCloudPlatform/magic-modules/commits/FEATURE-BRANCH-major-release-6.0.0/

zli82016 avatar Jul 09 '24 18:07 zli82016

@zli82016 I changed the target branch. Let me know if any more action is required from my side to push this forward.

siwiutki avatar Jul 10 '24 09:07 siwiutki

@siwiutki , thanks for making the change.

After checking the guide to make change in 6.0 release branch, more changes are needed.

  1. Add the deprecation message to relay_mode field in the doc container_cluster.html.markdown in main branch in a separate PR. Example can be found in the guide.
  2. Remove relay_mode field from the doc container_cluster.html.markdown in this PR.
  3. Add the upgrade guide entries to version_6_upgrade.html.markdown in this PR.

zli82016 avatar Jul 10 '24 16:07 zli82016

@siwiutki, this PR is waiting for action from you. Please address any comments or change requests, or re-request review from a core reviewer if no action is required.

Image showing the re-request review button

If no action is taken, this PR will be closed in 28 days.

This notification can be disabled with the disable-automatic-closure label.

github-actions[bot] avatar Jul 25 '24 09:07 github-actions[bot]

  1. Add the deprecation message to relay_mode field in the doc container_cluster.html.markdown in main branch in a separate PR.

Since this requires a separate PR before we can handle this PR, let me mark this as draft for now so that reviewers won't be nagged or sth.

siwiutki avatar Jul 25 '24 10:07 siwiutki

@zli82016 Please let me know if there's anything more than https://github.com/GoogleCloudPlatform/magic-modules/pull/11254 that's required to handle your first requested point.

siwiutki avatar Jul 25 '24 10:07 siwiutki

@zli82016 Please let me know if there's anything more than #11254 that's required to handle your first requested point.

That is it. Thanks for creating the PR #11254, which is merged to the main branch.

zli82016 avatar Jul 25 '24 17:07 zli82016

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 4 files changed, 38 insertions(+), 171 deletions(-)) google-beta provider: Diff ( 4 files changed, 38 insertions(+), 171 deletions(-))

Breaking Change(s) Detected

The following breaking change(s) were detected within your pull request.

  • Field monitoring_config.advanced_datapath_observability_config.enable_relay changed from optional to required on google_container_cluster - reference
  • Field monitoring_config.advanced_datapath_observability_config.enable_relay default value changed from false to on google_container_cluster - reference
  • Field monitoring_config.advanced_datapath_observability_config.relay_mode within resource google_container_cluster was either removed or renamed - reference

If you believe this detection to be incorrect please raise the concern with your reviewer. If you intend to make this change you will need to wait for a major release window. An override-breaking-change label can be added to allow merging.

modular-magician avatar Jul 29 '24 13:07 modular-magician

Tests analytics

Total tests: 198 Passed tests: 187 Skipped tests: 10 Affected tests: 1

Click here to see the affected service packages
  • container

Action taken

Found 1 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests
  • TestAccContainerCluster_withMonitoringConfig

Get to know how VCR tests work

modular-magician avatar Jul 29 '24 13:07 modular-magician

$\textcolor{green}{\textsf{Tests passed during RECORDING mode:}}$ TestAccContainerCluster_withMonitoringConfig[Debug log]

$\textcolor{green}{\textsf{No issues found for passed tests after REPLAYING rerun.}}$


$\textcolor{green}{\textsf{All tests passed!}}$

View the build log or the debug log for each test

modular-magician avatar Jul 29 '24 13:07 modular-magician

@zli82016 This PR has been waiting for review for 3 weekdays. Please take a look! Use the label disable-review-reminders to disable these notifications.

github-actions[bot] avatar Jul 30 '24 09:07 github-actions[bot]

LGTM.

@c2thorn , does merging this PR need to wait for the changes in the main branch merged to 6.0 feature branch first? Thanks.

zli82016 avatar Jul 30 '24 16:07 zli82016

LGTM.

@c2thorn , does merging this PR need to wait for the changes in the main branch merged to 6.0 feature branch first? Thanks.

ideally, yes as it may lead to a merge conflict. Apologies on the delay of the sync, I'll get it started today.

c2thorn avatar Jul 30 '24 17:07 c2thorn

ideally, yes as it may lead to a merge conflict. Apologies on the delay of the sync, I'll get it started today.

Thanks, just want to confirm. Sure, take your time.

zli82016 avatar Jul 30 '24 17:07 zli82016

@GoogleCloudPlatform/terraform-team @zli82016 This PR has been waiting for review for 1 week. Please take a look! Use the label disable-review-reminders to disable these notifications.

github-actions[bot] avatar Aug 01 '24 09:08 github-actions[bot]