Make "kubectl explain" work for HTTPProxy resources.

jpeach commented 4 years ago

Please describe the problem you have

kubectl explain is a built-in way to provide Kubernetes resource reference material to users. It would be great to support this as part of the HTTPProxy documentation.

jpeach commented 4 years ago

@youngnick I think that kubectl explain pull this from the OpenAPI definition for the Resource, so maybe we could get this for free as part of #1575?

jpeach commented 4 years ago

KIND:     HTTPProxy
VERSION:  projectcontour.io/v1

DESCRIPTION:
     <empty>

KIND:     HTTPProxy
VERSION:  projectcontour.io/v1

DESCRIPTION:
     <empty>

:(

youngnick commented 4 years ago

Hmm, probably. I'll take this for now and see if that happens when I do #1414.

davecheney commented 4 years ago

There is also #1567

youngnick commented 4 years ago

Sadly, #1731 didn't just magically fix this one, but I think that that's due to upstream things.

Specifically:

Pruning must be enabled. This is optional for CRD version v1beta1 (what we're currently using). We can specify it, but not with the generator I added in #1731, it doesn't support it yet. I enabled it manually in a test 1.16 cluster, but the kubectl explain was not the full version, so I suspect the second condition is also not fulfilled currently.
The schema must be structural, which the ones we are publishing should be (thanks to the generator). I suspect that we may need to update to a newer version of the generator, but master is broken in my version. In addition, I suspect something we are doing in our current version is making the validation not structural, but I can't find what it is.

The tl;dr here for next steps is:

We need to require at least Kubernetes 1.16, and move to CustomResourceDefinition v1. That will make solving this a lot easier. It's a big change though, and will require a long tail for updates.
Until that happens the best we can do is chase controller-tools to add support for setting the pruning value in the spec, and to add support for ensuring the validation is structural.

There is no way any of this will be done in rc.2, so I'm moving this to backlog. I'll keep it and poke it along.

jpeach commented 4 years ago

Blocked by https://github.com/projectcontour/contour/issues/2678

alexbrand commented 4 years ago

+1

projectcontour / contour

Make "kubectl explain" work for HTTPProxy resources. #1723