doc: deprecate in-module VPN gateway and introduce site-to-site-vpn module #1041
+36
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
imprateeksh
requested review from
maheshwarishikha and
rajatagarwal-ibm
as code owners
…raform-ibm-landing-zone-vpc into deprecate_refs
vburckhardt
approved these changes
Sep 3, 2025
|
/run pipeline |
ocofaigh
reviewed
Sep 3, 2025
|
|
||
| ### 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: |
There was a problem hiding this comment.
Where is the deprecation warning ? I don't see anything in our code?
There was a problem hiding this comment.
@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.
We could use a null resource bock to add a echo output with a deprecation warning
ocofaigh
reviewed
Sep 3, 2025
| ### 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. | ||
|
|
There was a problem hiding this comment.
Wont users need to run some state moved commands to migrate? I dont see any mention of that in docs?
There was a problem hiding this comment.
Thanks Conall for the suggestion. I will include this too.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR is to update the documentation about the deprecation of in-module VPN gateway provisioning in the Landing Zone VPC module, with a clear warning and planned removal in upcoming release. The intention is to remove this usage and replace with newly introduced site to site VPN module.
Release required?
x.x.X)x.X.x)X.x.x)Release notes content
Run the pipeline
If the CI pipeline doesn't run when you create the PR, the PR requires a user with GitHub collaborators access to run the pipeline.
Run the CI pipeline when the PR is ready for review and you expect tests to pass. Add a comment to the PR with the following text:
Checklist for reviewers
For mergers