equinix / terraform-equinix-metal-anthos-on-vsphere

[Deprecated] Automated Anthos Installation via Terraform for Equinix Metal with vSphere
https://registry.terraform.io/modules/equinix/anthos-on-vsphere/metal/latest
Apache License 2.0
62 stars 41 forks source link

Provide issue reporting tips #102

Closed displague closed 2 weeks ago

displague commented 3 years ago

We should update the README.md or create an GH Issue template that offers advice on reporting issues.

This should advice users to include a snippet of the errors messages. If Terraform provided a stack trace, including that would be helpful. These should be sanitized of API tokens or IP addresses that may appear in the output.

There are ways to get more detailed output from Terraform by settings environment variables: https://www.terraform.io/docs/internals/debugging.html

The Packet API can also emit its API calls with environment variables (this includes the API token, cookies, and other sensitive details so be extra careful): PACKNGO_DEBUG=1

Some common occurrences have been catalogued here: https://github.com/packet-labs/google-anthos#troubleshooting. If any problem becomes all too common and outside of quick-fix territory, we should chronicle it there.

Some issues may be files in alternate repositories, such as github.com/packethost/packngo, github.com/packethost/terraform-provider-packet, or in Anthos projects.