Create CRD validation specs in CRD manifests and as Go code #869
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
estroz
requested review from
AlexNPavel,
hasbro17,
joelanford,
lilic,
mhrivnak and
shawn-hurley
openshift-ci-robot
added
the
size/XL
estroz
force-pushed
the
crd-validation
branch
2 times, most recently
from
646711a to
6e3f3e1
Compare
…CRD manifests commands/.../add/api.go: call OpenAPI generator function pkg/scaffold/crd*: use CustomRenderer interface to write CRD manifests with validation spec instead of a template pkg/scaffold/gopkgtoml*: include openapi-gen deps pkg/scaffold/types*: add openapi-gen directives
remove status field from resulting struct
estroz
added
the
kind/feature
estroz
force-pushed
the
crd-validation
branch
from
6e3f3e1 to
cdb791c
Compare
…generator condition
|
Any update on this PR? Seems pretty solid, have been testing it with some basic types to CRD generation, and so far so good |
hasbro17
approved these changes
Jan 28, 2019
Contributor
hasbro17
left a comment
hasbro17
left a comment
There was a problem hiding this comment.
LGTM after nits.
@estroz As we discussed offline I'm fine with having users using the +kubebuilder:validation tags to add the custom validation directives.
But as a follow up to this PR we should try to look into not stomping out any validation directives that are added directly to the CRD yaml manifest on running generate openapi.
Contributor
|
Also the CHANGELOG and cli-reference guide need to be updated but it's fine if you have that lined up in follow up PR to add the docs. |
…s if explicitly adding them
estroz
force-pushed
the
crd-validation
branch
2 times, most recently
from
0f5a186 to
613ac72
Compare
Member
Author
|
The additions in this PR to the generated |
estroz
force-pushed
the
crd-validation
branch
from
3fff291 to
b46c19a
Compare
openshift-ci-robot
added
size/XXL
estroz
force-pushed
the
crd-validation
branch
from
84de2a9 to
4c50988
Compare
openshift-ci-robot
added
size/XL
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of the change:
operator-sdk generate openapigenerates OpenAPI validation specs for CRD manifests and as Go code underpkg/apis/<group>/<version>/zz_generated.openapi.go.operator-sdk add apialso calls the openapi generator. The CRD scaffold now implementsCustomRendererto generate a CRD using controller-tools' CRD generator by default; if some CRD manifest exists,CustomRenderwill only set the validation spec of that CRD.Motivation for the change: validation specs should be present for all CRD's, yaml or otherwise. Users might want to use the Go specs for Go-defined CRD's.
Note: we can remove Go spec generator, as there haven't been requests for one. I thought it would be a nice addition but not necessary. I'm also open to not having a separate generate command, and having all generation under
generate k8s.I'll add documentation in another PR since this one is already large.
Closes #256