Kubernetes Python Client:用 Python 操作 K8s 集群

Kubernetes Python Client 在 GitHub 上已经拿到 7,588 Star。

这是 Kubernetes 官方维护的 Python 客户端,用来在 Python 代码里调用 Kubernetes API。管理 Pod、Service、Deployment,查询集群状态,监听资源变化,都能通过它完成。

正文顶部截图

1、 这项目干嘛的

核心就干一件事:把 Kubernetes 的 REST API 包装成 Python 接口。你不用手写 HTTP 请求,不用自己处理认证和序列化,导入包、加载配置、调方法就行。

它支持同步和异步两种模式。同步代码用 kubernetes 模块,异步用 kubernetes.aio。两种模式接口基本一致,切换成本很低。

2、 基本用法

安装一行命令:

pip install kubernetes

列出所有 Pod:

from kubernetes import client, config

config.load_kube_config()
v1 = client.CoreV1Api()
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))

监听 Namespace 变化:

from kubernetes import client, config, watch

config.load_kube_config()
v1 = client.CoreV1Api()
w = watch.Watch()
for event in w.stream(v1.list_namespace, _request_timeout=60):
    print("Event: %s %s" % (event['type'], event['object'].metadata.name))

异步模式代码结构几乎一样:

import asyncio
from kubernetes.aio import client, config
from kubernetes.aio.client.api_client import ApiClient

async def main():
    await config.load_kube_config()
    async with ApiClient() as api:
        v1 = client.CoreV1Api(api)
        ret = await v1.list_pod_for_all_namespaces()
        for i in ret.items:
            print(i.status.pod_ip, i.metadata.namespace, i.metadata.name)

asyncio.run(main())

3、 版本兼容性

这个项目遵循语义化版本,客户端版本和 Kubernetes 集群版本有明确的对应关系。当前支持的版本从 client 9 到 client 36,覆盖了 Kubernetes 1.12 到 1.37。

README区域截图

维护策略和上游保持一致:同时支持三个 GA 大版本。版本选错不会导致代码崩溃,只是可能用不到新 API 或者遇到已移除的旧接口。

4、 适合谁用

  • 用 Python 写运维脚本、需要批量操作 K8s 资源的工程师
  • 在构建平台或工具链、需要程序化调用 Kubernetes API 的开发者
  • 做 CI/CD 流水线、需要在部署环节查询或修改集群状态的团队

这个项目代码生成自 OpenAPI 规范,API 覆盖度和上游保持同步。只要 Kubernetes 支持的操作,这里基本都能找到对应方法。

群状态的团队

这个项目代码生成自 OpenAPI 规范,API 覆盖度和上游保持同步。只要 Kubernetes 支持的操作,这里基本都能找到对应方法。

更多推荐