Improve kubernetes-client/gen documentation for {CLIENT_LANGUAGE}.sh … (#86)

* Improve kubernetes-client/gen documentation for {CLIENT_LANGUAGE}.sh (#85)

* Update README.md

* Update README.md
This commit is contained in:
Marie Yau
2018-11-09 12:25:36 -08:00
committed by k8s-ci-robot
parent f1c262699f
commit 9cf654298a

View File

@@ -24,6 +24,17 @@ are normally:
- `CLIENT_VERSION`: Client version string. e.g. "1.0.0b1" - `CLIENT_VERSION`: Client version string. e.g. "1.0.0b1"
- `PACKAGE_NAME`: Package name for the generated client. e.g. "kubernetes" - `PACKAGE_NAME`: Package name for the generated client. e.g. "kubernetes"
Example settings file for python-client:
export KUBERNETES_BRANCH="master"
export CLIENT_VERSION="8.0.0b1"
export PACKAGE_NAME="client"
Note: For generating the client for any language, the PACKAGE_NAME should be "client".
You can use the latest version for the CLIENT_VERSION. It's displayed here for
the python-client ( https://github.com/kubernetes-client/python ), and similarly
for other language clients.
Recommended structure is to generate client in a folder called `kubernetes` at the root of Recommended structure is to generate client in a folder called `kubernetes` at the root of
the client repo and put all settings in a file named `settings` at the root of the repo. the client repo and put all settings in a file named `settings` at the root of the repo.
If you followed these recommendations, you can simply run autoupdate script anywhere inside If you followed these recommendations, you can simply run autoupdate script anywhere inside