doc: deprecate in-module VPN gateway and introduce site-to-site-vpn module #1041
Conversation
imprateeksh
requested review from
maheshwarishikha and
rajatagarwal-ibm
as code owners
…raform-ibm-landing-zone-vpc into deprecate_refs
|
/run pipeline |
…raform-ibm-landing-zone-vpc into deprecate_refs
|
Marked this as major release as per the comment given in the internal issue i.e. getting the new major version released with a migration guide. |
|
Before migrating state - Recreation of resource can be seen 
After Migration : Resource recreation is not happening 
|
|
|
||
| ## ⚠️ Deprecation Notice | ||
|
|
||
| In the upcoming version, the direct use of `ibm_is_vpn_gateway` resources in the root module will be **deprecated**. |
There was a problem hiding this comment.
what upcoming versions? Lets not get mixed up between "deprecated" and "removed". Deprecated simply means there is an alternative way to deploy, and eventually the feature will be removed. So technically the feature is already deprecated.
also this doc should not be referencing the provider resource, but instead the actual featiure that is being depreciated (aka VPN gateway)
There was a problem hiding this comment.
@ocofaigh - By upcoming version I meant to make use of the next release as some code changes are required. I will connect with you about this point as I have some doubt here.
| module.subnets.ibm_is_vpc_address_prefix.subnet_prefix["gcat-multizone-subnet-c"] | ||
| ``` | ||
|
|
||
| ## Upgrade Guide: Migrating VPN from Landing Zone VPC Module to Standalone Site-to-Site VPN Module |
There was a problem hiding this comment.
The root readme should not contain all this information. There should be a one liner deprecation warning at the top of the readme that point to .docs/migration_guide.md (Also why did you make it a hidden folder (.doc) ?
There was a problem hiding this comment.
Got it and my bad w.r.t hidden folder, I thought we are making use of this docs directory for documentation. I will move it out at the root level. Thank you.
There was a problem hiding this comment.
In the one-liner notice add some
| ############################################################################## | ||
|
|
||
| variable "vpn_gateways" { | ||
| description = "List of VPN gateways to create." |
There was a problem hiding this comment.
I would add [DEPRECATED] to this description and link to the deprecation doc.
| module.subnets.ibm_is_vpc_address_prefix.subnet_prefix["gcat-multizone-subnet-c"] | ||
| ``` | ||
|
|
||
| ## Upgrade Guide: Migrating VPN from Landing Zone VPC Module to Standalone Site-to-Site VPN Module |
There was a problem hiding this comment.
In the one-liner notice add some
| ############################################################################## | ||
| # Create VPN Gateways | ||
| ############################################################################## | ||
| # ⚠️ Provisioning of VPN Gateways will soon be deprecated. |
There was a problem hiding this comment.
Maybe add URL for the migration_guide.md here too.
Description
This PR is to include the documentation about the deprecation of in-module VPN gateway provisioning in the Landing Zone VPC module mentioning about planned removal in upcoming release. The intention is to remove the direct usage of resource in root module and consume site to site VPN module.
Release required?
x.x.X)x.X.x)X.x.x)Release notes content
Resource address changes:
Root‑level
ibm_is_vpn_gatewayresource will be refactored into thevpn_gatewaysmodule. Once this is done, users must migrate state usingterraform state mvcommand to avoid recreation ofibm_is_vpn_gatewayresource.Example:
terraform state mv \ 'module.slz_vpc.ibm_is_vpn_gateway.vpn_gateway["vpg1"]' \ 'module.slz_vpc.module.vpn_gateways["vpg1"].ibm_is_vpn_gateway.vpn_gateway[0]'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:
Checklist for reviewers
For mergers