Add a diagnostics subcommand #285
Description
When a user faces complex issues with Trident it generally involves a lot of back and forth to get all the context and information about the deployment that was being attempted.
A hypothetical trident diagnose command could be run after trident update or trident install failed to generate a support file that would contain all basic context that could lead to a resolution. This includes things like:
- Host configuration (current, if any, and new)
- Trident logs
- Trident errors
- Trident version
- Trident runtime environment (container/host)
- Host status
- Summary of datastore
- Description of the host (VM/baremetal?)
- Workplan and execution results (future)
All these items would get packaged in a single compressed file (eg. zstd tarball?) that can be easily extracted and sent to us.
We should aim to avoid collecting sensitive info here, but sometimes it may be required.
The diagnostics subcommand could also attempt to suggest simple fixes when possible.
Ideally, we would also develop dev tools that can help us parse/understand the support file. (eg. generate a web-based report)