-
Notifications
You must be signed in to change notification settings - Fork 9.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
resource/aws_autoscaling_group: Prevent unexpected differences in tags
for Terraform 0.11 and earlier with boolean propagate_at_launch
values
#13912
Conversation
…gs` for Terraform 0.11 and earlier with boolean `propagate_at_launch` values Reference: #13312 Reference: #13360 Reference: #13469 Reference: #13549 Reference: #13635 One of the major improvements internally with Terraform 0.12's type system is that providers and the core logic agree on a resource schema and its normalization during configuration parsing so the state and difference handling is more consistent. In Terraform 0.11 and earlier, a quirky behavior with raw boolean values is that they could be converted to string "0" and "1" values based on various factors such as passing through functions. With recent changes to the `aws_autoscaling_group` resource to fix its handling of the `tags` attribute (to prevent `d.Set()` errors and testing panics in the upcoming Terraform Plugin SDK 2.0.0), this behavior was highlighted as unexpected perpetual differences. This cannot be caught in the 0.12 shimmed acceptance testing framework and therefore is manually tested by the below configuration and reproduction steps. **NOTE:** The `tags` argument will be deprecated and removed in a future major version of the Terraform AWS Provider since it was designed as a workaround for Terraform 0.11 and earlier configurations. There are very few, if any, other Terraform AWS Provider attributes represented as a set of maps. In Terraform 0.12 and later, the `tag` argument more appropriately represents Auto Scaling Group resource tags as configuration blocks with strongly typed nested arguments and can be dynamically built via the `dynamic` configuration language feature. That deprecation is out of scope for this changeset though and likely will not occur until after Terraform AWS Provider version 3.0.0. Given the following Terraform 0.11 compatible configuration with raw boolean values: ```hcl terraform { required_version = "0.11.14" } provider "aws" { region = "us-east-2" version = "2.67.0" } locals { test = [ { key = "localkey1" value = "localvalue1" propagate_at_launch = true }, { key = "localkey2" value = "localvalue2" propagate_at_launch = true }, ] } data "aws_ami" "test" { most_recent = true owners = ["amazon"] filter { name = "name" values = ["amzn-ami-hvm-*-x86_64-gp2"] } } data "aws_availability_zones" "available" { state = "available" filter { name = "opt-in-status" values = ["opt-in-not-required"] } } resource "aws_launch_template" "test" { name_prefix = "test" image_id = "${data.aws_ami.test.id}" instance_type = "t2.micro" } resource "aws_autoscaling_group" "test" { availability_zones = ["${data.aws_availability_zones.available.names[0]}"] desired_capacity = 0 max_size = 0 min_size = 0 tags = ["${concat(list(map("key", "resourcekey1", "value", "resourcevalue1", "propagate_at_launch", true)), local.test)}"] launch_template { id = "${aws_launch_template.test.id}" version = "${aws_launch_template.test.default_version}" } } output "tags" { value = "${aws_autoscaling_group.test.tags}" } ``` Applying twice has a perpetual difference: ```console $ terraform0.11.14 init Initializing provider plugins... - Checking for available provider plugins on https://releases.hashicorp.com... - Downloading plugin for provider "aws" (2.67.0)... Terraform has been successfully initialized! You may now begin working with Terraform. Try running "terraform plan" to see any changes that are required for your infrastructure. All Terraform commands should now work. If you ever set or change modules or backend configuration for Terraform, rerun this command to reinitialize your working directory. If you forget, other commands will detect it and remind you to do so if necessary. $ terraform0.11.14 apply data.aws_ami.test: Refreshing state... data.aws_availability_zones.available: Refreshing state... An execution plan has been generated and is shown below. Resource actions are indicated with the following symbols: + create Terraform will perform the following actions: + aws_autoscaling_group.test id: <computed> arn: <computed> availability_zones.#: "1" availability_zones.4293815384: "us-east-2a" default_cooldown: <computed> desired_capacity: "0" force_delete: "false" health_check_grace_period: "300" health_check_type: <computed> launch_template.#: "1" launch_template.0.id: "${aws_launch_template.test.id}" launch_template.0.name: <computed> launch_template.0.version: "${aws_launch_template.test.default_version}" load_balancers.#: <computed> max_size: "0" metrics_granularity: "1Minute" min_size: "0" name: <computed> protect_from_scale_in: "false" service_linked_role_arn: <computed> tags.#: "3" tags.2825254636.%: "3" tags.2825254636.key: "localkey1" tags.2825254636.propagate_at_launch: "1" tags.2825254636.value: "localvalue1" tags.2888644505.%: "3" tags.2888644505.key: "resourcekey1" tags.2888644505.propagate_at_launch: "1" tags.2888644505.value: "resourcevalue1" tags.3299348900.%: "3" tags.3299348900.key: "localkey2" tags.3299348900.propagate_at_launch: "1" tags.3299348900.value: "localvalue2" target_group_arns.#: <computed> vpc_zone_identifier.#: <computed> wait_for_capacity_timeout: "10m" + aws_launch_template.test id: <computed> arn: <computed> default_version: <computed> image_id: "ami-083ebc5a49573896a" instance_type: "t2.micro" latest_version: "0" metadata_options.#: <computed> name: <computed> name_prefix: "test" Plan: 2 to add, 0 to change, 0 to destroy. Do you want to perform these actions? Terraform will perform the actions described above. Only 'yes' will be accepted to approve. Enter a value: yes aws_launch_template.test: Creating... arn: "" => "<computed>" default_version: "" => "<computed>" image_id: "" => "ami-083ebc5a49573896a" instance_type: "" => "t2.micro" latest_version: "" => "<computed>" metadata_options.#: "" => "<computed>" name: "" => "<computed>" name_prefix: "" => "test" aws_launch_template.test: Creation complete after 0s (ID: lt-0d8e6f4f94a683778) aws_autoscaling_group.test: Creating... arn: "" => "<computed>" availability_zones.#: "" => "1" availability_zones.4293815384: "" => "us-east-2a" default_cooldown: "" => "<computed>" desired_capacity: "" => "0" force_delete: "" => "false" health_check_grace_period: "" => "300" health_check_type: "" => "<computed>" launch_template.#: "" => "1" launch_template.0.id: "" => "lt-0d8e6f4f94a683778" launch_template.0.name: "" => "<computed>" launch_template.0.version: "" => "1" load_balancers.#: "" => "<computed>" max_size: "" => "0" metrics_granularity: "" => "1Minute" min_size: "" => "0" name: "" => "<computed>" protect_from_scale_in: "" => "false" service_linked_role_arn: "" => "<computed>" tags.#: "" => "3" tags.2825254636.%: "" => "3" tags.2825254636.key: "" => "localkey1" tags.2825254636.propagate_at_launch: "" => "1" tags.2825254636.value: "" => "localvalue1" tags.2888644505.%: "" => "3" tags.2888644505.key: "" => "resourcekey1" tags.2888644505.propagate_at_launch: "" => "1" tags.2888644505.value: "" => "resourcevalue1" tags.3299348900.%: "" => "3" tags.3299348900.key: "" => "localkey2" tags.3299348900.propagate_at_launch: "" => "1" tags.3299348900.value: "" => "localvalue2" target_group_arns.#: "" => "<computed>" vpc_zone_identifier.#: "" => "<computed>" wait_for_capacity_timeout: "" => "10m" aws_autoscaling_group.test: Creation complete after 2s (ID: tf-asg-20200623194008467200000003) Apply complete! Resources: 2 added, 0 changed, 0 destroyed. Outputs: tags = [ { key = localkey2, propagate_at_launch = 1, value = localvalue2 }, { key = localkey1, propagate_at_launch = 1, value = localvalue1 }, { key = resourcekey1, propagate_at_launch = 1, value = resourcevalue1 } ] $ terraform0.11.14 apply data.aws_ami.test: Refreshing state... data.aws_availability_zones.available: Refreshing state... aws_launch_template.test: Refreshing state... (ID: lt-0d8e6f4f94a683778) aws_autoscaling_group.test: Refreshing state... (ID: tf-asg-20200623194008467200000003) An execution plan has been generated and is shown below. Resource actions are indicated with the following symbols: ~ update in-place Terraform will perform the following actions: ~ aws_autoscaling_group.test tags.2131493069.%: "3" => "0" tags.2131493069.key: "localkey2" => "" tags.2131493069.propagate_at_launch: "true" => "" tags.2131493069.value: "localvalue2" => "" tags.2825254636.%: "0" => "3" tags.2825254636.key: "" => "localkey1" tags.2825254636.propagate_at_launch: "" => "1" tags.2825254636.value: "" => "localvalue1" tags.2888644505.%: "0" => "3" tags.2888644505.key: "" => "resourcekey1" tags.2888644505.propagate_at_launch: "" => "1" tags.2888644505.value: "" => "resourcevalue1" tags.3299348900.%: "0" => "3" tags.3299348900.key: "" => "localkey2" tags.3299348900.propagate_at_launch: "" => "1" tags.3299348900.value: "" => "localvalue2" tags.3593646732.%: "3" => "0" tags.3593646732.key: "localkey1" => "" tags.3593646732.propagate_at_launch: "true" => "" tags.3593646732.value: "localvalue1" => "" tags.3707627218.%: "3" => "0" tags.3707627218.key: "resourcekey1" => "" tags.3707627218.propagate_at_launch: "true" => "" tags.3707627218.value: "resourcevalue1" => "" Plan: 0 to add, 1 to change, 0 to destroy. ``` Building this version of the provider, the difference is no longer present: ```console $ cp ~/go/bin/terraform-provider-aws .terraform/plugins/darwin_amd64/terraform-provider-aws_v2.67.0_x4; terraform0.11.14 init; terraform0.11.14 apply Initializing provider plugins... Terraform has been successfully initialized! You may now begin working with Terraform. Try running "terraform plan" to see any changes that are required for your infrastructure. All Terraform commands should now work. If you ever set or change modules or backend configuration for Terraform, rerun this command to reinitialize your working directory. If you forget, other commands will detect it and remind you to do so if necessary. data.aws_availability_zones.available: Refreshing state... data.aws_ami.test: Refreshing state... aws_launch_template.test: Refreshing state... (ID: lt-0d8e6f4f94a683778) aws_autoscaling_group.test: Refreshing state... (ID: tf-asg-20200623194008467200000003) Apply complete! Resources: 0 added, 0 changed, 0 destroyed. Outputs: tags = [ { key = localkey1, propagate_at_launch = 1, value = localvalue1 }, { key = resourcekey1, propagate_at_launch = 1, value = resourcevalue1 }, { key = localkey2, propagate_at_launch = 1, value = localvalue2 } ] ``` Output from acceptance testing (Terraform 0.12 compatible): ``` --- PASS: TestAccAWSAutoScalingGroup_ALB_TargetGroups (176.05s) --- PASS: TestAccAWSAutoScalingGroup_ALB_TargetGroups_ELBCapacity (342.40s) --- PASS: TestAccAWSAutoScalingGroup_autoGeneratedName (89.91s) --- PASS: TestAccAWSAutoScalingGroup_basic (259.25s) --- PASS: TestAccAWSAutoScalingGroup_classicVpcZoneIdentifier (93.45s) --- PASS: TestAccAWSAutoScalingGroup_emptyAvailabilityZones (92.72s) --- PASS: TestAccAWSAutoScalingGroup_enablingMetrics (174.98s) --- PASS: TestAccAWSAutoScalingGroup_initialLifecycleHook (271.36s) --- PASS: TestAccAWSAutoScalingGroup_launchTemplate (62.35s) --- PASS: TestAccAWSAutoScalingGroup_LaunchTemplate_IAMInstanceProfile (61.69s) --- PASS: TestAccAWSAutoScalingGroup_launchTemplate_update (143.24s) --- PASS: TestAccAWSAutoScalingGroup_launchTempPartitionNum (77.30s) --- PASS: TestAccAWSAutoScalingGroup_LoadBalancers (695.77s) --- PASS: TestAccAWSAutoScalingGroup_MaxInstanceLifetime (80.89s) --- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy (108.93s) --- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy_InstancesDistribution_OnDemandAllocationStrategy (49.98s) --- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy_InstancesDistribution_OnDemandBaseCapacity (82.14s) --- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy_InstancesDistribution_OnDemandPercentageAboveBaseCapacity (96.59s) --- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy_InstancesDistribution_SpotAllocationStrategy (83.60s) --- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy_InstancesDistribution_SpotInstancePools (90.32s) --- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy_InstancesDistribution_SpotMaxPrice (112.90s) --- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy_InstancesDistribution_UpdateToZeroOnDemandBaseCapacity (73.62s) --- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy_LaunchTemplate_LaunchTemplateSpecification_LaunchTemplateName (86.69s) --- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy_LaunchTemplate_LaunchTemplateSpecification_Version (85.84s) --- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy_LaunchTemplate_Override_InstanceType (85.29s) --- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy_LaunchTemplate_Override_WeightedCapacity (205.06s) --- PASS: TestAccAWSAutoScalingGroup_namePrefix (45.70s) --- PASS: TestAccAWSAutoScalingGroup_serviceLinkedRoleARN (83.67s) --- PASS: TestAccAWSAutoScalingGroup_suspendingProcesses (267.51s) --- PASS: TestAccAWSAutoScalingGroup_tags (299.92s) --- PASS: TestAccAWSAutoScalingGroup_TargetGroupArns (249.92s) --- PASS: TestAccAWSAutoScalingGroup_terminationPolicies (151.45s) --- PASS: TestAccAWSAutoScalingGroup_VpcUpdates (236.40s) --- PASS: TestAccAWSAutoScalingGroup_WithLoadBalancer (389.18s) --- PASS: TestAccAWSAutoScalingGroup_WithLoadBalancer_ToTargetGroup (384.27s) --- PASS: TestAccAWSAutoScalingGroup_withMetrics (96.85s) --- PASS: TestAccAWSAutoScalingGroup_withPlacementGroup (200.69s) ```
Verified that the config in #13635 (comment) (with |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM - also confirmed 0.11 no longer showing perpetual diff w/these changes 👍
Output of acceptance tests:
--- PASS: TestAccAWSAutoScalingGroup_classicVpcZoneIdentifier (51.23s)
--- PASS: TestAccAWSAutoScalingGroup_autoGeneratedName (56.28s)
--- PASS: TestAccAWSAutoScalingGroup_serviceLinkedRoleARN (66.17s)
--- PASS: TestAccAWSAutoScalingGroup_namePrefix (66.34s)
--- PASS: TestAccAWSAutoScalingGroup_VpcUpdates (88.14s)
--- PASS: TestAccAWSAutoScalingGroup_emptyAvailabilityZones (91.78s)
--- PASS: TestAccAWSAutoScalingGroup_launchTemplate (51.14s)
--- PASS: TestAccAWSAutoScalingGroup_LaunchTemplate_IAMInstanceProfile (58.77s)
--- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy (42.73s)
--- PASS: TestAccAWSAutoScalingGroup_terminationPolicies (132.85s)
--- PASS: TestAccAWSAutoScalingGroup_MaxInstanceLifetime (138.07s)
--- PASS: TestAccAWSAutoScalingGroup_withMetrics (144.72s)
--- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy_InstancesDistribution_OnDemandAllocationStrategy (66.80s)
--- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy_InstancesDistribution_OnDemandBaseCapacity (70.56s)
--- PASS: TestAccAWSAutoScalingGroup_launchTemplate_update (122.64s)
--- PASS: TestAccAWSAutoScalingGroup_enablingMetrics (179.67s)
--- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy_InstancesDistribution_SpotInstancePools (41.78s)
--- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy_InstancesDistribution_SpotAllocationStrategy (50.43s)
--- PASS: TestAccAWSAutoScalingGroup_suspendingProcesses (198.07s)
--- PASS: TestAccAWSAutoScalingGroup_withPlacementGroup (199.36s)
--- PASS: TestAccAWSAutoScalingGroup_ALB_TargetGroups (201.74s)
--- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy_InstancesDistribution_OnDemandPercentageAboveBaseCapacity (77.87s)
--- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy_InstancesDistribution_UpdateToZeroOnDemandBaseCapacity (84.43s)
--- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy_LaunchTemplate_LaunchTemplateSpecification_LaunchTemplateName (51.31s)
--- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy_LaunchTemplate_LaunchTemplateSpecification_Version (43.40s)
--- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy_InstancesDistribution_SpotMaxPrice (73.91s)
--- PASS: TestAccAWSAutoScalingGroup_launchTempPartitionNum (40.68s)
--- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy_LaunchTemplate_Override_InstanceType (52.46s)
--- PASS: TestAccAWSAutoScalingGroup_initialLifecycleHook (232.52s)
--- PASS: TestAccAWSAutoScalingGroup_basic (296.72s)
--- PASS: TestAccAWSAutoScalingGroup_MixedInstancesPolicy_LaunchTemplate_Override_WeightedCapacity (131.65s)
--- PASS: TestAccAWSAutoScalingGroup_WithLoadBalancer_ToTargetGroup (317.01s)
--- PASS: TestAccAWSAutoScalingGroup_ALB_TargetGroups_ELBCapacity (322.42s)
--- PASS: TestAccAWSAutoScalingGroup_TargetGroupArns (340.02s)
--- PASS: TestAccAWSAutoScalingGroup_WithLoadBalancer (361.65s)
--- PASS: TestAccAWSAutoScalingGroup_tags (376.57s)
--- PASS: TestAccAWSAutoScalingGroup_LoadBalancers (647.83s)
This has been released in version 2.69.0 of the Terraform AWS provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading. For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template for triage. Thanks! |
I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks! |
Community Note
Reference: #13312
Reference: #13360
Reference: #13469
Reference: #13549
Closes #13635
Release note for CHANGELOG:
One of the major improvements internally with Terraform 0.12's type system is that providers and the core logic agree on a resource schema and its normalization during configuration parsing so the state and difference handling is more consistent. In Terraform 0.11 and earlier, a quirky behavior with raw boolean values is that they could be converted to string "0" and "1" values based on various factors such as passing through functions. With recent changes to the
aws_autoscaling_group
resource to fix its handling of thetags
attribute (to preventd.Set()
errors and testing panics in the upcoming Terraform Plugin SDK 2.0.0), this behavior was highlighted as unexpected perpetual differences. This cannot be caught in the 0.12 shimmed acceptance testing framework and therefore is manually tested by the below configuration and reproduction steps.NOTE: The
tags
argument will be deprecated and removed in a future major version of the Terraform AWS Provider since it was designed as a workaround for Terraform 0.11 and earlier configurations. There are very few, if any, other Terraform AWS Provider attributes represented as a set of maps. In Terraform 0.12 and later, thetag
argument more appropriately represents Auto Scaling Group resource tags as configuration blocks with strongly typed nested arguments and can be dynamically built via thedynamic
configuration language feature. That deprecation is out of scope for this changeset though and likely will not occur until after Terraform AWS Provider version 3.0.0.Given the following Terraform 0.11 compatible configuration with raw boolean values:
Applying twice has a perpetual difference:
Building this version of the provider, the difference is no longer present:
Output from acceptance testing (Terraform 0.12 compatible):