Skip to content
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

Make kubectl explain a useful resource for our CRDs #64

Open
edwardecook opened this issue Apr 29, 2020 · 0 comments
Open

Make kubectl explain a useful resource for our CRDs #64

edwardecook opened this issue Apr 29, 2020 · 0 comments
Labels
enhancement New feature or request estimate/S Estimated to be a small change

Comments

@edwardecook
Copy link
Contributor

We don't currently support kubectl explain for any of the CRDs we have in projects-operator. The method for doing so is specifying a structural scheme, see https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#specifying-a-structural-schema.

The initial switch to a structural schema would come with #62. However in order to gain a useful output from kubectl explain we would also need to include useful descriptions (via comments above our types and fields) that describe the purpose of the CRDs as well as the spec fields.

@edwardecook edwardecook added enhancement New feature or request estimate/S Estimated to be a small change labels Apr 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request estimate/S Estimated to be a small change
Projects
None yet
Development

No branches or pull requests

1 participant