README
¶
code-generator
Golang code-generators used to implement Kubernetes-style API types.
Purpose
These code-generators can be used
- in the context of CustomResourceDefinition to build native, versioned clients, informers and other helpers
- in the context of User-provider API Servers to build conversions between internal and versioned types, defaulters, protobuf codecs, internal and versioned clients and informers.
Resources
- The example sample controller shows a code example of a controller that uses the clients, listers and informers generated by this library.
- The article Kubernetes Deep Dive: Code Generation for CustomResources gives a step by step instruction on how to use this library.
Usage
The examples above are dated. The current recommended script to use is kube_codegen.sh.
Compatibility
HEAD of this repo will match HEAD of k8s.io/apiserver, k8s.io/apimachinery, and k8s.io/client-go.
Where does it come from?
code-generator is synced from https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/code-generator.
Code changes are made in that location, merged into k8s.io/kubernetes and later synced here.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
applyconfiguration-gen
command
applyconfiguration-gen is a tool for auto-generating apply builder functions.
|
applyconfiguration-gen is a tool for auto-generating apply builder functions. |
|
client-gen
command
client-gen makes the individual typed clients using gengo.
|
client-gen makes the individual typed clients using gengo. |
|
client-gen/generators
Package generators has the generators for the client-gen utility.
|
Package generators has the generators for the client-gen utility. |
|
conversion-gen
command
conversion-gen is a tool for auto-generating functions that convert between internal and external types.
|
conversion-gen is a tool for auto-generating functions that convert between internal and external types. |
|
deepcopy-gen
command
deepcopy-gen is a tool for auto-generating DeepCopy functions.
|
deepcopy-gen is a tool for auto-generating DeepCopy functions. |
|
deepcopy-gen/output_tests/aliases
This is a test package.
|
This is a test package. |
|
deepcopy-gen/output_tests/builtins
This is a test package.
|
This is a test package. |
|
deepcopy-gen/output_tests/interfaces
This is a test package.
|
This is a test package. |
|
deepcopy-gen/output_tests/maps
This is a test package.
|
This is a test package. |
|
deepcopy-gen/output_tests/pointer
This is a test package.
|
This is a test package. |
|
deepcopy-gen/output_tests/slices
This is a test package.
|
This is a test package. |
|
deepcopy-gen/output_tests/structs
This is a test package.
|
This is a test package. |
|
deepcopy-gen/output_tests/wholepkg
This is a test package.
|
This is a test package. |
|
defaulter-gen
command
defaulter-gen is a tool for auto-generating Defaulter functions.
|
defaulter-gen is a tool for auto-generating Defaulter functions. |
|
defaulter-gen/output_tests/empty
This is a test package.
|
This is a test package. |
|
defaulter-gen/output_tests/marker
This is a test package.
|
This is a test package. |
|
defaulter-gen/output_tests/pointer
This is a test package.
|
This is a test package. |
|
defaulter-gen/output_tests/slices
This is a test package.
|
This is a test package. |
|
defaulter-gen/output_tests/wholepkg
This is a test package.
|
This is a test package. |
|
go-to-protobuf
command
go-to-protobuf generates a Protobuf IDL from a Go struct, respecting any existing IDL tags on the Go struct.
|
go-to-protobuf generates a Protobuf IDL from a Go struct, respecting any existing IDL tags on the Go struct. |
|
go-to-protobuf/protobuf
go-to-protobuf generates a Protobuf IDL from a Go struct, respecting any existing IDL tags on the Go struct.
|
go-to-protobuf generates a Protobuf IDL from a Go struct, respecting any existing IDL tags on the Go struct. |
|
go-to-protobuf/protoc-gen-gogo
command
Package main defines the protoc-gen-gogo binary we use to generate our proto go files, as well as takes dependencies on the correct gogo/protobuf packages for godeps.
|
Package main defines the protoc-gen-gogo binary we use to generate our proto go files, as well as takes dependencies on the correct gogo/protobuf packages for godeps. |
|
informer-gen
command
|
|
|
lister-gen
command
|
|
|
prerelease-lifecycle-gen
command
prerelease-lifecycle-gen is a tool for auto-generating api-status.csv files.
|
prerelease-lifecycle-gen is a tool for auto-generating api-status.csv files. |
|
register-gen
command
|
|
|
examples
module
|
|
|
pkg
|
|
|
third_party
|
|
|
forked/golang/reflect
This package is copied from Go library reflect/type.go.
|
This package is copied from Go library reflect/type.go. |
Click to show internal directories.
Click to hide internal directories.