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

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.

• client 9.y.z: Kubernetes 1.12 or below (+-), Kubernetes 1.13 (✓), Kubernetes 1.14 or above (+-)
• client 10.y.z: Kubernetes 1.13 or below (+-), Kubernetes 1.14 (✓), Kubernetes 1.14 or above (+-)
• client 11.y.z: Kubernetes 1.14 or below (+-), Kubernetes 1.15 (✓), Kubernetes 1.16 or above (+-)
• client 12.y.z: Kubernetes 1.15 or below (+-), Kubernetes 1.16 (✓), Kubernetes 1.17 or above (+-)
• client 17.y.z: Kubernetes 1.16 or below (+-), Kubernetes 1.17 (✓), Kubernetes 1.18 or above (+-)
• client 18.y.z: Kubernetes 1.17 or below (+-), Kubernetes 1.18 (✓), Kubernetes 1.19 or above (+-)
• client 19.y.z: Kubernetes 1.18 or below (+-), Kubernetes 1.19 (✓), Kubernetes 1.20 or above (+-)
• client 20.y.z: Kubernetes 1.19 or below (+-), Kubernetes 1.20 (✓), Kubernetes 1.21 or above (+-)
• client 21.y.z: Kubernetes 1.20 or below (+-), Kubernetes 1.21 (✓), Kubernetes 1.22 or above (+-)
• client 22.y.z: Kubernetes 1.21 or below (+-), Kubernetes 1.22 (✓), Kubernetes 1.23 or above (+-)
• client 23.y.z: Kubernetes 1.22 or below (+-), Kubernetes 1.23 (✓), Kubernetes 1.24 or above (+-)
• client 24.y.z: Kubernetes 1.23 or below (+-), Kubernetes 1.24 (✓), Kubernetes 1.25 or above (+-)
• client 25.y.z: Kubernetes 1.24 or below (+-), Kubernetes 1.25 (✓), Kubernetes 1.26 or above (+-)
• client 26.y.z: Kubernetes 1.25 or below (+-), Kubernetes 1.26 (✓), Kubernetes 1.27 or above (+-)
• client 27.y.z: Kubernetes 1.26 or below (+-), Kubernetes 1.27 (✓), Kubernetes 1.28 or above (+-)
• client 28.y.z: Kubernetes 1.27 or below (+-), Kubernetes 1.28 (✓), Kubernetes 1.29 or above (+-)
• client 29.y.z: Kubernetes 1.28 or below (+-), Kubernetes 1.29 (✓), Kubernetes 1.30 or above (+-)
• client 30.y.z: Kubernetes 1.29 or below (+-), Kubernetes 1.30 (✓), Kubernetes 1.31 or above (+-)
• client 31.y.z: Kubernetes 1.30 or below (+-), Kubernetes 1.31 (✓), Kubernetes 1.32 or above (+-)
• client 32.y.z: Kubernetes 1.31 or below (+-), Kubernetes 1.32 (✓), Kubernetes 1.33 or above (+-)
• client 33.y.z: Kubernetes 1.32 or below (+-), Kubernetes 1.33 (✓), Kubernetes 1.34 or above (+-)

Seehere for an explanation of why there is no v13-v16 release.

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 the Kubernetescluster, either due to that client-python has additional new API, or that the server hasremoved old API. However, everything they have in common (i.e., most APIs) will work.Please note that alpha APIs may vanish or change significantly in a single release.
• - The Kubernetes cluster has features the client-python library can't use, either dueto the server has additional new API, or that client-python has removed old API. However,everything they share in common (i.e., most APIs) will work.

See theCHANGELOG for a detailed description of changesbetween client-python versions.

Seehere for an explanation of why there is no v13-v16 release.

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.

Exception to the above support rule: Since we are running behind on releases, we will support Alpha/Beta releases for a greater number of clients until we catch up with the upstream version.

The client releases v12 and before following a versioning schema where the major version was 4 integer positions behind the Kubernetes minor on which the client is based on. For example, v12.0.0 is based on Kubernetes v1.16, v11.0.0 is based on Kubernetes v1.15 and so on.

This created a lot of confusion tracking two different version numbers for each client release. It was decided to homogenize the version scheme starting from the Kubernetes Python client based on Kubernetes v1.17. The versioning scheme of the client from this release would be vY.Z.P where Y and Z are the Kubernetes minor and patch release numbers from Kubernets v1.Y.Z and P is the client specific patch release numbers to accommodate changes and fixes done specifically to the client. For more details, referthis issue.

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, where this project falls under.

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

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

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

See more atexec example.

To enable debug logging in the Kubernetes Python client, follow these steps:

importlogging# Set the logging level to DEBUGlogging.basicConfig(level=logging.DEBUG)# To see the HTTP requests and responses sent to the Kubernetes API (for debugging network-related issues), configure the urllib3 logger:logging.getLogger("urllib3").setLevel(logging.DEBUG)

⬆ back to top