Skip to content

bobhenkel/client-python

Repository files navigation

Kubernetes Python Client

Build StatusPyPI versioncodecovpypi supported versionsClient CapabilitiesClient Support Level

Python client for the kubernetes API.

Installation

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 

Example

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

Community, Support, Discussion

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.

Code of Conduct

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

Kubernetes Incubator

This is a Kubernetes Incubator project.

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.

About

Official Python client library for kubernetes

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python99.9%
  • Shell0.1%