UX for starting workspaces in the "Debug" mode #22465
Labels
area/dashboard
kind/enhancement
A feature request - must adhere to the feature request template.
severity/P1
Has a major impact to usage or development of the system.
sprint/next
status/analyzing
An issue has been proposed and it is currently being analyzed for effort and implementation approach
Is your enhancement related to a problem? Please describe
The "Verbose" mode has been removed from UD as part of #22391
On the UD end, it is still possible to start workspace in Debug mode which sets
controller.devfile.io/debug-start=true
annotation to workspace from the dashboard`:When that annotation is applied to a workspace, DWO prevents the workspace from stopping when it fails -- instead, it enters a
Failing
state but is still marked as "started" on the cluster.The purpose of this annotation is to debug workspace failures; when the annotation is present, DWO will not clean up any workspace resources until you tell it to (by setting
.spec.started: false
or removing the annotation). This allows you to view e.g. pod logs, or the pod spec, which is normally lost when a workspace enters the stopped phase. It's even more useful when automatic cleaning up of resources is enabled as in that case there are no resources left for the stopped workspace (e.g. no metadata configmap).Documentation on the annotation is here: https://github.com/devfile/devworkspace-operator/blob/main/docs/additional-configuration.adoc#debugging-a-failing-workspace
The intended flow is
I'm not opposed to removing it from the Dashboard, as it's a flow that might require additional guidance (e.g. around removing the annotation when you're done debugging) but it's a fairly useful feature in general IMO.
Describe the solution you'd like
Should we leave it as-is, remove, or change and improve?
Describe alternatives you've considered
No response
Additional context
No response
The text was updated successfully, but these errors were encountered: