From 20f87edfd853efe007ef48d9462ff3f7d9313c05 Mon Sep 17 00:00:00 2001 From: Prateek-Sharma13 Date: Mon, 18 Aug 2025 13:00:22 +0530 Subject: [PATCH 1/2] doc: deprecation update --- README.md | 34 ++++++++++++++++++++++++++++++++++ main.tf | 2 ++ 2 files changed, 36 insertions(+) diff --git a/README.md b/README.md index 69463978..82134bab 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 Landing Zone VPC module is still available *for now*, but it is officially **deprecated** and will be removed in an upcoming major release. + +## Migration Steps + +### 1. Retain Legacy Behavior (Deprecated) + +If you're still using `vpn_gateways` within the 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 b48a4911..8dc4210a 100644 --- a/main.tf +++ b/main.tf @@ -413,6 +413,8 @@ locals { ############################################################################## # Create VPN Gateways ############################################################################## +# ⚠️ Provisioning of VPN Gatways 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 From 6e10a7a1dc6953cbea12ae97e9b33534253c8656 Mon Sep 17 00:00:00 2001 From: Prateek-Sharma13 Date: Wed, 3 Sep 2025 17:06:58 +0530 Subject: [PATCH 2/2] doc: fixed typos --- README.md | 4 ++-- main.tf | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 64f29356..4ce040c7 100644 --- a/README.md +++ b/README.md @@ -136,13 +136,13 @@ module.subnets.ibm_is_vpc_address_prefix.subnet_prefix["gcat-multizone-subnet-c" 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 Landing Zone VPC module is still available *for now*, but it is officially **deprecated** and will be removed in an upcoming major release. +> **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're still using `vpn_gateways` within the Landing Zone VPC module, it will continue to work—for now. However, you should see a deprecation warning: +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" { diff --git a/main.tf b/main.tf index 8dc4210a..4ce683e4 100644 --- a/main.tf +++ b/main.tf @@ -413,7 +413,7 @@ locals { ############################################################################## # Create VPN Gateways ############################################################################## -# ⚠️ Provisioning of VPN Gatways will soon be deprecated +# ⚠️ 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 {