document thoughts on code generation #15
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
jaypipes
force-pushed
the
code-generation
branch
from
b0aa9f8
to
33a369f
Compare
mhausenblas
reviewed
Jan 14, 2020
docs/code-generation.md
Outdated
| * a hybrid custom code generator + sigs.kubernetes.io/controller-tools (CR) | ||
|
|
||
| The original AWS Service Operator used a [custom-built generator][1] that | ||
| processed [YAML files][2] describing the AWS service and used [templates][3] to |
There was a problem hiding this comment.
s/YAML files/YAML manifests
docs/code-generation.md
Outdated
| The original AWS Service Operator used a [custom-built generator][1] that | ||
| processed [YAML files][2] describing the AWS service and used [templates][3] to | ||
| [generate CRDs][4], the [controller code][5] itself and the [Go types][6] that | ||
| mirror the CRDs. It's worth noting that the CRDs *and* the controller code that |
There was a problem hiding this comment.
s/mirror the CRDs/represent the CRDs in memory
docs/code-generation.md
Outdated
| plan. Instead, ASO is a controller that facilitates creation and management of | ||
| various AWS service objects using Kubernetes CRD instances. | ||
|
|
||
| kubebuilder is the the recommended upstream tool for generating CRDs and |
There was a problem hiding this comment.
Mickey Blue Eyes disapproves :)
s/kubebuilder is the the/kubebuilder is the
docs/code-generation.md
Outdated
| various AWS service objects using Kubernetes CRD instances. | ||
|
|
||
| kubebuilder is the the recommended upstream tool for generating CRDs and | ||
| controller stub code. It is a Golang binary that creates the scaffolding for |
There was a problem hiding this comment.
Nit: While Golang is not incorrect, I'd prefer the simpler, short, and in our context unambiguous Go.
docs/code-generation.md
Outdated
|
|
||
| [9]: https://github.com/kubernetes-sigs/controller-tools/blob/a5fa7b956b85a6e792bc7086fedf7107d62452b1/cmd/controller-gen/main.go | ||
|
|
||
| We also want to generate some Golang code that "installs" a new reconciling |
There was a problem hiding this comment.
I think we should separate the build and operate (install/upgrade/ALM) concerns.
Adds a document discussing options for code generation and a diagram with how a multi-phase hybrid custom+controller-runtime generator might work. Issue #4
jaypipes
force-pushed
the
code-generation
branch
from
33a369f
to
91e6341
Compare
Closed
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.
Adds a document discussing options for code generation and a diagram
with how a multi-phase hybrid custom+controller-runtime generator might
work.
Issue #4