CustomResourceDefinitions Do Not Have Metadata For "explain" response
Open
Nobody has claimed this yet.
help wanted
kind/bug
lifecycle/frozen
- Dominant language
- Go
- Stars
- 608
- Forks
- 263
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 125
Description
Expected Behavior
Given that the Tekton operator is installed on an OpenShift cluster
When I execute oc explain <TektonResource>
Then I expect to see information documenting the API and Resources
Actual Behavior
$ oc explain EventListener
KIND: EventListener
VERSION: triggers.tekton.dev/v1beta1
DESCRIPTION:
<empty>
Steps to Reproduce the Problem
- Log on to an OpenShift cluster via CLI where Tekton is installed
- Run
oc explain --recursive EventListener - Note that there is no explanation
Additional Info
- Kubernetes version:
❯ oc version
Client Version: v4.2.0-alpha.0-657-g51011e4
Server Version: 4.9.12
Kubernetes Version: v1.22.3+e790d7f
- Tekton Pipeline version:
❯ tkn version
Client version: 0.21.0
Pipeline version: v0.28.2
Triggers version: v0.16.1
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Tekton CustomResourceDefinitions installed by the operator and reproduce the issue using oc explain --recursive EventListener on the stated Kubernetes/OpenShift versions. Trace how the EventListener API schema is generated or packaged, then verify that oc explain displays non-empty resource documentation and nested fields.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, kubernetes
- Domain
- api, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100