codegenerator

package module

v0.30.0-rc.2 Latest Latest Go to latest Published: Apr 11, 2024 License: Apache-2.0 Imports: 0 Imported by: 104

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
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
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