Documentation Enhancement: Add reference to vsphere provider api_timeout in vsphere_virtual_machine documentation

[danpritts]

Community Guidelines

• I have read and agree to the HashiCorp Community Guidelines .
• Vote on this issue by adding a 👍 reaction to the original issue initial description to help the maintainers prioritize.
• Do not leave "+1" or other comments that do not add relevant information or questions.
• If you are interested in working on this issue or have submitted a pull request, please leave a comment.

Description

I ran into a timeout issue with large disk creation, which turned out to be solved in #1134 with addition of the api_timeout parameter for the vsphere provider.

I'm sure that the vsphere provider documentation page describes the api_timeout, but i wasn't looking there - I was looking at the docs for the vsphere_virtual_machine resource, because that was what i was trying to create when i had the issue.

https://registry.terraform.io/providers/hashicorp/vsphere/latest/docs/resources/virtual_machine#customization-and-network-waiters

The link I provide describes several situations where you might run into a timeout when creating a VM, but none of them was my issue.

This timeout is mentioned in passing in the provider doc page at https://registry.terraform.io/providers/hashicorp/vsphere/latest/docs but the implications of api timeouts aren't well explained.

Please update the virtual_machine page to include a reference to the api_timeout in the vsphere provider and mention that it specifically can fix timeouts while creating large disks. I suggest doing it in the section that I link above, where other timeouts are discussed. Optionally, also mention the implications of changing this timeout in the vsphere provider doucmentation.

Use Case(s)

making big disks on vsphere virtual machines

Potential Terraform Provider Configuration

api_timeout = 666

References

#1134

[github-actions]

Hello, danpritts! 🖐

Thank you for submitting an issue for this provider. The issue will now enter into the issue lifecycle.

If you want to contribute to this project, please review the contributing guidelines and information on submitting pull requests.