Python client for the kubernetes API.
From source:
git clone https://github.com/kubernetes-incubator/client-python.git
cd client-python
python setup.py install
From PyPi directly:
pip install kubernetes
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)
All APIs and Models' documentation can be found at the Generated client's README file
You can reach the maintainers of this project at SIG API Machinery. If you have any problem with the package or any suggestions, please file an issue.
Participation in the Kubernetes community is governed by the CNCF Code of Conduct.
This is a Kubernetes Incubator project.
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.
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.