From 382925df3d3a34d9ab35d3d82bcba23849b5b4e8 Mon Sep 17 00:00:00 2001 From: Chris Archibald Date: Wed, 6 Nov 2024 00:09:31 +0000 Subject: [PATCH] Sync bitbucket and GitHub --- CHANGELOG.md | 21 +++++----- website/docs/guides/24.11.1_upgrade_guide.md | 41 ++++++++++++++++++++ website/docs/r/connector_gcp.html.markdown | 2 +- 3 files changed, 54 insertions(+), 10 deletions(-) create mode 100644 website/docs/guides/24.11.1_upgrade_guide.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 9c2dd8f..639e62c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,15 @@ +## 24.11.1 +BREAKING CHANGE: +* resource/connector_aws: update `instance_type` default value from `t3.xlarge` to `t3.2xlarge` +* resource/connector_azure: update `virtual_machines_size` default value from `Standard_DS3_v2` to `Standard_D8s_v3` +* resource/connector_gcp: update `machine_type` default value from `n2-standard-4` to `n2-standard-8` + ## 24.11.0 ENHANCEMENTS: -* resource/connector_aws: instance_type default value is set as t3.2xlarge -* resource/connector_azure: virtual_machines_size default value is set as Standard_D8s_v3 -* resource/connector_gcp: machine_type default value is set as n2-standard-8 +* resource/connector_azure: adding `azure_tag` option, now supports tags. + +NEW FEATURES: +* Azure and GCP connectors now support Restricted mode. BUG FIXES: * auth user accesToken: Fix 403 issue with authorizer API token @@ -10,10 +17,6 @@ BUG FIXES: ## 24.5.1 ENHANCEMENTS: * remove duplicated volume documentation page. -* resource/connector_azure: adding `azure_tag` option, now supports tags. - -NEW FEATURES: -* Azure and GCP connectors now support Restricted mode. ## 24.5.0 BUG FIXES: @@ -25,7 +28,7 @@ NEW FEATURES: ## 24.1.0 ENHANCEMENTS: -* resource/cvo_gcp: fix typo on vpc3_firewall_rule_tag_name. +* resource/cvo_gcp: fix typo on `vpc3_firewall_rule_tag_name`. * add logging to API calls. @@ -99,7 +102,7 @@ NEW FEATURES: * resource/volume: add new option`comment`. BUG FIXES: -* resource/connector for GCP: Make service_account_key optional. +* resource/connector for GCP: Make `service_account_key` optional. ## 23.3.3 BUG FIXES: diff --git a/website/docs/guides/24.11.1_upgrade_guide.md b/website/docs/guides/24.11.1_upgrade_guide.md new file mode 100644 index 0000000..beee9a9 --- /dev/null +++ b/website/docs/guides/24.11.1_upgrade_guide.md @@ -0,0 +1,41 @@ +--- +page_title: "Guide to Handling the Default Value Breaking Changes in version 24.11.1" +subcategory: "" +description: |- +--- + +# Guide to Handling Breaking Changes in New Version Upgrades +Upgrading to a new version of a provider can sometimes introduce breaking changes that require updates to your Terraform configuration. This guide will help you navigate these changes and ensure a smooth upgrade process. One common scenario is when the default value of a parameter changes in the new version. In such cases, you should update your resource file with the original value of that parameter to prevent unintended resource recreation. + +## Overview +When upgrading to a new version of a provider, it is essential to review the release notes and documentation to identify any breaking changes. This guide provides a step-by-step approach to handle such changes, with a specific focus on updating parameter default values. + +### Steps to Handle Breaking Changes + +#### Default Value Change +* Check the CHANGELOG.md and identify any breaking changes. +* Identify affected resource +* Retrieve the original parameter values +For parameters with changed default values, retrieve the original values from your Terraform state file. This ensures that the Terraform run will not change the original connector and prevent resource recreation. +* Update the Terraform configuration +Update your Terraform resource files with the original values of the affected parameters. This ensures that the Terraform run will not change the original connector and prevent resource recreation. + +#### Example of the default value change +***The default value of the `instance_type` on the resource `netapp-cloudmanager_connector_aws` is changed*** + +##### Original Terraform Configuration +``` +resource "netapp-cloudmanager_connector_aws" "aws_connector" { + provider = "netapp-cloud-manager" + # other configuration +} +``` +##### Update Terraform Configuration: +``` +resource "netapp-cloudmanager_connector_aws" "aws_connector" { + provider = "netapp-cloud-manager" + instance_type = "t3.xlarge" # Original value from the state file + # other configuration +} +``` + diff --git a/website/docs/r/connector_gcp.html.markdown b/website/docs/r/connector_gcp.html.markdown index fdb6fa1..2934ea1 100644 --- a/website/docs/r/connector_gcp.html.markdown +++ b/website/docs/r/connector_gcp.html.markdown @@ -50,7 +50,7 @@ The following arguments are supported: * `service_account_key` - (Optional) A JSON string for the service account key for GCP authorization purposes. This service account is used to create the Connector in GCP. Conflicts with `service_account_path`. It does not need to be set when using the user application default credential authentication by running the command gcloud auth application-default login. * `subnet_id` - (Optional, non-modifiable) The name of the subnet for the virtual machine. The default value is "Default". Two formats are supported: either or projects//regions//subnetworks/. * `network_project_id` - (Optional, non-modifiable) The project id in GCP associated with the Subnet. If not provided, it’s assumed that the Subnet is within the previously specified project id. -* `machine_type` - (Optional, non-modifiable) The machine_type for the Connector VM. The default value is "n2-standard-4" +* `machine_type` - (Optional, non-modifiable) The machine_type for the Connector VM. The default value is "n2-standard-8" * `firewall_tags` - (Optional, non-modifiable) Indicates whether to add firewall_tags to the connector VM (HTTP and HTTP). The default is "true". If true, "firewall-tag-bvsu", "http-server", "https-server" are set as tags, and they can't be managed using tag options. * `associate_public_ip` - (Optional, non-modifiable) Indicates whether to associate a public IP address to the virtual machine. The default is "true" * `proxy_url` - (Optional, non-modifiable) The proxy URL, if using a proxy to connect to the internet.