codegenerator

package module

v0.33.0-alpha.3 Latest Latest Go to latest Published: Mar 4, 2025 License: Apache-2.0 Imports: 0 Imported by: 114

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/kubernetes/code-generator

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 ¶

View all Source files

doc.go

Directories ¶

Path	Synopsis
cmd
applyconfiguration-gen applyconfiguration-gen is a tool for auto-generating apply builder functions.	applyconfiguration-gen is a tool for auto-generating apply builder functions.
applyconfiguration-gen/args
applyconfiguration-gen/generators
client-gen client-gen makes the individual typed clients using gengo.	client-gen makes the individual typed clients using gengo.
client-gen/args
client-gen/generators Package generators has the generators for the client-gen utility.	Package generators has the generators for the client-gen utility.
client-gen/generators/fake
client-gen/generators/scheme
client-gen/generators/util
client-gen/types
conversion-gen 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.
conversion-gen/args
conversion-gen/generators
deepcopy-gen deepcopy-gen is a tool for auto-generating DeepCopy functions.	deepcopy-gen is a tool for auto-generating DeepCopy functions.
deepcopy-gen/args
deepcopy-gen/generators
deepcopy-gen/output_tests
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/otherpkg
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 defaulter-gen is a tool for auto-generating Defaulter functions.	defaulter-gen is a tool for auto-generating Defaulter functions.
defaulter-gen/args
defaulter-gen/generators
defaulter-gen/output_tests
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/marker/external
defaulter-gen/output_tests/marker/external/external
defaulter-gen/output_tests/marker/external2
defaulter-gen/output_tests/marker/external3
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 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 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
informer-gen/args
informer-gen/generators
lister-gen
lister-gen/args
lister-gen/generators
prerelease-lifecycle-gen 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.
prerelease-lifecycle-gen/args
prerelease-lifecycle-gen/prerelease-lifecycle-generators
register-gen
register-gen/args
register-gen/generators
register-gen/output_tests
register-gen/output_tests/simpletype/v1
validation-gen validation-gen is a tool for auto-generating Validation functions.	validation-gen is a tool for auto-generating Validation functions.
validation-gen/output_tests
validation-gen/output_tests/_codegenignore/other This is a test package.	This is a test package.
validation-gen/output_tests/all_types_match/trivial This is a test package.	This is a test package.
validation-gen/output_tests/all_types_match/with_field_validations This is a test package.	This is a test package.
validation-gen/output_tests/all_types_match/with_type_validations This is a test package.	This is a test package.
validation-gen/output_tests/cross_pkg This is a test package.	This is a test package.
validation-gen/output_tests/elide_no_validations This is a test package.	This is a test package.
validation-gen/output_tests/maps/keys This is a test package.	This is a test package.
validation-gen/output_tests/maps/map_of_map/deep This is a test package.	This is a test package.
validation-gen/output_tests/maps/map_of_map/shallow This is a test package.	This is a test package.
validation-gen/output_tests/maps/map_of_primitive This is a test package.	This is a test package.
validation-gen/output_tests/maps/map_of_slice/deep This is a test package.	This is a test package.
validation-gen/output_tests/maps/map_of_slice/shallow This is a test package.	This is a test package.
validation-gen/output_tests/maps/map_of_struct This is a test package.	This is a test package.
validation-gen/output_tests/maps/multiple_validations This is a test package.	This is a test package.
validation-gen/output_tests/maps/typedef_to_map This is a test package.	This is a test package.
validation-gen/output_tests/multiple_tags This is a test package.	This is a test package.
validation-gen/output_tests/no_generation Package nogeneration is a test package.	Package nogeneration is a test package.
validation-gen/output_tests/no_types_match This is a test package.	This is a test package.
validation-gen/output_tests/one_type_match/trivial This is a test package.	This is a test package.
validation-gen/output_tests/one_type_match/with_field_validations This is a test package.	This is a test package.
validation-gen/output_tests/one_type_match/with_type_validations This is a test package.	This is a test package.
validation-gen/output_tests/ordering/structs This is a test package.	This is a test package.
validation-gen/output_tests/ordering/typedefs This is a test package.	This is a test package.
validation-gen/output_tests/pointers This is a test package.	This is a test package.
validation-gen/output_tests/primitives This is a test package.	This is a test package.
validation-gen/output_tests/public_private Package publicprivate is a test package.	Package publicprivate is a test package.
validation-gen/output_tests/recursive This is a test package.	This is a test package.
validation-gen/output_tests/slices/multiple_validations This is a test package.	This is a test package.
validation-gen/output_tests/slices/slice_of_map/deep This is a test package.	This is a test package.
validation-gen/output_tests/slices/slice_of_map/shallow This is a test package.	This is a test package.
validation-gen/output_tests/slices/slice_of_primitive This is a test package.	This is a test package.
validation-gen/output_tests/slices/slice_of_slice/deep This is a test package.	This is a test package.
validation-gen/output_tests/slices/slice_of_slice/shallow This is a test package.	This is a test package.
validation-gen/output_tests/slices/slice_of_struct This is a test package.	This is a test package.
validation-gen/output_tests/slices/typedef_to_slice This is a test package.	This is a test package.
validation-gen/output_tests/tags/eachkey This is a test package.	This is a test package.
validation-gen/output_tests/tags/eachval/map_of_map/deep This is a test package.	This is a test package.
validation-gen/output_tests/tags/eachval/map_of_map/shallow This is a test package.	This is a test package.
validation-gen/output_tests/tags/eachval/map_of_primitive This is a test package.	This is a test package.
validation-gen/output_tests/tags/eachval/map_of_slice/deep This is a test package.	This is a test package.
validation-gen/output_tests/tags/eachval/map_of_slice/shallow This is a test package.	This is a test package.
validation-gen/output_tests/tags/eachval/map_of_struct This is a test package.	This is a test package.
validation-gen/output_tests/tags/eachval/slice_of_map/deep This is a test package.	This is a test package.
validation-gen/output_tests/tags/eachval/slice_of_map/shallow This is a test package.	This is a test package.
validation-gen/output_tests/tags/eachval/slice_of_primitive This is a test package.	This is a test package.
validation-gen/output_tests/tags/eachval/slice_of_slice/deep This is a test package.	This is a test package.
validation-gen/output_tests/tags/eachval/slice_of_slice/shallow This is a test package.	This is a test package.
validation-gen/output_tests/tags/eachval/slice_of_struct This is a test package.	This is a test package.
validation-gen/output_tests/tags/eachval/typedef_to_map This is a test package.	This is a test package.
validation-gen/output_tests/tags/eachval/typedef_to_slice This is a test package.	This is a test package.
validation-gen/output_tests/tags/immutable This is a test package.	This is a test package.
validation-gen/output_tests/tags/listmap/multiple_keys This is a test package.	This is a test package.
validation-gen/output_tests/tags/listmap/single_key This is a test package.	This is a test package.
validation-gen/output_tests/tags/opaque This is a test package.	This is a test package.
validation-gen/output_tests/tags/optional This is a test package.	This is a test package.
validation-gen/output_tests/tags/subfield/deep Package subfield contains test types for testing subfield field validation tags.	Package subfield contains test types for testing subfield field validation tags.
validation-gen/output_tests/tags/subfield/nonincluded Package nonincluded contains test types for testing subfield field validation tags.	Package nonincluded contains test types for testing subfield field validation tags.
validation-gen/output_tests/tags/subfield/shallow Package subfield contains test types for testing subfield field validation tags.	Package subfield contains test types for testing subfield field validation tags.
validation-gen/output_tests/tags/validate_false This is a test package.	This is a test package.
validation-gen/output_tests/tags/validate_true This is a test package.	This is a test package.
validation-gen/output_tests/type_args This is a test package.	This is a test package.
validation-gen/output_tests/typedefs This is a test package.	This is a test package.
validation-gen/output_tests/update_validations/lists This is a test package.	This is a test package.
validation-gen/output_tests/update_validations/maps This is a test package.	This is a test package.
validation-gen/output_tests/update_validations/primitive_pointers Package primitivepointers is a test package.	Package primitivepointers is a test package.
validation-gen/output_tests/update_validations/primitives This is a test package.	This is a test package.
validation-gen/testscheme Package testscheme provides a scheme implementation and test utilities useful for writing output_tests for validation-gen.	Package testscheme provides a scheme implementation and test utilities useful for writing output_tests for validation-gen.
validation-gen/validators
examples module
pkg
namer
util
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.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL