Skip to content
Open
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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) ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the one-liner notice add some ⚠️ warning symbols, and point it to the readme file in the docs folder.


### 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
Expand Down
2 changes: 2 additions & 0 deletions main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,8 @@ locals {
##############################################################################
# Create VPN Gateways
##############################################################################
# ⚠️ Provisioning of VPN Gateways will soon be deprecated.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add URL for the migration_guide.md here too.

# 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
Expand Down