magnum/magnum/common/pythonk8sclient
houming-wang cfc01f4dc9 Fix typo error
Fix obvious typo errors existed in method comments.

Change-Id: Ib5f9a4fffec039bc933e4675ff7088fa33fb3e2d
2015-11-08 04:29:35 -05:00
..
client Fix typo error 2015-11-08 04:29:35 -05:00
swagger_client Make Kubernetes API call secure 2015-10-08 16:41:38 +09:00
templates Checkout generated k8s client 2015-09-08 11:24:51 -04:00
README.rst Update documentation for generating k8s v1 client 2015-09-13 16:12:07 -04:00
__init__.py Adding support of python-k8client. 2015-04-09 09:14:45 +00:00

README.rst

Kubernetes API client code

Overview

This is Kubernetes API python client code. This code is generated by swagger-codegen. Kubernetes provide swagger-spec to generate client code for different versions. The specs live in Kubernetes repo.

See also

Prerequisites

You need to install required packages for swagger codegen. Please refer to https://github.com/swagger-api/swagger-codegen#prerequisites

Steps to generate API client code

Steps to generate Kubernetes client code for v1:

  • Clone the Magnum repo:

    git clone https://github.com/openstack/magnum.git
* Clone the swagger-codegen repo. It is recommended to checkout a release

(e.g. v2.1.3) instead of using the master branch:

git clone https://github.com/swagger-api/swagger-codegen.git
cd swagger-codegen/
git checkout tags/v2.1.3
  • Build swagger-codegen:

    mvn package
  • Run below command to generate the API client code for Kubernetes:

    cd ..
    java -jar ./swagger-codegen/modules/swagger-codegen-cli/target/swagger-codegen-cli.jar \
        generate \
        -i ./magnum/magnum/common/pythonk8sclient/templates/v1.json \
        -l python -o ./KubernetesClientCode

Now you can check the code at location ./KubernetesClientCode.