Skip to content

njhale/code-generator

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wrappers for clients generated using code-gen

Usage:

Input flags:

  1. --input-dir - The directory path where APIs are defined. Make sure that the types are defined in <inputDir>/pkg/apis/{$GROUP}/{$VERSION}. For example, if your input apis are defined in types.go inside testdata/pkg/apis/apps/v1/types.go, the input directory should be specified as testdata/pkg. {$GROUP}/{$VERSION} is appended in the input path. Note: This is the relative path to the input directory where APIs live.

  2. --output-dir - The directory where output clients are to be generated. It defaults to the clientset folder under current working directory.

    • Clientset wrappers would be generated inside <outputDir>/<clientset-name>/clientset.go.
    • Individual typed client wrappers would be inside <outputDir>/<clientset-name>/${GROUP}/${VERSION}/${group_version}.go.
  3. --clientset-api-path - The path to where clientset generated by k8s.io/code-gen is present.

  4. --clientset-name - The name of the generated clientset package. It defaults to clientset.

  5. --group-versions - List of group versions in the format group:version. Define multiple groups by specifying the flag again. For example, the inputs can be:

    • --group-version="apps:v1"
    • --group-versions="rbac:v1" --group-versions="apps:v1"
    • --group-version="rbac:v1,v2"
  6. --go-header-file - Path to the header file.

Example: To run it locally and see how it works, use the following command:

go run main.go client --clientset-name clusterclient --go-header-file testdata/header.txt 
                      --clientset-api-path=github.com/kcp-dev/code-generator/testdata/pkg/generated/clientset/versioned 
                      --input-dir testdata/pkg/apis 
                      --output-dir testdata/pkg --group-versions example:v1

will create an output folder in testdata/pkg/clientset.

About

Generators for workspace-aware clientsets, informers, and listers

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 87.4%
  • Makefile 8.4%
  • Shell 4.2%