search

tektoncd / dashboard

A dashboard for Tekton!
Apache License 2.0
872 stars 265 forks source link

PipelineRun/TaskRun YAML view #762

Open ncskier opened 4 years ago

ncskier commented 4 years ago

Expected Behavior

When my PipelineRun/TaskRun has an error like a validation error, I would like to be able to view the YAML of the PipelineRun/TaskRun to debug.

Actual Behavior

There is no way to view the entire YAML for a PipelineRun or TaskRun. Only Tasks and Pipelines have a YAML view at the moment.

AlanGreene commented 4 years ago

Giving users the ability to view the raw YAML would definitely be useful, but we should also consider whether there are other/better ways to surface important info like this in the UI.

We could add a link on the list views to our generic YAML page like we have on the Pipelines and Tasks views, could even do this from the PipelineRun / TaskRun details page, but it feels like cheating and that approach was supposed to be a very short term thing.

@kimholmes do we have designs for showing the raw Tekton YAML anywhere in the recent updates? I know we discussed it briefly but can't remember if we documented it anywhere.

kimholmes commented 4 years ago

@AlanGreene The only place we're surfacing the YAML in the designs is on the Service Accounts. But we can certainly add this capability. Happy to discuss.

vdemeester commented 4 years ago

/kind bug

kimholmes commented 4 years ago

@AlanGreene I'm interested to learn more about what you mean when you say that surfacing the YAML feels like cheating. Why was that approach supposed to be a short term thing? Another question. Is it easy to link out to the YAML on Github?

AlanGreene commented 4 years ago

The way we did it for Tasks and Pipelines was meant to be a short term thing, it was never meant to be the only view for those resources. We have detail views for all other resource types, but for those two we either link to a filtered list of TaskRuns or PipelineRuns associated with the selected resource, or show the raw YAML. There's no page showing a more user-friendly rendering of a single resource.

There's no reliable way to determine where the YAML came from, it could have been manually created and applied to the cluster, could be from our Import feature, or applied in any other number of ways, so we can't guarantee there's an external location we can link to.

kimholmes commented 4 years ago

@AlanGreene Ok. That makes sense. If we want to be consistent with what we're doing in other parts of the design for the UI, we'd add a YAML tab on the Details view. So, there would be a Details tab and a YAML tab.

image image

However, we should be strategic about it as well. If there is an error in the Run, can we link directly to the part of the YAML that contains the error? Or do we have to link to the YAML as a whole?

tekton-robot commented 4 years ago

Stale issues rot after 30d of inactivity. Mark the issue as fresh with /remove-lifecycle rotten. Rotten issues close after an additional 30d of inactivity. If this issue is safe to close now please do so with /close.

/lifecycle rotten

Send feedback to tektoncd/plumbing.

tekton-robot commented 4 years ago

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close. If this issue is safe to close now please do so with /close.

/lifecycle stale

Send feedback to tektoncd/plumbing.

AlanGreene commented 4 years ago

/remove-lifecycle rotten /remove-lifecycle stale

AlanGreene commented 4 years ago

This issue is still valid. We need to revisit the proposed designs to take into account recent additions to Pipelines and Triggers and determine a sensible way to connect resources from these two projects in the UI. The outcome of that review may have some impact on the 'Details' tab, but the YAML view is still useful and should be added for consistency with other resource types that already have this functionality in the Dashboard.

AlanGreene commented 3 years ago

/kind design

tekton-robot commented 3 years ago

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale with a justification. Stale issues rot after an additional 30d of inactivity and eventually close. If this issue is safe to close now please do so with /close with a justification. If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/lifecycle stale

Send feedback to tektoncd/plumbing.

AlanGreene commented 3 years ago

This is still something we want to do. Freezing to prevent it from auto-closing /lifecycle frozen