⚠️ New Generation Framework and Generators #200
Merged
Conversation
This file contains 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
Don't accidentally check in ViM swap files, etc.
This introduces utilities for incremental/filtered package loading, based on go/packages (the new replacement for go/build and friends when importing). It'll work with modules properly, too.
This introduces a framework for collecting and parsing "marker" comments into structured Go data, much like the "json" package.
This removed the generation and parsing logic that's being superseded by loader, markers, etc.
This adds a generator framework that ties together running multiple generators from the same marker data, and describe how they can read and write artifacts.
This adds RBAC generation (as per our existing RBAC markers) on top of the new generator framework.
This defines the framework for CRD generation, and uses markers with that implement interfaces to modify the schema and CRD.
This implements deepcopy generation, mostly copying from deepcopy-gen but using the generator framework. It slightly scopes down things to only implement parts we care about for custom types that represent CRDs.
This updates controller-gen to make use of the new generator framework. Generators and ouput rules are treated as markers to parse commandline options.
This adds WebhookConfig generation (as per our existing webhook markers, with slight modifications) on top of the new generator framework.
Update deps to required versions.
It's no longer used by any tests. We can always add it back in if we need to.
Some of the enabled checkers were deprecated, had known issues, or returned erroneous results. They've been commented out, with comments as to why they're not run.
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: DirectXMan12 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
k8s-ci-robot
added
cncf-cla: yes
|
Additional thanks to @redborian and @mengqiy for a bunch of the initial CRD generation revamp work that preceded the new framework. |
|
It feels fitting that this is Issue/PR 200 :-) |
|
/lgtm |
k8s-ci-robot
added
the
lgtm
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This introduces a new marker (tag) parsing and generation framework that should help easy feature addition and longterm development, as well as improve the UX of using controller-tools with different project layouts, including the new kubebuilder scaffolding v2 layout in development.
The framework itself is broken up across several packages, each of which has an overview godoc page on how it works and the logic behind it.
The core framework is composed of:
pkg/loader: file loading and low-level type traversalpkg/markers: marker parsing and high-level type traversalpkg/genall: managing and running generators from shared parsing stateAdditionally, the following generators exist, all of which can be called directly as a "library"
pkg/crd: CRD and OpenAPI schema generation (lower-level bits are standalone, and can be used directly)pkg/deepcopy: CRD-specific replacement for deepcopy-genpkg/webhook: WebhookConfig generationpkg/rbac: ClusterRole generationAll generators are tied together in the new version of the
controller-gencommand. Thecontroller-gencommand takes generator and output arguments using the same syntax as the markers, without the leading plus. Run with--helpfor help and examples. You can also use the-wflag to check which markers a given generator can consume (for example,controller-gen crd -wwill show all the validation and versioning markers).