Skip to content

Dashboard: Extend Dashboard Support for (controller.devfile.io/debug-start) to Handle PostStart Failures in Dashboard UI #23609

@rohanKanojia

Description

@rohanKanojia

Is your enhancement related to a problem? Please describe

Related to #23404 devfile/devworkspace-operator#1522

This issue should be applicable once the aforementioned issue/PRs are merged.

We are enhancing the debugging capabilities of DevWorkspaces when a postStart lifecycle command fails.

In devworkspace-operator#425
Support for a new annotation, controller.devfile.io/debug-start, was added. When enabled, devworkspace deployment will not be scaled down on failure, giving developers time to inspect logs and container state. We're working on extending the use case of this annotation to also trap postStart hook failures with sleep so that postStart failures can also be debugged.

There seems to be some support with respect to this annotation:

Describe the solution you'd like

Enable the Che Dashboard UI to assist users in debugging such DevWorkspaces by recognizing and responding to this annotation.

What We Want

When a DevWorkspace includes the annotation controller.devfile.io/debug-start=true and the container is sleeping due to a postStart failure, the Dashboard should:

  • Detect that the pod is in a debug state due to postStart failure.
  • Provide users with guidance that the container is in a paused (sleeping) state for debugging.
  • Identify if the workspace Pod is in a state that allows exec into the container.
  • Provide a UI flow or guidance for users to:
    • View logs from the container (standard output & error).
      • Specifically check for the presence of:
        • /tmp/poststart-stderr.txt
        • /tmp/poststart-stdout.txt
  • Surface these logs directly in the UI if available.

This will significantly improve the developer experience when troubleshooting failed postStart hooks.

Describe alternatives you've considered

No response

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/devfile-specIssues related to Devfile v2area/devworkspace-operatorengine/devworkspaceIssues related to Che configured to use the devworkspace controller as workspace engine.kind/enhancementA feature request - must adhere to the feature request template.severity/P2Has a minor but important impact to the usage or development of the system.team/BThis team is responsible for the Web Terminal, the DevWorkspace Operator.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions