-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat!: Update to support AWS provider v3.75 and newer (including v4.x) (
#139) BREAKING CHANGES: - Yes, see file `UPGRADE-3.0.md` - Requires AWS provider v3.75 or newer (including v4.x)
- Loading branch information
1 parent
5d0ed51
commit e0de434
Showing
35 changed files
with
1,155 additions
and
338 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| # Upgrade from v2.x to v3.x | ||
|
|
||
| If you have any questions regarding this upgrade process, please consult the [`examples/`](https://github.com/terraform-aws-modules/terraform-aws-s3-bucket/tree/master/examples) projects: | ||
|
|
||
| If you find a bug, please open an issue with supporting configuration to reproduce. | ||
|
|
||
| ## List of backwards incompatible changes | ||
|
|
||
| - Terraform AWS provider minimum version is now `v3.75.0` in order to have forward compatibility with Terraform AWS provider `v4.x`. Using the latest version of `v4` is highly recommended, if possible. | ||
| - Main group of changes is related to refactoring of `aws_s3_bucket` resource into several smaller resources. Read [`S3 bucket refactor` section in the official Terraform AWS Provider Version 4 Upgrade Guide](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/guides/version-4-upgrade#s3-bucket-refactor) and [discussion around these changes](https://github.com/hashicorp/terraform-provider-aws/issues/23106) can help even when using AWS provider version 3.75 or newer. | ||
| - `modules/object`: Changed resource type from `aws_bucket_s3_object` to `aws_s3_object`. After upgrade, on the next apply, Terraform will recreate the object. If you prefer to not have Terraform recreate the object, import the object using `aws_s3_object`. [Read more](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_object#import). | ||
|
|
||
| ## Additional changes | ||
|
|
||
| ### Added | ||
|
|
||
| - None | ||
|
|
||
| ### Modified | ||
|
|
||
| - `acl` variable is set to `null` by default | ||
| - In addition to pseudo-boolean values like "Enabled", "Disabled", "Suspended", it is now possible to specify `true` or `false` in all such arguments (e.g. `versioning = { enabled = true }`). | ||
|
|
||
| ### Variable and output changes | ||
|
|
||
| 1. Removed variables: | ||
|
|
||
| - None | ||
|
|
||
| 2. Renamed variables: | ||
|
|
||
| - None | ||
|
|
||
| 3. Added variables: | ||
|
|
||
| - `owner` | ||
| - `expected_bucket_owner` | ||
|
|
||
| 4. Removed outputs: | ||
|
|
||
| - None | ||
|
|
||
| 5. Renamed outputs: | ||
|
|
||
| `modules/object`: | ||
|
|
||
| - `s3_bucket_object_id` -> `s3_object_id` | ||
| - `s3_bucket_object_etag` -> `s3_object_etag` | ||
| - `s3_bucket_object_version_id` -> `s3_object_version_id` | ||
|
|
||
| 6. Added outputs: | ||
|
|
||
| - None | ||
|
|
||
| ## Upgrade Migrations | ||
|
|
||
| The following examples demonstrate some of the changes that users can elect to make to avoid any potential disruptions when upgrading. | ||
|
|
||
| ### Before 2.x Example | ||
|
|
||
| See code in [`examples/complete-legacy`](https://github.com/terraform-aws-modules/terraform-aws-s3-bucket/tree/master/examples/complete-legacy). | ||
|
|
||
| ```hcl | ||
| module "s3_bucket" { | ||
| source = "terraform-aws-modules/s3-bucket/aws" | ||
| version = "~> 2.0" | ||
| bucket = "my-awesome-bucket" | ||
| acl = "log-delivery-write" | ||
| } | ||
| terraform { | ||
| required_providers { | ||
| aws = "~> 3.69.0" # or anything lower than 3.75.0 | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### After 3.x Example | ||
|
|
||
| See code in [`examples/complete`](https://github.com/terraform-aws-modules/terraform-aws-s3-bucket/tree/master/examples/complete). | ||
|
|
||
| ```hcl | ||
| module "s3_bucket" { | ||
| source = "terraform-aws-modules/s3-bucket/aws" | ||
| version = "~> 3.0" | ||
| bucket = "my-awesome-bucket" | ||
| acl = "log-delivery-write" | ||
| } | ||
| terraform { | ||
| required_providers { | ||
| aws = ">= 3.75" # or anything higher than 3.75.0 | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| After the code is updated, you need run `terraform init -upgrade` to download newer AWS provider, and then import S3 bucket ACL using such command: | ||
|
|
||
| ``` | ||
| terraform import "module.s3_bucket.aws_s3_bucket_acl.this[0]" my-awesome-bucket,log-delivery-write | ||
| ``` | ||
|
|
||
| Where `log-delivery-write` is the value of `acl` argument in the module block above. | ||
|
|
||
| Read more about [import in the official documentation for `aws_s3_bucket_acl`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_acl#import). | ||
|
|
||
| #### Import existing resources (required during the migration from v2.x of this module) | ||
|
|
||
| During the migration to v3.x of this module, several S3 resources will be created by this module. In order to guarantee the best experience and prevent data loss, you will need to import them into terraform state using commands like these: | ||
|
|
||
| ```bash | ||
| terraform import "module.s3_bucket.aws_s3_bucket.this[0]" <bucket-name> | ||
| terraform import "module.s3_bucket.aws_s3_bucket_acl.this[0]" <bucket-name>,<acl> | ||
| terraform import "module.s3_bucket.aws_s3_bucket_logging.this[0]" <bucket-name> | ||
| terraform import "module.s3_bucket.aws_s3_bucket_website_configuration.this[0]" <bucket-name>,<account-id> | ||
| terraform import "module.s3_bucket.aws_s3_bucket_versioning.this[0]" <bucket-name>,<account-id> | ||
| terraform import "module.s3_bucket.aws_s3_bucket_server_side_encryption_configuration.this[0]" <bucket-name>,<account-id> | ||
| terraform import "module.s3_bucket.aws_s3_bucket_request_payment_configuration.this[0]" <bucket-name>,<account-id> | ||
| terraform import "module.s3_bucket.aws_s3_bucket_accelerate_configuration.this[0]" <bucket-name>,<account-id> | ||
| terraform import "module.s3_bucket.aws_s3_bucket_policy.this[0]" <bucket-name> | ||
| terraform import "module.s3_bucket.aws_s3_bucket_ownership_controls.this[0]" <bucket-name> | ||
| terraform import "module.s3_bucket.aws_s3_bucket_cors_configuration.this[0]" <bucket-name>,<account-id> | ||
| terraform import "module.s3_bucket.aws_s3_bucket_object_lock_configuration.this[0]" <bucket-name>,<account-id> | ||
| terraform import "module.s3_bucket.aws_s3_bucket_public_access_block.this[0]" <bucket-name> | ||
| terraform import "module.s3_bucket.aws_s3_bucket_lifecycle_configuration.this[0]" <bucket-name>,<account-id> | ||
| terraform import "module.s3_bucket.aws_s3_bucket_replication_configuration.this[0]" <bucket-name> | ||
| ``` | ||
|
|
||
| Where `s3_bucket` is the name of your module definition, `bucket-name` is the name of the bucket, `acl` is the bucket ACL (e.g. `private`, `log-delivery-write`, etc), `<account-id>` is your AWS account number (required only if `expected_bucket_owner` is set in the code). |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| # Legacy - Complete S3 bucket with most of supported features enabled | ||
|
|
||
| Configuration in this directory creates S3 bucket using previous (2.x) version of this module to test upgrade process. | ||
|
|
||
| This configuration is similar to the code in [examples/complete](https://github.com/terraform-aws-modules/terraform-aws-s3-bucket/tree/master/examples/complete) but not identical. | ||
|
|
||
| ## Usage | ||
|
|
||
| Once this configuration is created, you need to use the newer version of this module (e.g. `~> 3.0`), review/update arguments (see code in [examples/complete](https://github.com/terraform-aws-modules/terraform-aws-s3-bucket/tree/master/examples/complete)) and import existing resources (see [UPGRADE-3.0.md](https://github.com/terraform-aws-modules/terraform-aws-s3-bucket/blob/master/UPGRADE-3.0.md) for more precise commands). | ||
|
|
||
| <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> | ||
| ## Requirements | ||
|
|
||
| | Name | Version | | ||
| |------|---------| | ||
| | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13.1 | | ||
| | <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 3.69.0 | | ||
| | <a name="requirement_random"></a> [random](#requirement\_random) | >= 2.0 | | ||
|
|
||
| ## Providers | ||
|
|
||
| | Name | Version | | ||
| |------|---------| | ||
| | <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 3.69.0 | | ||
| | <a name="provider_random"></a> [random](#provider\_random) | >= 2.0 | | ||
|
|
||
| ## Modules | ||
|
|
||
| | Name | Source | Version | | ||
| |------|--------|---------| | ||
| | <a name="module_log_bucket"></a> [log\_bucket](#module\_log\_bucket) | terraform-aws-modules/s3-bucket/aws | ~> 2.0 | | ||
| | <a name="module_s3_bucket"></a> [s3\_bucket](#module\_s3\_bucket) | terraform-aws-modules/s3-bucket/aws | ~> 2.0 | | ||
|
|
||
| ## Resources | ||
|
|
||
| | Name | Type | | ||
| |------|------| | ||
| | [aws_iam_role.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource | | ||
| | [aws_kms_key.objects](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/kms_key) | resource | | ||
| | [random_pet.this](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) | resource | | ||
| | [aws_iam_policy_document.bucket_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | | ||
|
|
||
| ## Inputs | ||
|
|
||
| No inputs. | ||
|
|
||
| ## Outputs | ||
|
|
||
| | Name | Description | | ||
| |------|-------------| | ||
| | <a name="output_s3_bucket_arn"></a> [s3\_bucket\_arn](#output\_s3\_bucket\_arn) | The ARN of the bucket. Will be of format arn:aws:s3:::bucketname. | | ||
| | <a name="output_s3_bucket_bucket_domain_name"></a> [s3\_bucket\_bucket\_domain\_name](#output\_s3\_bucket\_bucket\_domain\_name) | The bucket domain name. Will be of format bucketname.s3.amazonaws.com. | | ||
| | <a name="output_s3_bucket_bucket_regional_domain_name"></a> [s3\_bucket\_bucket\_regional\_domain\_name](#output\_s3\_bucket\_bucket\_regional\_domain\_name) | The bucket region-specific domain name. The bucket domain name including the region name, please refer here for format. Note: The AWS CloudFront allows specifying S3 region-specific endpoint when creating S3 origin, it will prevent redirect issues from CloudFront to S3 Origin URL. | | ||
| | <a name="output_s3_bucket_hosted_zone_id"></a> [s3\_bucket\_hosted\_zone\_id](#output\_s3\_bucket\_hosted\_zone\_id) | The Route 53 Hosted Zone ID for this bucket's region. | | ||
| | <a name="output_s3_bucket_id"></a> [s3\_bucket\_id](#output\_s3\_bucket\_id) | The name of the bucket. | | ||
| | <a name="output_s3_bucket_region"></a> [s3\_bucket\_region](#output\_s3\_bucket\_region) | The AWS region this bucket resides in. | | ||
| | <a name="output_s3_bucket_website_domain"></a> [s3\_bucket\_website\_domain](#output\_s3\_bucket\_website\_domain) | The domain of the website endpoint, if the bucket is configured with a website. If not, this will be an empty string. This is used to create Route 53 alias records. | | ||
| | <a name="output_s3_bucket_website_endpoint"></a> [s3\_bucket\_website\_endpoint](#output\_s3\_bucket\_website\_endpoint) | The website endpoint, if the bucket is configured with a website. If not, this will be an empty string. | | ||
| <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> |
Oops, something went wrong.