Skip to content

Commit 1625a8d

Browse files
committed
Remove outdated compatibility section from readme
1 parent c1a69be commit 1625a8d

1 file changed

Lines changed: 3 additions & 12 deletions

File tree

README.md

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
Asynchronous (AsyncIO) client library for the [Kubernetes](http://kubernetes.io/) API.
1212

13-
This library is created in the same way as official https://github.com/kubernetes-client/python but
13+
This library is created in the same way as the official https://github.com/kubernetes-client/python but
1414
uses asynchronous version of [OpenAPI generator](https://github.com/openapitools/openapi-generator).
1515
My motivation is described here: https://github.com/kubernetes-client/python/pull/324
1616

@@ -55,22 +55,13 @@ if __name__ == '__main__':
5555
asyncio.run(main())
5656
```
5757

58-
More complicated examples, like asynchronous multiple watch or tail logs from pods,
59-
you can find in `examples/` folder.
58+
More examples, including asynchronous multiple watch or tailing logs from pods,
59+
can be found in `examples/` folder.
6060

6161
## Documentation
6262

6363
https://kubernetes-asyncio.readthedocs.io/
6464

65-
## Compatibility
66-
67-
This library is generated in the same way as the official Kubernetes Python Library. It uses swagger-codegen and the same concepts
68-
like streaming, watching or reading configuration. Because of an early stage of this library some differences still exist:
69-
70-
| | [synchronous library kubernetes-client/python](https://github.com/kubernetes-client/python) | [this library](https://github.com/tomplus/kubernetes_asyncio/) |
71-
|--|--------------------------------------------------------------------|---------------------------------------------------------------|
72-
| 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 |
73-
| streaming data via websocket from PODs | bidirectional | read-only is already implemented |
7465

7566
### Microsoft Windows
7667
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).

0 commit comments

Comments
 (0)