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

Remove "Verbose" mode from UD #22391

Closed
ibuziuk opened this issue Jul 26, 2023 · 9 comments
Closed

Remove "Verbose" mode from UD #22391

ibuziuk opened this issue Jul 26, 2023 · 9 comments
Assignees
Labels
area/dashboard kind/enhancement A feature request - must adhere to the feature request template. severity/P2 Has a minor but important impact to the usage or development of the system.

Comments

@ibuziuk
Copy link
Member

ibuziuk commented Jul 26, 2023

Is your enhancement related to a problem? Please describe

Verbose mode is not working and is pretty much useless since we have logs and events Tabs now on the dashboard.

Describe the solution you'd like

Remove "Verbose" mode from the UD

Describe alternatives you've considered

N/A

Additional context

Docs PR - eclipse-che/che-docs#2636

@ibuziuk ibuziuk added kind/enhancement A feature request - must adhere to the feature request template. area/dashboard severity/P2 Has a minor but important impact to the usage or development of the system. labels Jul 26, 2023
@tolusha
Copy link
Contributor

tolusha commented Jul 26, 2023

It is needed to remove from the doc as well https://eclipse.dev/che/docs/stable/end-user-guide/investigating-failures-at-a-workspace-start-using-the-verbose-mode/

@olexii4
Copy link
Contributor

olexii4 commented Aug 8, 2023

@ibuziuk What about controller.devfile.io/debug-start: 'true' ?
Знімок екрана 2023-08-08 о 11 25 27
Should we remove it at all?

@ibuziuk
Copy link
Member Author

ibuziuk commented Aug 8, 2023

@amisevsk could you please clarify how "controller.devfile.io/debug-start=true" annotation currently work on DWO end? does it make sense to have "Debug" mode exposed on UD? What events logs would be propagated if the annotation is enabled?

@amisevsk
Copy link
Contributor

amisevsk commented Aug 8, 2023

Debugging startup is still useful, in my opinion. 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.

@ibuziuk
Copy link
Member Author

ibuziuk commented Aug 30, 2023

@l0rd @olexii4 follow up on the eclipse-che/che-dashboard#896 (comment)
My understanding is that Debug / Verbose mode has been fully removed from the User Dashboard. This means that there is no way to set "controller.devfile.io/debug-start=true" annotation from the UI. Are we happy with that approach for now and the issue can be closed as well?

@l0rd
Copy link
Contributor

l0rd commented Aug 30, 2023

This issue has been fixed so I think we can close this one.

Having a way to set controller.devfile.io/debug-start=true from the dashboard is useful (a lot for us, less for a normal Che user) but it deserves it's own issue and a UX discussion.

@ibuziuk ibuziuk closed this as completed Aug 30, 2023
@olexii4
Copy link
Contributor

olexii4 commented Aug 30, 2023

@ibuziuk We still have the ability to set controller.devfile.io/debug-start=true from the dashboard:
Знімок екрана 2023-08-30 о 14 46 31
Знімок екрана 2023-08-30 о 14 46 42
Знімок екрана 2023-08-30 о 14 47 58

@ibuziuk
Copy link
Member Author

ibuziuk commented Aug 30, 2023

@l0rd do you think we should leave it as is for now or also remove ^

@ibuziuk
Copy link
Member Author

ibuziuk commented Aug 31, 2023

Closing in favour of #22465
@l0rd @Kasturi1820 please review ^

@ibuziuk ibuziuk closed this as completed Aug 31, 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/P2 Has a minor but important impact to the usage or development of the system.
Projects
None yet
Development

No branches or pull requests

5 participants