diff options
| author | sarahnovotny <sarah.novotny@gmail.com> | 2017-04-28 11:35:21 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-04-28 11:35:21 -0700 |
| commit | 71a352d42a2d3e13c1b865de4caf01e468a8a6d3 (patch) | |
| tree | d64601826212b10f44541a14d411c2d34307ae2e | |
| parent | d98b30a128a4c9d76ef5b3e89426334ff1052145 (diff) | |
| parent | 712e47e58fca664d8c4b9844e4bf5907491bb7ef (diff) | |
Merge pull request #578 from spzala/clientsetdoc
Fix broken links in the generating-clientset
| -rw-r--r-- | contributors/devel/generating-clientset.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/contributors/devel/generating-clientset.md b/contributors/devel/generating-clientset.md index 49f84b2c..d7d9a8da 100644 --- a/contributors/devel/generating-clientset.md +++ b/contributors/devel/generating-clientset.md @@ -1,6 +1,6 @@ # Generation and release cycle of clientset -Client-gen is an automatic tool that generates [clientset](../../docs/proposals/client-package-structure.md#high-level-client-sets) based on API types. This doc introduces the use the client-gen, and the release cycle of the generated clientsets. +Client-gen is an automatic tool that generates [clientset](../design-proposals/client-package-structure.md#high-level-client-sets) based on API types. This doc introduces the use the client-gen, and the release cycle of the generated clientsets. ## Using client-gen @@ -16,7 +16,7 @@ The workflow includes three steps: $ client-gen --input="api/v1,extensions/v1beta1" --clientset-name="my_release" ``` -**3.** ***Adding expansion methods***: client-gen only generates the common methods, such as CRUD. You can manually add additional methods through the expansion interface. For example, this [file](../../pkg/client/clientset_generated/clientset/typed/core/v1/pod_expansion.go) adds additional methods to Pod's client. As a convention, we put the expansion interface and its methods in file ${TYPE}_expansion.go. In most cases, you don't want to remove existing expansion files. So to make life easier, instead of creating a new clientset from scratch, ***you can copy and rename an existing clientset (so that all the expansion files are copied)***, and then run client-gen. +**3.** ***Adding expansion methods***: client-gen only generates the common methods, such as CRUD. You can manually add additional methods through the expansion interface. For example, this [file](https://github.com/kubernetes/kubernetes/tree/master/pkg/client/clientset_generated/clientset/typed/core/v1/pod_expansion.go) adds additional methods to Pod's client. As a convention, we put the expansion interface and its methods in file ${TYPE}_expansion.go. In most cases, you don't want to remove existing expansion files. So to make life easier, instead of creating a new clientset from scratch, ***you can copy and rename an existing clientset (so that all the expansion files are copied)***, and then run client-gen. ## Output of client-gen @@ -26,7 +26,7 @@ $ client-gen --input="api/v1,extensions/v1beta1" --clientset-name="my_release" ## Released clientsets -If you are contributing code to k8s.io/kubernetes, try to use the generated clientset [here](../../pkg/client/clientset_generated/clientset/). +If you are contributing code to k8s.io/kubernetes, try to use the generated clientset [here](https://github.com/kubernetes/kubernetes/tree/master/pkg/client/clientset_generated/clientset). If you need a stable Go client to build your own project, please refer to the [client-go repository](https://github.com/kubernetes/client-go). |