-
Notifications
You must be signed in to change notification settings - Fork 17
doc: deprecate in-module VPN gateway and introduce site-to-site-vpn module #1041
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
20f87ed
ec46e30
b89cd4e
332cc9b
6e10a7a
f0479e8
0151638
336c01f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -130,7 +130,41 @@ module.subnets.ibm_is_vpc_address_prefix.subnet_prefix["gcat-multizone-subnet-b" | |
| 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 | ||
|
|
||
| ### Overview | ||
|
|
||
| The `terraform-ibm-landing-zone-vpc` module previously included built-in VPN provisioning via the `vpn_gateways` variable. That functionality has now been extracted into a dedicated `terraform-ibm-site-to-site-vpn` module for better modularity, flexibility, and maintainability. | ||
|
|
||
| > **Note:** The legacy VPN logic within the IBM Cloud Landing Zone VPC module is **deprecated** and will be removed in an upcoming major release. | ||
|
|
||
| ## Migration Steps | ||
|
|
||
| ### 1. Retain Legacy Behavior (Deprecated) | ||
|
|
||
| If you are still using `vpn_gateways` within the IBM Cloud Landing Zone VPC module, it will continue to work for now. However, you should see a deprecation warning: | ||
|
|
||
| ```hcl | ||
| module "landing_zone_vpc" { | ||
| source = "terraform-ibm-modules/landing-zone-vpc/ibm" | ||
| version = "X.Y.Z" | ||
|
|
||
| # Legacy VPN provisioning logic (Deprecated) | ||
| vpn_gateways = ["vpn-gateway1", "vpn-gateway2"] | ||
|
|
||
| # Deprecated: VPN provisioning in this module ⚠️ | ||
| # | ||
| # Note: This functionality will be removed in the upcoming release. | ||
| # Please migrate to the standalone [terraform-ibm-site-to-site-vpn](https://github.com/terraform-ibm-modules/terraform-ibm-site-to-site-vpn/blob/main) module. | ||
| } | ||
| ``` | ||
|
|
||
| ### 2. Add the New Site-to-Site VPN Module | ||
|
|
||
| Refer [usage](https://github.com/terraform-ibm-modules/terraform-ibm-site-to-site-vpn/blob/main/README.md#usage) section as mentioned in the [terraform-ibm-site-to-site-vpn](https://github.com/terraform-ibm-modules/terraform-ibm-site-to-site-vpn/blob/main) module. | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Wont users need to run some state moved commands to migrate? I dont see any mention of that in docs?
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks Conall for the suggestion. I will include this too. |
||
| ### Required IAM access policies | ||
|
|
||
| You need the following permissions to run this module. | ||
|
|
||
| - IAM services | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where is the deprecation warning ? I don't see anything in our code?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is mentioned here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@imprateeksh But thats just a code comment? It wont show up in any terraform log or anything for consumers. So the wording "you should see a deprecation warning" is not actually true
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could use a null resource bock to add a echo output with a deprecation warning