Generators for kube-like API types

Go to file

Kubernetes Publisher c81dd5d943 Merge pull request #132823 from yongruilin/master_vg_enum feat(validation-gen): add k8s:enum validators Kubernetes-commit: bb415b6933d31355276efac2edb71d70c0314036		2025-07-10 01:11:00 +00:00
.github	delete all duplicate empty blanks	2019-02-22 09:43:51 +08:00
cmd	feat(validation-gen): add k8s:enum validator	2025-07-08 18:35:42 +00:00
examples	Update github.com/emicklei/go-restful/v3 to v3.12.2	2025-07-02 08:00:43 -04:00
pkg	cleanup: Migrate deprecated function ExtractCommentTags	2025-06-06 17:57:43 -04:00
third_party/forked/golang	Copy golang license to staging copies	2021-08-10 17:37:28 -04:00
CONTRIBUTING.md	delete all duplicate empty blanks	2019-02-22 09:43:51 +08:00
LICENSE	Add README and LICENSE to staging repos	2017-10-23 16:39:02 +05:30
OWNERS	Add jpbetz to code-generator OWNERS	2024-06-24 15:43:18 +00:00
README.md	Add note about directory structure	2024-01-22 11:53:51 -05:00
SECURITY_CONTACTS	update security contacts for apimachinery repos	2020-07-02 16:00:53 -04:00
code-of-conduct.md	Add code-of-conduct.md to staging repos	2017-12-20 15:21:56 -05:00
doc.go	remove import doc comments	2024-12-02 14:43:58 +01:00
generate-groups.sh	EOL code-generator/generate-groups scripts	2024-01-16 22:20:02 -08:00
generate-internal-groups.sh	EOL code-generator/generate-groups scripts	2024-01-16 22:20:02 -08:00
go.mod	Merge pull request #132823 from yongruilin/master_vg_enum	2025-07-10 01:11:00 +00:00
go.sum	Merge pull request #132823 from yongruilin/master_vg_enum	2025-07-10 01:11:00 +00:00
kube_codegen.sh	Add validation-gen to codegen scripts	2025-03-03 09:49:50 -05:00
tools.go	Fix openapi-gen dependency.	2024-06-14 05:43:48 +03:00

README.md

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.