github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-30 23:15:14 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #122915 from MikeSpreitzer/note-codegen-dirs

Browse Source 
Add note about directory structure in code-generator
This commit is contained in:
Kubernetes Prow Robot 2024-01-23 23:52:09 +01:00 committed by GitHub
commit e50efe5b9d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
staging/src/k8s.io/code-generator/README.md
View File

@ -14,6 +14,10 @@ These code-generators can be used
- The example [sample controller](https://github.com/kubernetes/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](https://cloud.redhat.com/blog/kubernetes-deep-dive-code-generation-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](kube_codegen.sh).
## Compatibility
HEAD of this repo will match HEAD of k8s.io/apiserver, k8s.io/apimachinery, and k8s.io/client-go.

7
staging/src/k8s.io/code-generator/kube_codegen.sh
View File

@ -17,6 +17,10 @@
# This presents several functions for packages which want to use kubernetes
# code-generation tools.
# These functions insist that your input IDL (commented go) files be located in
# go packages following the pattern $input_pkg_root/$something_sans_slash/$api_version .
# Those $something_sans_slash will be propagated into the output directory structure.
set -o errexit
set -o nounset
set -o pipefail
@ -42,6 +46,7 @@ function kube::codegen::internal::git_grep() {
# --input-pkg-root <string>
# The root package under which to search for files which request code to be
# generated. This must be Go package syntax, e.g. "k8s.io/foo/bar".
# See note at the top about package structure below that.
#
# --output-base <string>
# The root directory under which to emit code. The concatenation of
@ -229,6 +234,7 @@ function kube::codegen::gen_helpers() {
# --input-pkg-root <string>
# The root package under which to search for files which request openapi to
# be generated. This must be Go package syntax, e.g. "k8s.io/foo/bar".
# See note at the top about package structure below that.
#
# --output-pkg-root <string>
# The root package under which generated directories and files
@ -399,6 +405,7 @@ function kube::codegen::gen_openapi() {
# The root package under which to search for *.go files which request
# clients to be generated. This must be Go package syntax, e.g.
# "k8s.io/foo/bar".
# See note at the top about package structure below that.
#
# --one-input-api <string>
# A specific API (a directory) under the --input-pkg-root for which to