在 python 客户端中关闭与 kube.netes API 服务器的客户端连接

Question

I am using kube.netes-client library in python and looking at the various examples , it appears we don't need to explicitly close the client connection to the API server. Does the client connection gets terminated automatically or are the examples missing the call to close the connection? I also found the docs page for the APIs ( AppsV1 for example) and the examples shown there use context manager for the calls so the connection gets disconnected automatically there but I still have questions for the scripts that don't use the context manager approach.

Answer 1

Kube.netes's API is HTTP-based, so you can often get away without explicitly closing a connection. If you have a short script, things should get cleaned up automatically at the end of the script and it's okay to not explicitly close things.

The specific documentation page you link to shows a safe way to do it:

with kubernetes.client.ApiClient(configuration) as api_client:
    api_instance = kubernetes.client.AppsV1Api(api_client)
    api_instance.create_namespaced_controller_revision(...)

The per-API-version client object is stateless if you pass in an ApiClient to its constructor, so it's safe to create these objects as needed.

The ApiClient class includes an explicit close method, so you could also do this (less safely) without the context-manager syntax:

api_client = kubernetes.client.ApiClient(configuration)
apps_client = kubernetes.client.AppsV1Api(api_client)
...
api_client.close()

The library client front-page README suggests a path that doesn't explicitly create an ApiClient . Looking at one of the generated models' code , if you don't pass an ApiClient option explicitly, a new one will be created for each API-version client object; that includes a connection pool as well. That can leak local memory and cause extra connections to the cluster, but this might not matter to you for small scripts.