From 9cf654298a7232ff8bd24ed3d1cfb6a1fe296eae Mon Sep 17 00:00:00 2001 From: Marie Yau Date: Fri, 9 Nov 2018 12:25:36 -0800 Subject: [PATCH] =?UTF-8?q?Improve=20kubernetes-client/gen=20documentation?= =?UTF-8?q?=20for=20{CLIENT=5FLANGUAGE}.sh=20=E2=80=A6=20(#86)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Improve kubernetes-client/gen documentation for {CLIENT_LANGUAGE}.sh (#85) * Update README.md * Update README.md --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index b2bbd02..01f1de9 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,17 @@ are normally: - `CLIENT_VERSION`: Client version string. e.g. "1.0.0b1" - `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 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