Skip to content

Commit 20f87ed

Browse files
committed
doc: deprecation update
1 parent 270db88 commit 20f87ed

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,41 @@ module.subnets.ibm_is_vpc_address_prefix.subnet_prefix["gcat-multizone-subnet-b"
130130
module.subnets.ibm_is_vpc_address_prefix.subnet_prefix["gcat-multizone-subnet-c"]
131131
```
132132

133+
## ​ Upgrade Guide: Migrating VPN from Landing Zone VPC Module to Standalone Site-to-Site VPN Module
134+
135+
### Overview
136+
137+
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.
138+
139+
> **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.
140+
141+
## Migration Steps
142+
143+
### 1. Retain Legacy Behavior (Deprecated)
144+
145+
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:
146+
147+
```hcl
148+
module "landing_zone_vpc" {
149+
source = "terraform-ibm-modules/landing-zone-vpc/ibm"
150+
version = "X.Y.Z"
151+
152+
# Legacy VPN provisioning logic (Deprecated)
153+
vpn_gateways = ["vpn-gateway1", "vpn-gateway2"]
154+
155+
# ​​ Deprecated: VPN provisioning in this module ⚠️
156+
#
157+
# Note: This functionality will be removed in the upcoming release.
158+
# 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.
159+
}
160+
```
161+
162+
### 2. Add the New Site-to-Site VPN Module
163+
164+
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.
165+
133166
### Required IAM access policies
167+
134168
You need the following permissions to run this module.
135169

136170
- IAM services

main.tf

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -413,6 +413,8 @@ locals {
413413
##############################################################################
414414
# Create VPN Gateways
415415
##############################################################################
416+
# ⚠️ Provisioning of VPN Gatways will soon be deprecated
417+
# 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.
416418

417419
locals {
418420
# Convert the vpn_gateway input from list to a map

0 commit comments

Comments
 (0)