feat: Set timeout for v/virtual_machine reconfigure task

[rashaev]

Description

Sometimes reconfiguration tasks take a long time. And if they last more than 5 minutes, then the tasks fail. Because the limit is set as a constant as seen below.

terraform-provider-vsphere/vsphere/internal/helper/virtualmachine/virtual_machine_helper.go

Lines 827 to 840 in 30f37d2

	// Reconfigure wraps the Reconfigure task and the subsequent waiting for
	// the task to complete.
	func Reconfigure(vm *object.VirtualMachine, spec types.VirtualMachineConfigSpec) error {
	log.Printf("[DEBUG] Reconfiguring virtual machine %q", vm.InventoryPath)
	ctx, cancel := context.WithTimeout(context.Background(), provider.DefaultAPITimeout)
	defer cancel()
	task, err := vm.Reconfigure(ctx, spec)
	if err != nil {
	return err
	}
	tctx, tcancel := context.WithTimeout(context.Background(), provider.DefaultAPITimeout)
	defer tcancel()
	return task.Wait(tctx)
	}

This pull request adds a timeout setting for r/virtual_machine reconfiguration tasks.

Release Note

resource/virtual_machine: Virtual machine reconfiguration tasks will use the provider api_timeout setting. (GH-1645)

References

Closes #1646
Closes #1662
Closes #1764
Closes #1795

[hashicorp-cla]

All committers have signed the CLA.

[tenthirtyam]

Hi @rashaev 👋,

Can you please open an enhancement issue and then link the pull request to the issue?

Ryan Johnson
Staff II Solutions Architect | VMware, Inc.

[rashaev]

Hi @rashaev wave,

Can you please open an enhancement issue and then link the pull request to the issue?

Ryan Johnson Staff II Solutions Architect | VMware, Inc.

HI @tenthirtyam . Of course. I already did it.

[tenthirtyam]

Deferring to @appilon review.

[appilon]

The provider really doesn't implement the canonical setup for handling timeouts. https://www.terraform.io/plugin/sdkv2/resources/retries-and-customizable-timeouts

It appears the provider awkwardly has a private defaultAPITimeout which doesn't remain a default... in the provider configure function it gets set to the provider block attr api_timeout. Some places in the provider also seems to use a public constant provider.DefaultAPITimeout which does remain a hardcoded 5 minute timer..

With all that said, I'm comfortable approving this improvement for now, but would recommend harmonizing timeouts throughout the provider as a tech debt task.

[tenthirtyam]

Agreed, @appilon. I've opened #1698 for the technical debt.

Ryan Johnson
Senior Staff Solutions Architect | Product Engineering @ VMware, Inc.

[tenthirtyam]

Approved.

Ryan Johnson
Senior Staff Solutions Architect | Product Engineering @ VMware, Inc.

[github-actions]

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.