Support kubectl explain

[jlpettersson]

Feature request

When working with yaml, it is hard to know all the fields, and it is cumbersome to find yaml in the doc. When working with kubernetes it is good to be able to use kubectl explain <resource> to understand the yaml structure.

This is not well supported for Tekton resources:

$ kubectl explain PipelineRun
KIND:     PipelineRun
VERSION:  tekton.dev/v1beta1

DESCRIPTION:
     <empty>

Would it be possible to improve on this?

Use case

I would like to e.g. lookup how a PipelineRun should be structured with:

kubectl explain PipelineRun.spec

But that is not so helpful, e.g. compare with kubectl explain Deployment.spec - that is very helpful.

[vdemeester]

@jlpettersson so my guess is #3173 would help, but it comes with a problem : our spec are huge, so having the openapi spec embedded in the CRD breaks the kubectl apply as it becomes an object too big for etcd 😅

[tekton-robot]

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.

[chmouel]

/remove-lifecycle stale
/lifecycle frozen

still useful, unfortunately there is no easy way to imp this

[georgettica]

at least I know this issue is known and is hard to implement

[chmouel]

I could not remember the reason why it wasn't easy but i rem it was @vdemeester who was telling me about it 😀

[georgettica]

@jlpettersson so my guess is #3173 would help, but it comes with a problem : our spec are huge, so having the openapi spec embedded in the CRD breaks the kubectl apply as it becomes an object too big for etcd 😅

@chmouel this seems to be a valid point

[justinabrahms]

It would be very welcome if we could, at a minimum, link to the API specs as part of the description field of the CRD.

[vdemeester]

There s a new PR trying to fix that 👼🏼 #8490