Kubernetes Python Client

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 one of the filenames in the examples folder)

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, ....

Using Stream will overwrite the requests protocol in core_v1_api.CoreV1Api() This will cause a failure in non-exec/attach calls. If you reuse your api client object, you will need to recreate it between api calls that use stream and other api calls.

See more at exec example.