Skip to content

Commit 3691b4d

Browse files
Update Readme to include VPC breaking v9.0.0 change (#637)
* Update Readme to include the breaking v9.0.0 change Updating the readme to indicated that the high_availability flag has been deprecated after v9.0.0 and include fixes on how to resolve the issue. * Updating main.tf and README.md * Formatting
1 parent 7139183 commit 3691b4d

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

vpc/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,19 @@ High Availability mode deploys in each AZ in a region. This is what you should c
1818
**Please Note:** This should not be used in a PBMM Production environment.
1919

2020
Single Zone mode deployes in the first AZ in a region that is found by the availability lookup. This will work for if you want to save money in dev.
21+
2122
![Diagram of the Single Zone architecture](./docs/single\_zone.png)
2223

24+
### Breaking change with v9.0.0
25+
If you upgrade to v9.0.0 or above from a lower version, the `high_availability` flag is deprecated and no longer available. You will need to do the following in order to upgrade to a higher version:
26+
1. Remove the `high_availability` flag
27+
2. Instead add the following to your code:
28+
```
29+
availability_zones = 3
30+
cidrsubnet_newbits = 8
31+
```
32+
3. Run terraform/terragrunt plan. You should have no changes in your infrastucture.
33+
2334
## Requirements
2435

2536
| Name | Version |

vpc/main.tf

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,20 @@
1919
* **Please Note:** This should not be used in a PBMM Production environment.
2020
*
2121
* Single Zone mode deployes in the first AZ in a region that is found by the availability lookup. This will work for if you want to save money in dev.
22+
*
2223
* ![Diagram of the Single Zone architecture](./docs/single_zone.png)
2324
*
25+
*
26+
* ### Breaking change with v9.0.0
27+
* If you upgrade to v9.0.0 or above from a lower version, the `high_availability` flag is deprecated and no longer available. You will need to do the following in order to upgrade to a higher version:
28+
* 1. Remove the `high_availability` flag
29+
* 2. Instead add the following to your code:
30+
* ```
31+
* availability_zones = 3
32+
* cidrsubnet_newbits = 8
33+
* ```
34+
* 3. Run terraform/terragrunt plan. You should have no changes in your infrastucture.
35+
*
2436
*/
2537

2638
resource "aws_vpc" "main" {

0 commit comments

Comments
 (0)