diff --git a/README.md b/README.md index dc843a3f..ed38697e 100644 --- a/README.md +++ b/README.md @@ -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. + ### Required IAM access policies + You need the following permissions to run this module. - IAM services diff --git a/main.tf b/main.tf index c9f21c0b..0e239a89 100644 --- a/main.tf +++ b/main.tf @@ -425,6 +425,8 @@ locals { ############################################################################## # Create VPN Gateways ############################################################################## +# ⚠️ Provisioning of VPN Gateways will soon be deprecated. +# Please refer [IBM Cloud site-to-site VPN](https://github.com/terraform-ibm-modules/terraform-ibm-site-to-site-vpn/blob/main/README.md#usage) module. locals { # Convert the vpn_gateway input from list to a map