Skip to content

clean up azure temporary managed os disk #10713

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

Merged
nywilken merged 16 commits into from
Mar 18, 2021
Merged

clean up azure temporary managed os disk #10713

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
4388695
clean up temporary managed os disk
alexeldeib Mar 2, 2021
ab88422
improve message for skipping disk deletion
alexeldeib Mar 4, 2021
6ef856a
re-arrange osdisk/additional disk cleanup
alexeldeib Mar 4, 2021
3847c86
remove additional disk cleanup
alexeldeib Mar 5, 2021
d93d0ac
add some validation on scenarios
alexeldeib Mar 11, 2021
a007898
alway clean up resources inside template cleanup
alexeldeib Mar 12, 2021
0e769ca
tidy to master
alexeldeib Mar 12, 2021
c385f24
clarify naming and comments
alexeldeib Mar 17, 2021
a96d4d4
test: add acceptance testing for azure cleanup
alexeldeib Mar 17, 2021
ac10575
Merge branch 'ace/removeOsDisk' of github.com:alexeldeib/packer into …
alexeldeib Mar 17, 2021
74f6e1f
revert template changes
alexeldeib Mar 17, 2021
bae16d9
fix err check
alexeldeib Mar 17, 2021
1b2c36a
delete resources in parallel with retry to avoid serial deletion
alexeldeib Mar 18, 2021
bc39c32
nit: improve log message for transient deletion errors
alexeldeib Mar 18, 2021
2f72108
fix: typo
alexeldeib Mar 18, 2021
a2957d2
remove unused func to make lint happy
alexeldeib Mar 18, 2021
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
25 changes: 21 additions & 4 deletions builder/azure/arm/step_delete_additional_disks.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,13 +70,30 @@ func (s *StepDeleteAdditionalDisk) Run(ctx context.Context, state multistep.Stat
var isExistingResourceGroup = state.Get(constants.ArmIsExistingResourceGroup).(bool)
var resourceGroupName = state.Get(constants.ArmResourceGroupName).(string)

if dataDisks == nil {
s.say(fmt.Sprintf(" -> No Additional Disks specified"))
if isManagedDisk && !isExistingResourceGroup {
s.say(fmt.Sprintf(" -> Additional Disk : skipping, will "))
Comment thread
alexeldeib marked this conversation as resolved.
Outdated
return multistep.ActionContinue
}

if isManagedDisk && !isExistingResourceGroup {
s.say(fmt.Sprintf(" -> Additional Disk : skipping, managed disk was used..."))
if isManagedDisk {

@nywilken nywilken Mar 4, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think part of this confusion around where we can delete this disk is that I moved the call to NewStepDeleteAddtionalDisk into the StepDeployTemplate#Cleanup but in reality it should be its own thing.

While testing this today with a Windows OS build, non-managed, I was getting failures due to NewStepDeleteAddtionalDisk being called twice. After further investigation I found that for Windows builds NewStepDeployTemplate happens twice: one for the key vault deployment, and one for the virtual machine deployment. This issue only occurs for VHD builds.

Your solution for deleting the OS disk works, but still ends in a failed build because of the double call. I know what I'm pointing out is a different issue than the one you are fixing, but I believe they are related and if we move NewStepDeleteAddtionalDisk out of StepDeployTemplate#Cleanup then we can use your logic for deleting the OS disk or even the original code where we capture the os type and uri to be used for deletion in the cleanup function.

https://github.com/hashicorp/packer/pull/9559/files#diff-75e07109af7dc9db6f9e087b685e273810d56c6c48f04c153c2300e2d17c094eR134-R144

I moved NewStepDeleteAddtionalDisk into the Deployment cleanup step because it was previously being called after the Publish to SIG step, and if that failed the deletion would not happen. So my thought was to ensure the cleanup always happens where they are created - in StepDeployTemplate.

Here's a gist of the template I am using.

@alexeldeib alexeldeib Mar 4, 2021

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, nice! That takes care of the ordering issue between the cleanup steps very cleanly. I'll incorporate your patch and give it a try on my end 👍

s.say("Deleting the temporary managed OS disk ...")
var vhdUri interface{}
var ok bool
if vhdUri, ok = state.GetOk(constants.ArmOSDiskVhd); ok == false {
msg := "Failed to find VHD URI in state bag!"
s.say(msg)
return processStepResult(errors.New(msg), s.error, state)
}
vhdUriString := vhdUri.(string)

if err := s.deleteManaged(ctx, resourceGroupName, vhdUriString); err != nil {
s.say("Failed to delete the temporary managed OS Disk!")
return processStepResult(err, s.error, state)
}
}

if dataDisks == nil {
s.say(fmt.Sprintf(" -> No Additional Disks specified"))
return multistep.ActionContinue
}

Expand Down
17 changes: 14 additions & 3 deletions builder/azure/arm/step_delete_additional_disks_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,19 +192,26 @@ func TestStepDeleteAdditionalDiskShouldFailIfManagedDiskInExistingResourceGroupF
}
}

func TestStepDeleteAdditionalDiskShouldFailIfManagedDiskInExistingResourceGroupIsDeleted(t *testing.T) {
func TestStepDeleteAdditionalDiskShouldPassIfManagedOsDiskInExistingResourceGroupIsDeleted(t *testing.T) {
var count int
deleteManaged := func(context.Context, string, string) error {
count++
return nil
}

var testSubject = &StepDeleteAdditionalDisk{
delete: func(string, string) error { return nil },
say: func(message string) {},
error: func(e error) {},
deleteManaged: func(context.Context, string, string) error { return nil },
deleteManaged: deleteManaged,
}

stateBag := new(multistep.BasicStateBag)
stateBag.Put(constants.ArmAdditionalDiskVhds, []string{"subscriptions/123-456-789/resourceGroups/existingresourcegroup/providers/Microsoft.Compute/disks/osdisk"})
stateBag.Put(constants.ArmAdditionalDiskVhds, []string{"subscriptions/123-456-789/resourceGroups/existingresourcegroup/providers/Microsoft.Compute/disks/datadisk"})
stateBag.Put(constants.ArmIsManagedImage, true)
stateBag.Put(constants.ArmIsExistingResourceGroup, true)
stateBag.Put(constants.ArmResourceGroupName, "testgroup")
stateBag.Put(constants.ArmOSDiskVhd, "subscriptions/123-456-789/resourceGroups/existingresourcegroup/providers/Microsoft.Compute/disks/osdisk")

var result = testSubject.Run(context.Background(), stateBag)
if result != multistep.ActionContinue {
Expand All @@ -214,6 +221,10 @@ func TestStepDeleteAdditionalDiskShouldFailIfManagedDiskInExistingResourceGroupI
if _, ok := stateBag.GetOk(constants.Error); ok == true {
t.Fatalf("Expected the step to not set stateBag['%s'], but it was.", constants.Error)
}

if count != 2 {
t.Fatalf("Expected to delete OS and data disk in existing resource group, but only deleted %d disks.", count)
}
}

func DeleteTestStateBagStepDeleteAdditionalDisk(osDiskVhds []string) multistep.StateBag {
Expand Down