Update pinning in readme and examples

rackspace-infrastructure-automation · Dec 18, 2019 · b39d125 · b39d125
1 parent 15acd0b
commit b39d125
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ This module sets up basic network components for an account in a specific region
 
 ```
 module "vpc" {
- source = "[email protected]:rackspace-infrastructure-automation/aws-terraform-vpc_basenetwork//?ref=v0.0.10"
+ source = "[email protected]:rackspace-infrastructure-automation/aws-terraform-vpc_basenetwork//?ref=v0.12.0"
 
  vpc_name = "MyVPC"
 }
@@ -24,6 +24,18 @@ By default only `vpc_name` is required to be set. Unless changed `aws_region` de
 - EIPs will be created in all public subnets for NAT gateways to use
 - Route Tables, including routes to NAT gateways if applicable
 
+## Terraform 0.12 upgrade
+
+Several changes were required while adding terraform 0.12 compatibility.  The following changes should 
+made when upgrading from a previous release to version 0.12.0 or higher.
+
+### Module variables
+
+The following module variables were updated to better meet current Rackspace style guides:
+
+- `custom_tags` -> `tags`
+- `vpc_name` -> `name`
+
 ## Inputs
 
 | Name | Description | Type | Default | Required |

diff --git a/examples/basic_usage.tf b/examples/basic_usage.tf
@@ -8,7 +8,7 @@ provider "aws" {
 }
 
 module "vpc" {
-  source = "[email protected]:rackspace-infrastructure-automation/aws-terraform-vpc_basenetwork//?ref=v0.0.10"
+  source = "[email protected]:rackspace-infrastructure-automation/aws-terraform-vpc_basenetwork//?ref=v0.12.0"
 
   name = "MyVPC"
 }
diff --git a/examples/custom_azs.tf b/examples/custom_azs.tf
@@ -8,7 +8,7 @@ provider "aws" {
 }
 
 module "vpc" {
-  source = "[email protected]:rackspace-infrastructure-automation/aws-terraform-vpc_basenetwork//?ref=v0.0.10"
+  source = "[email protected]:rackspace-infrastructure-automation/aws-terraform-vpc_basenetwork//?ref=v0.12.0"
 
   name   = "MyVPC"
   custom_azs = ["us-west-2a", "us-west-2b"]

diff --git a/examples/vpn_provided.tf b/examples/vpn_provided.tf
@@ -8,7 +8,7 @@ provider "aws" {
 }
 
 module "vpc" {
-  source = "[email protected]:rackspace-infrastructure-automation/aws-terraform-vpc_basenetwork//?ref=v0.0.10"
+  source = "[email protected]:rackspace-infrastructure-automation/aws-terraform-vpc_basenetwork//?ref=v0.12.0"
 
   name  = "MyVPC"
   build_vpn = true

diff --git a/main.tf b/main.tf
@@ -7,7 +7,7 @@
  *
  *```
  *module "vpc" {
- *  source = "[email protected]:rackspace-infrastructure-automation/aws-terraform-vpc_basenetwork//?ref=v0.0.10"
+ *  source = "[email protected]:rackspace-infrastructure-automation/aws-terraform-vpc_basenetwork//?ref=v0.12.0"
  *
  *  vpc_name = "MyVPC"
  *}
@@ -24,7 +24,19 @@
  * - NAT Gateways will be created in each AZ's first public subnet
  * - EIPs will be created in all public subnets for NAT gateways to use
  * - Route Tables, including routes to NAT gateways if applicable
-*/
+ *
+ *## Terraform 0.12 upgrade
+ *
+ *Several changes were required while adding terraform 0.12 compatibility.  The following changes should be
+ *made when upgrading from a previous release to version 0.12.0 or higher.
+ *
+ *### Module variables
+ *
+ *The following module variables were updated to better meet current Rackspace style guides:
+ *
+ *- `custom_tags` -> `tags`
+ *- `vpc_name` -> `name`
+ */
 
 terraform {
   required_version = ">= 0.12"