Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomplus/kubernetes_asyncio
Python asynchronous client library for Kubernetes http://kubernetes.io/
https://github.com/tomplus/kubernetes_asyncio
aio aiohttp async asynchronous asyncio kubernetes python
Last synced: about 1 month ago
JSON representation
Python asynchronous client library for Kubernetes http://kubernetes.io/
- Host: GitHub
- URL: https://github.com/tomplus/kubernetes_asyncio
- Owner: tomplus
- License: apache-2.0
- Created: 2018-04-07T23:55:49.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-31T22:11:04.000Z (about 1 month ago)
- Last Synced: 2024-08-01T07:56:22.848Z (about 1 month ago)
- Topics: aio, aiohttp, async, asynchronous, asyncio, kubernetes, python
- Language: Python
- Homepage:
- Size: 13.9 MB
- Stars: 342
- Watchers: 7
- Forks: 70
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-asyncio - kubernetes_asyncio - Asynchronous client library for Kubernetes. (Misc)
README
# Kubernetes Python Client
[](https://badge.fury.io/py/kubernetes_asyncio)
[](https://kubernetes-asyncio.readthedocs.io/)
[](https://codecov.io/gh/tomplus/kubernetes_asyncio)
[](https://pypi.python.org/pypi/kubernetes_asyncio)
[](http://bit.ly/kubernetes-client-capabilities-badge)
[](http://bit.ly/kubernetes-client-support-badge)
Asynchronous (AsyncIO) client library for the [Kubernetes](http://kubernetes.io/) API.
This library is created in the same way as official https://github.com/kubernetes-client/python but
uses asynchronous version of [OpenAPI generator](https://github.com/openapitools/openapi-generator).
My motivation is described here: https://github.com/kubernetes-client/python/pull/324
## Installation
From [PyPi](https://pypi.python.org/pypi/kubernetes_asyncio/) directly:
```
pip install kubernetes_asyncio
```
It requires Python 3.6+
## Example
To list all pods:
```python
import asyncio
from kubernetes_asyncio import client, config
from kubernetes_asyncio.client.api_client import ApiClient
async def main():
# Configs can be set in Configuration class directly or using helper
# utility. If no argument provided, the config will be loaded from
# default location.
await config.load_kube_config()
# use the context manager to close http sessions automatically
async with ApiClient() as api:
v1 = client.CoreV1Api(api)
print("Listing pods with their IPs:")
ret = await v1.list_pod_for_all_namespaces()
for i in ret.items:
print(i.status.pod_ip, i.metadata.namespace, i.metadata.name)
if __name__ == '__main__':
loop = asyncio.get_event_loop()
loop.run_until_complete(main())
loop.close()
```
More complicated examples, like asynchronous multiple watch or tail logs from pods,
you can find in `examples/` folder.
## Documentation
https://kubernetes-asyncio.readthedocs.io/
## Compatibility
This library is generated in the same way as the official Kubernetes Python Library. It uses swagger-codegen and the same concepts
like streaming, watching or reading configuration. Because of an early stage of this library some differences still exist:
| | [synchronous library kubernetes-client/python](https://github.com/kubernetes-client/python) | [this library](https://github.com/tomplus/kubernetes_asyncio/) |
|--|--------------------------------------------------------------------|---------------------------------------------------------------|
| authentication method | gcp-token, azure-token, user-token, oidc-token, user-password, in-cluster | gcp-token (only via gcloud command), user-token, oidc-token, user-password, in-cluster |
| streaming data via websocket from PODs | bidirectional | read-only is already implemented |
### Microsoft Windows
In case this library is used against Kubernetes cluster using [client-go credentials plugin](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#client-go-credential-plugins), the default asyncio event loop is [SelectorEventLoop](https://docs.python.org/3/library/asyncio-eventloop.html#event-loop-implementations). This event loop selector, however, does NOT support [pipes and subprocesses](https://bugs.python.org/issue37373), so `exec_provider.py::ExecProvider` is failing. In order to avoid failures the [ProactorEventLoop](https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.ProactorEventLoop) has to be selected. The ProactorEventLoop can be enabled via [WindowsProactorEventLoopPolicy](https://docs.python.org/3/library/asyncio-policy.html#asyncio.WindowsProactorEventLoopPolicy).
Application's code needs to contain following code:
```python
import asyncio
asyncio.set_event_loop_policy(
asyncio.WindowsProactorEventLoopPolicy()
)
```
## Versions
This library is versioned in the same way as the synchronous library.
The schema version has been changed with version v18.20.0. Now, first
two numbers from version are Kubernetes version (v.1.18.20). The last
number is for changes in the library not directly connected with K8s.
## Development
Install the development packages:
```bash
pip install -r requirements.txt
pip install -r test-requirements.txt
```
You can run the style checks and tests with
```bash
flake8 kubernetes_asyncio/
isort --diff kubernetes_asyncio/
py.test
```