Skip to content
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.

Sign up for GitHub

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

Reapply changes to avoid destroying instance on user_data updates #18043

Merged
merged 3 commits into from
Feb 18, 2022
Merged

Reapply changes to avoid destroying instance on user_data updates #18043

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4b1091e
Reapply changes to avoid destroying instance on user_data updates
rogerhu Mar 11, 2021
4add81b
CR updates with additiional test coverage
anGie44 Feb 18, 2022
d4fee8f
Update CHANGELOG for #18043
anGie44 Feb 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .changelog/18043.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:enhancement
resource/aws_instance: Allow updates to `user_data` and `user_data_base64` without forcing resource replacement
```
175 changes: 117 additions & 58 deletions internal/service/ec2/instance.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -564,7 +564,6 @@ func ResourceInstance() *schema.Resource {
"user_data": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
Computed: true,
ConflictsWith: []string{"user_data_base64"},
DiffSuppressFunc: func(k, old, new string, d *schema.ResourceData) bool {
Expand All @@ -589,7 +588,6 @@ func ResourceInstance() *schema.Resource {
"user_data_base64": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
Computed: true,
ConflictsWith: []string{"user_data"},
ValidateFunc: func(v interface{}, name string) (warns []string, errs []error) {
Expand Down Expand Up @@ -1423,73 +1421,57 @@ func resourceInstanceUpdate(d *schema.ResourceData, meta interface{}) error {
}
}

if d.HasChange("instance_type") && !d.IsNewResource() {
log.Printf("[INFO] Stopping Instance %q for instance_type change", d.Id())
_, err := conn.StopInstances(&ec2.StopInstancesInput{
InstanceIds: []*string{aws.String(d.Id())},
})
if err != nil {
return fmt.Errorf("error stopping instance (%s): %s", d.Id(), err)
}

if err := WaitForInstanceStopping(conn, d.Id(), InstanceStopTimeout); err != nil {
return err
}

log.Printf("[INFO] Modifying instance type %s", d.Id())
_, err = conn.ModifyInstanceAttribute(&ec2.ModifyInstanceAttributeInput{
InstanceId: aws.String(d.Id()),
InstanceType: &ec2.AttributeValue{
Value: aws.String(d.Get("instance_type").(string)),
},
})
if err != nil {
return err
}
if d.HasChanges("instance_type", "user_data", "user_data_base64") && !d.IsNewResource() {
// For each argument change, we start and stop the instance
// to account for behaviors occurring outside terraform.
// Only one attribute can be modified at a time, else we get
// "InvalidParameterCombination: Fields for multiple attribute types specified"
if d.HasChange("instance_type") {
log.Printf("[INFO] Modifying instance type %s", d.Id())

log.Printf("[INFO] Starting Instance %q after instance_type change", d.Id())
input := &ec2.ModifyInstanceAttributeInput{
InstanceId: aws.String(d.Id()),
InstanceType: &ec2.AttributeValue{
Value: aws.String(d.Get("instance_type").(string)),
},
}

input := &ec2.StartInstancesInput{
InstanceIds: []*string{aws.String(d.Id())},
if err := modifyAttributeWithInstanceStopStart(d, conn, input); err != nil {
return fmt.Errorf("error updating instance (%s) instance type: %w", d.Id(), err)
}
}

// Reference: https://github.com/hashicorp/terraform-provider-aws/issues/16433
err = resource.Retry(InstanceAttributePropagationTimeout, func() *resource.RetryError {
_, err := conn.StartInstances(input)

if tfawserr.ErrMessageContains(err, ErrCodeInvalidParameterValue, "LaunchPlan instance type does not match attribute value") {
return resource.RetryableError(err)
if d.HasChange("user_data") {
log.Printf("[INFO] Modifying user data %s", d.Id())
input := &ec2.ModifyInstanceAttributeInput{
InstanceId: aws.String(d.Id()),
UserData: &ec2.BlobAttributeValue{
Value: []byte(d.Get("user_data").(string)),
},
}

if err != nil {
return resource.NonRetryableError(err)
if err := modifyAttributeWithInstanceStopStart(d, conn, input); err != nil {
return fmt.Errorf("error updating instance (%s) user data: %w", d.Id(), err)
}

return nil
})

if tfresource.TimedOut(err) {
_, err = conn.StartInstances(input)
}

if err != nil {
return fmt.Errorf("error starting EC2 Instance (%s): %w", d.Id(), err)
}
if d.HasChange("user_data_base64") {
log.Printf("[INFO] Modifying user data base64 %s", d.Id())
userData, err := base64.URLEncoding.DecodeString(d.Get("user_data_base64").(string))
if err != nil {
return fmt.Errorf("error updating instance (%s) user data base64: %w", d.Id(), err)
}

stateConf := &resource.StateChangeConf{
Pending: []string{ec2.InstanceStateNamePending, ec2.InstanceStateNameStopped},
Target: []string{ec2.InstanceStateNameRunning},
Refresh: InstanceStateRefreshFunc(conn, d.Id(), []string{ec2.InstanceStateNameTerminated}),
Timeout: d.Timeout(schema.TimeoutUpdate),
Delay: 10 * time.Second,
MinTimeout: 3 * time.Second,
}
input := &ec2.ModifyInstanceAttributeInput{
InstanceId: aws.String(d.Id()),
UserData: &ec2.BlobAttributeValue{
Value: userData,
},
}

_, err = stateConf.WaitForState()
if err != nil {
return fmt.Errorf(
"Error waiting for instance (%s) to become ready: %s",
d.Id(), err)
if err := modifyAttributeWithInstanceStopStart(d, conn, input); err != nil {
return fmt.Errorf("error updating instance (%s) user data base64: %w", d.Id(), err)
}
}
}

Expand Down Expand Up @@ -1766,6 +1748,62 @@ func resourceInstanceDisableAPITermination(conn *ec2.EC2, id string, disableAPIT
return nil
}

// modifyAttributeWithInstanceStopStart modifies a specific attribute provided
// as input by first stopping the EC2 instance before the modification
// and then starting up the EC2 instance after modification.
// Reference: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html
func modifyAttributeWithInstanceStopStart(d *schema.ResourceData, conn *ec2.EC2, input *ec2.ModifyInstanceAttributeInput) error {
log.Printf("[INFO] Stopping Instance %q for attribute change", d.Id())
_, err := conn.StopInstances(&ec2.StopInstancesInput{
InstanceIds: []*string{aws.String(d.Id())},
})

if err != nil {
return fmt.Errorf("error stopping EC2 Instance (%s): %w", d.Id(), err)
}

if err := WaitForInstanceStopping(conn, d.Id(), InstanceStopTimeout); err != nil {
return err
}

if _, err := conn.ModifyInstanceAttribute(input); err != nil {
return err
}

startInput := &ec2.StartInstancesInput{
InstanceIds: []*string{aws.String(d.Id())},
}

// Reference: https://github.com/hashicorp/terraform-provider-aws/issues/16433
err = resource.Retry(InstanceAttributePropagationTimeout, func() *resource.RetryError {
_, err := conn.StartInstances(startInput)

if tfawserr.ErrMessageContains(err, ErrCodeInvalidParameterValue, "LaunchPlan instance type does not match attribute value") {
return resource.RetryableError(err)
}

if err != nil {
return resource.NonRetryableError(err)
}

return nil
})

if tfresource.TimedOut(err) {
_, err = conn.StartInstances(startInput)
}

if err != nil {
return fmt.Errorf("error starting EC2 Instance (%s): %w", d.Id(), err)
}

if err := WaitForInstanceRunning(conn, d.Id(), InstanceStartTimeout); err != nil {
return err
}

return nil
}

// InstanceStateRefreshFunc returns a resource.StateRefreshFunc that is used to watch
// an EC2 instance.
func InstanceStateRefreshFunc(conn *ec2.EC2, instanceID string, failStates []string) resource.StateRefreshFunc {
Expand Down Expand Up @@ -2781,6 +2819,27 @@ func terminateInstance(conn *ec2.EC2, id string, timeout time.Duration) error {
return waitForInstanceDeletion(conn, id, timeout)
}

func WaitForInstanceRunning(conn *ec2.EC2, id string, timeout time.Duration) error {
log.Printf("[DEBUG] Waiting for instance (%s) to be running", id)

stateConf := &resource.StateChangeConf{
Pending: []string{ec2.InstanceStateNamePending, ec2.InstanceStateNameStopped},
Target: []string{ec2.InstanceStateNameRunning},
Refresh: InstanceStateRefreshFunc(conn, id, []string{ec2.InstanceStateNameTerminated}),
Timeout: timeout,
Delay: 10 * time.Second,
MinTimeout: 3 * time.Second,
}

_, err := stateConf.WaitForState()
if err != nil {
return fmt.Errorf(
"error waiting for instance (%s) to be running: %s", id, err)
}

return nil
}

func WaitForInstanceStopping(conn *ec2.EC2, id string, timeout time.Duration) error {
log.Printf("[DEBUG] Waiting for instance (%s) to become stopped", id)

Expand Down
Loading