kubernetes-client/python


Official Python client library for kubernetes

http://kubernetes.io/

License: Apache-2.0

Language: Python

Keywords: client-python, k8s, k8s-sig-api-machinery, kubernetes, library


Kubernetes Python Client

Build Status PyPI version codecov pypi supported versions Client Capabilities Client Support Level

Python client for the kubernetes API.

Installation

From source:

git clone --recursive https://github.com/kubernetes-client/python.git
cd python
python setup.py install

From PyPi directly:

pip install kubernetes

Examples

list all pods:

from kubernetes import client, config

# Configs can be set in Configuration class directly or using helper utility
config.load_kube_config()

v1 = client.CoreV1Api()
print("Listing pods with their IPs:")
ret = v1.list_pod_for_all_namespaces(watch=False)
for i in ret.items:
    print("%s\t%s\t%s" % (i.status.pod_ip, i.metadata.namespace, i.metadata.name))

watch on namespace object:

from kubernetes import client, config, watch

# Configs can be set in Configuration class directly or using helper utility
config.load_kube_config()

v1 = client.CoreV1Api()
count = 10
w = watch.Watch()
for event in w.stream(v1.list_namespace, _request_timeout=60):
    print("Event: %s %s" % (event['type'], event['object'].metadata.name))
    count -= 1
    if not count:
        w.stop()

print("Ended.")

More examples can be found in examples folder. To run examples, run this command:

python -m examples.example1

(replace example1 with the example base filename)

Documentation

All APIs and Models' documentation can be found at the Generated client's README file

Compatibility

client-python follows semver, so until the major version of client-python gets increased, your code will continue to work with explicitly supported versions of Kubernetes clusters.

Compatibility matrix

Kubernetes 1.9 Kubernetes 1.10 Kubernetes 1.11 Kubernetes 1.12 Kubernetes 1.13 Kubernetes 1.14
client-python 5.0 - - - - -
client-python 6.0 + - - - -
client-python 7.0 + + - - -
client-python 8.0 + + + - -
client-python 9.0 + + + + -
client-python 10.0 + + + + +
client-python HEAD + + + + +

Key:

  • Exactly the same features / API objects in both client-python and the Kubernetes version.
  • + client-python has features or api objects that may not be present in the Kubernetes cluster, but everything they have in common will work.
  • - The Kubernetes cluster has features the client-python library can't use (additional API objects, etc).

See the CHANGELOG for a detailed description of changes between client-python versions.

Client version Canonical source for OpenAPI spec Maintenance status
5.0 Alpha/Beta Kubernetes main repo, 1.9 branch
5.0 Kubernetes main repo, 1.9 branch
6.0 Alpha/Beta Kubernetes main repo, 1.10 branch
6.0 Kubernetes main repo, 1.10 branch
7.0 Alpha/Beta Kubernetes main repo, 1.11 branch
7.0 Kubernetes main repo, 1.11 branch
8.0 Alpha/Beta Kubernetes main repo, 1.12 branch
8.0 Kubernetes main repo, 1.12 branch
9.0 Alpha/Beta Kubernetes main repo, 1.13 branch
9.0 Kubernetes main repo, 1.13 branch
10.0 Alpha/Beta Kubernetes main repo, 1.14 branch
10.0 Kubernetes main repo, 1.14 branch

Key:

  • Changes in main Kubernetes repo are manually (should be automated) published to client-python when they are available.
  • No longer maintained; please upgrade.

Kubernetes supports three minor releases at a time. "Support" means we expect users to be running that version in production, though we may not port fixes back before the latest minor version. For example, when v1.3 comes out, v1.0 will no longer be supported. In consistent with Kubernetes support policy, we expect to support three GA major releases (corresponding to three Kubernetes minor releases) at a time.

Note: There would be no maintenance for alpha/beta releases except the latest one.

Community, Support, Discussion

If you have any problem on using the package or any suggestions, please start with reaching the Kubernetes clients slack channel, or filing an issue to let us know. You can also reach the maintainers of this project at SIG API Machinery, where this project falls under.

Code of Conduct

Participation in the Kubernetes community is governed by the CNCF Code of Conduct.

Troubleshooting

SSLError on macOS

If you get an SSLError, you likely need to update your version of python. The version that ships with macOS may not be supported.

Install the latest version of python with brew:

brew install python

Once installed, you can query the version of OpenSSL like so:

python -c "import ssl; print ssl.OPENSSL_VERSION"

You'll need a version with OpenSSL version 1.0.0 or later.

Hostname doesn't match

If you get an ssl.CertificateError complaining about hostname match, your installed packages does not meet version requirements. Specifically check ipaddress and urllib3 package versions to make sure they met requirements in requirements.txt file.

Why Exec/Attach calls doesn't work

Starting from 4.0 release, we do not support directly calling exec or attach calls. you should use stream module to call them. so instead of resp = api.connect_get_namespaced_pod_exec(name, ... you should call resp = stream(api.connect_get_namespaced_pod_exec, name, .... See more at exec example.

Project Statistics

Sourcerank 16
Repository Size 13.6 MB
Stars 1,944
Forks 1,190
Watchers 82
Open issues 93
Dependencies 27
Contributors 59
Tags 40
Created
Last updated
Last pushed

Top Contributors See all

Mehdy Bohlool Haowei Cai (Roy) k8s-ci-robot Oz N Tiram Davanum Srinivas Yu Liao micw523 Konrad Djimeli Jingtian Peng Sergi Almacellas Abellana Ebbe Elsborg scottilee Aaron Crickenberger Charles Walker Johannes Scheuermann Tomasz Prus Jeff Schroeder sebgoa Haiker Sun BoySherman

Packages Referencing this Repo

kubernetes
Kubernetes python client
Latest release 11.0.0a1 - Updated - 1.94K stars
kubernetes-redjohn
Kubernetes python client
Latest release 9.0.0.post61819 - Published - 1.94K stars
kubernetes-async-patch
Kubernetes python client
Latest release 4.0.1 - Published - 1.94K stars
kubernetes-ws-patch
Kubernetes python client
Latest release 2.0.99 - Published - 1.94K stars

Recent Tags See all

v8.0.2 July 30, 2019
v9.0.1 July 30, 2019
v10.0.1 July 30, 2019
v10.0.0 July 02, 2019
v10.0.0a1 April 04, 2019
v9.0.0 March 19, 2019
v9.0.0b1 February 08, 2019
v9.0.0a1 December 28, 2018
v7.0.1 December 28, 2018
v8.0.1 December 27, 2018
v6.1.0 November 08, 2018
v8.0.0 November 02, 2018
v8.0.0b1 October 16, 2018
v8.0.0a1 October 02, 2018
v7.0.0 August 16, 2018

Something wrong with this page? Make a suggestion

Last synced: 2019-09-11 21:39:53 UTC

Login to resync this repository