diff --git a/standard/README.md b/standard/README.md index af139b4..fa4c1aa 100644 --- a/standard/README.md +++ b/standard/README.md @@ -7,17 +7,17 @@ non-FTI Data. This includes Other configurations such as versioning or data safegurad tagging (only on the bucket/keys) are oiptional # Usage -To use the new refactored module with the AWS provider v4.x, use `?ref=3`, otherwise leave this part off. -If you are converting an older version of the module to the new AWS provider with `?ref=3, please follow +To use the new refactored module with the AWS provider v4.x, use `?ref=tf-upgrade` (formerly `?ref=3`), otherwise leave this part off. +If you are converting an older version of the module to the new AWS provider with `?ref=tf-upgrade`, please follow the [updating directions](updating-buckets.md). **Note**: version 2 and version 3 of this module cannot coexist in a directory. All S3 buckets using this module -must use the same version. If you are using the version 2 of the module (without the `?ref=3`), you must +must use the same version. If you are using the version 2 of the module (without the `?ref=tf-upgrade`), you must also include a `versions.tf` which pins the AWS provider at < 4.0. If using version 3 of the module, do not include a `versions.tf`, do not pin the AWS provider. Two different versions of the provider cannot coexist (easily). -````hcl +```hcl module "my-bucket" { source = "git@github.e.it.census.gov:terraform-modules/aws-s3.git//standard?ref=3" diff --git a/standard/main.tf b/standard/main.tf index 703c4e1..3bcb382 100644 --- a/standard/main.tf +++ b/standard/main.tf @@ -8,12 +8,12 @@ * Other configurations such as versioning or data safegurad tagging (only on the bucket/keys) are oiptional * * # Usage -* To use the new refactored module with the AWS provider v4.x, use `?ref=3`, otherwise leave this part off. -* If you are converting an older version of the module to the new AWS provider with `?ref=3, please follow +* To use the new refactored module with the AWS provider v4.x, use `?ref=tf-upgrade` (formerly `?ref=3`), otherwise leave this part off. +* If you are converting an older version of the module to the new AWS provider with `?ref=tf-upgrade`, please follow * the [updating directions](updating-buckets.md). * * **Note**: version 2 and version 3 of this module cannot coexist in a directory. All S3 buckets using this module -* must use the same version. If you are using the version 2 of the module (without the `?ref=3`), you must +* must use the same version. If you are using the version 2 of the module (without the `?ref=tf-upgrade`), you must * also include a `versions.tf` which pins the AWS provider at < 4.0. If using version 3 of the module, * do not include a `versions.tf`, do not pin the AWS provider. Two different versions of the provider cannot * coexist (easily). diff --git a/title26/README.md b/title26/README.md index 4598954..04f3083 100644 --- a/title26/README.md +++ b/title26/README.md @@ -7,17 +7,17 @@ FTI (Title26). This includes - Server Access Logging # Usage -To use the new refactored module with the AWS provider v4.x, use `?ref=3`, otherwise leave this part off. -If you are converting an older version of the module to the new AWS provider with `?ref=3, please follow +To use the new refactored module with the AWS provider v4.x, use `?ref=tf-upgrade` (formerly `?ref=tf-3`), otherwise leave this part off. +If you are converting an older version of the module to the new AWS provider with `?ref=tf-upgrade`, please follow the [updating directions](updating-buckets.md). **Note**: version 2 and version 3 of this module cannot coexist in a directory. All S3 buckets using this module -must use the same version. If you are using the version 2 of the module (without the `?ref=3`), you must +must use the same version. If you are using the version 2 of the module (without the `?ref=tf-upgrade`), you must also include a `versions.tf` which pins the AWS provider at < 4.0. If using version 3 of the module, do not include a `versions.tf`, do not pin the AWS provider. Two different versions of the provider cannot coexist (easily). -````hcl +```hcl module "mybucket" { source = "git@github.e.it.census.gov:terraform-modules/aws-s3.git//title26?ref=3" diff --git a/title26/main.tf b/title26/main.tf index 034a1f5..f1415af 100644 --- a/title26/main.tf +++ b/title26/main.tf @@ -8,12 +8,12 @@ * - Server Access Logging * * # Usage -* To use the new refactored module with the AWS provider v4.x, use `?ref=3`, otherwise leave this part off. -* If you are converting an older version of the module to the new AWS provider with `?ref=3, please follow +* To use the new refactored module with the AWS provider v4.x, use `?ref=tf-upgrade` (formerly `?ref=tf-3`), otherwise leave this part off. +* If you are converting an older version of the module to the new AWS provider with `?ref=tf-upgrade`, please follow * the [updating directions](updating-buckets.md). * * **Note**: version 2 and version 3 of this module cannot coexist in a directory. All S3 buckets using this module -* must use the same version. If you are using the version 2 of the module (without the `?ref=3`), you must +* must use the same version. If you are using the version 2 of the module (without the `?ref=tf-upgrade`), you must * also include a `versions.tf` which pins the AWS provider at < 4.0. If using version 3 of the module, * do not include a `versions.tf`, do not pin the AWS provider. Two different versions of the provider cannot * coexist (easily).