Client-gen is an automatic tool that generates clientset based on API types. This doc introduces the use the client-gen, and the release cycle of the generated clientsets.
The workflow includes three steps:
Marking API types with tags: in pkg/apis/${GROUP}/${VERSION}/types.go
, mark the types (e.g., Pods) that you want to generate clients for with the // +genclient=true
tag. If the resource associated with the type is not namespace scoped (e.g., PersistentVolume), you need to append the nonNamespaced=true
tag as well.
a. If you are developing in the k8s.io/kubernetes repository, you just need to run hack/update-codegen.sh.
b. If you are running client-gen outside of k8s.io/kubernetes, you need to use the command line argument --input
to specify the groups and versions of the APIs you want to generate clients for, client-gen will then look into pkg/apis/${GROUP}/${VERSION}/types.go
and generate clients for the types you have marked with the genclient
tags. For example, to generated a clientset named "my_release" including clients for api/v1 objects and extensions/v1beta1 objects, you need to run:
$ client-gen --input="api/v1,extensions/v1beta1" --clientset-name="my_release"
clientset: the clientset will be generated at pkg/client/clientset_generated/
by default, and you can change the path via the --clientset-path
command line argument.
Individual typed clients and client for group: They will be generated at pkg/client/clientset_generated/${clientset_name}/typed/generated/${GROUP}/${VERSION}/
If you are contributing code to k8s.io/kubernetes, try to use the release_X_Y clientset in this directory.
If you need a stable Go client to build your own project, please refer to the client-go repository.
We are migrating k8s.io/kubernetes to use client-go as well, see issue #35159.
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/devel/generating-clientset.md?pixel)]()此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。