Repository files navigation

Python client for thekubernetes API.

From source:

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

FromPyPi directly:

pip install kubernetes

list all pods:

fromkubernetesimportclient,config# Configs can be set in Configuration class directly or using helper utilityconfig.load_kube_config()v1=client.CoreV1Api()print("Listing pods with their IPs:")ret=v1.list_pod_for_all_namespaces(watch=False)foriinret.items:print("%s\t%s\t%s"% (i.status.pod_ip,i.metadata.namespace,i.metadata.name))

watch on namespace object:

fromkubernetesimportclient,config,watch# Configs can be set in Configuration class directly or using helper utilityconfig.load_kube_config()v1=client.CoreV1Api()count=10w=watch.Watch()foreventinw.stream(v1.list_namespace,_request_timeout=60):print("Event: %s %s"% (event['type'],event['object'].metadata.name))count-=1ifnotcount:w.stop()print("Ended.")

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

python -m examples.example1

(replace example1 with the example base filename)

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

client-python followssemver, so until the major version ofclient-python gets increased, your code will continue to work with explicitlysupported versions of Kubernetes clusters.

Key:

• ✓ Exactly the same features / API objects in both client-python and the Kubernetesversion.
• + client-python has features or api objects that may not be present in theKubernetes 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 theCHANGELOG for a detailed description of changesbetween client-python versions.

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 supportsthree 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 supportthree 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.

If you have any problem on using the package or any suggestions, please start with reaching theKubernetes clients slack channel, or filing anissue to let us know. You can also reach the maintainers of this project atSIG API Machinery.

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

This is aKubernetes Incubator project.

• SIG: sig-api-machinery

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

Install the latest version of python withbrew:

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.

If you get anssl.CertificateError complaining about hostname match, your installed packages does not meet versionrequirements.Specifically checkipaddress andurllib3 package versions to make sure they met requirements inrequirements.txt file.

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