canonical / canonical/data-science-stack
Improve the user experience around debugging deployment issues
- Dominant language
- Python
- Stars
- 37
- Forks
- 10
- PR merge metrics
- No merged PRs in 30d
Description
### Why it needs to get done
When `dss initialize` or other commands fail, we should provide the user with help to debug. For example:
* if `dss initialize` times out it provides no explanation about what went wrong and deletes all deployed resources which prevents further debugging
* if hostpath-storage is not enabled, the deployment hangs without any reason why
We should improve this.
Some possible ideas:
* timeout could leave the resources in whatever state they're in and give the users instructions on 1) how to debug further if they want to, and 2) how to remove the resources (ex: run `dss remove-components` or whatever `dss` command is appropriate)
* Con to this: leaves the user responsible for cleaning up any partially deployed resources
* timeout could take a snapshot of all relevant debugging information
* Con to this: we need to predict where debugging information might be and capture it, without knowing ahead of time what will go wrong
### What needs to get done
1. investigate and decide how to improve the UX around debugging
### When is the task considered done
see above
Contributor guide
Assessment
This issue has not been assessed yet.