-
Notifications
You must be signed in to change notification settings - Fork 3.2k
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
Add descriptions to kubectl explain
#8190
Comments
This is like |
@alexec it's like |
This may be a bit challenging for resources like Workflows, which will require a schema for this feature to work. Due to the size of the CRDs with the schema, this will cause errors like below when deploying the CRD with descriptions: for: "manifests/base/crds/full/argoproj.io_workflows.yaml": Request entity too large: limit is 3145728 It seems schemas were intentionally left out due to this issue. However, it still may be possible for smaller CRDs to support kubectl explain. |
Even if a description can't be put in, it would be nice to know what lies under For example, if something is a An example of this would be when I was creating a CronWorkflow. I presumed base on the example here that the I feel there is room for improvement here and if I can find the time to help with this I will. Either getting the explain command to work on a more descriptive level or improving any docs where possible. |
I've located this - it's something for now I guess. Just not ideal when working on a cli 😉 |
Summary
kubectl explain
is an invaluable tool for quickly exploring Kubernetes resources. CRDs can provide descriptions thatkubectl explain
can pick up. For example, see Knative.Use Cases
Instead of going to the Argo Workflows webpage, I'd like to run, for example,
kubectl explain workflow
for guidance on building a Workflow resource.Message from the maintainers:
Love this enhancement proposal? Give it a 👍. We prioritise the proposals with the most 👍.
The text was updated successfully, but these errors were encountered: