Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

UX for starting workspaces in the "Debug" mode #22465

Closed
ibuziuk opened this issue Aug 31, 2023 · 1 comment
Closed

UX for starting workspaces in the "Debug" mode #22465

ibuziuk opened this issue Aug 31, 2023 · 1 comment
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

Comments

@ibuziuk
Copy link
Member

ibuziuk commented Aug 31, 2023

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`:
Знімок екрана 2023-08-30 о 14 46 31
Знімок екрана 2023-08-30 о 14 46 42
Знімок екрана 2023-08-30 о 14 47 58

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

  1. Workspace fails
  2. Apply annotation, restart workspace and let it fail again
  3. Collect debugging information
  4. Remove annotation to let workspace stop naturally

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

@ibuziuk ibuziuk added kind/enhancement A feature request - must adhere to the feature request template. status/analyzing An issue has been proposed and it is currently being analyzed for effort and implementation approach sprint/next area/dashboard labels Aug 31, 2023
@amisevsk amisevsk added the severity/P1 Has a major impact to usage or development of the system. label Sep 1, 2023
@ibuziuk
Copy link
Member Author

ibuziuk commented Sep 5, 2023

after some discussion it was decided to leave the flow as-is for now and close the issue
@Kasturi1820 @l0rd are you ok with that?

@ibuziuk ibuziuk closed this as completed Sep 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

2 participants