python如何获取k8s数据信息

Python可以通过使用Kubernetes官方提供的客户端库、直接调用Kubernetes API、使用第三方工具等方式来获取Kubernetes（k8s）数据信息。其中，官方提供的Python客户端库是最常用和推荐的方式，因为它集成度高、功能全面、使用便捷。具体操作步骤包括安装库、配置访问权限、使用API接口获取所需数据。例如，安装kubernetes库后，通过config.load_kube_config()加载配置文件，接着使用client.CoreV1Api()等接口来获取节点、Pods、服务等信息。这种方法既能确保数据获取的准确性，也能大大简化开发工作，提高效率。

一、安装并配置Kubernetes客户端库

首先需要安装Kubernetes Python客户端库。这可以通过pip来完成，命令如下：

pip install kubernetes

安装完成后，需要配置客户端以便与Kubernetes集群进行通信。通常可以通过kubeconfig文件来进行配置。kubeconfig文件通常位于~/.kube/config路径下。可以通过以下代码加载该配置文件：

from kubernetes import client, config
加载kubeconfig文件
config.load_kube_config()

在容器化环境中，可以使用config.load_incluster_config()来加载配置。

二、获取节点信息

加载配置文件后，可以创建Kubernetes API客户端来获取节点信息。以下是一个示例代码：

from kubernetes import client, config
加载kubeconfig文件
config.load_kube_config()
创建API客户端
v1 = client.CoreV1Api()
获取所有节点信息
nodes = v1.list_node()
for node in nodes.items:
    print(f"Node Name: {node.metadata.name}")
    print(f"Node Status: {node.status.conditions[-1].type}")
    print(f"Node Addresses: {[addr.address for addr in node.status.addresses]}")
    print()

这个代码将输出集群中所有节点的名称、状态以及地址信息。

三、获取Pods信息

类似地，可以使用API客户端来获取Pods的信息。以下是获取所有Pods信息的示例代码：

from kubernetes import client, config
加载kubeconfig文件
config.load_kube_config()
创建API客户端
v1 = client.CoreV1Api()
获取所有Pods信息
pods = v1.list_pod_for_all_namespaces()
for pod in pods.items:
    print(f"Pod Name: {pod.metadata.name}")
    print(f"Namespace: {pod.metadata.namespace}")
    print(f"Node Name: {pod.spec.node_name}")
    print(f"Pod Status: {pod.status.phase}")
    print()

这个代码将输出所有命名空间中的Pods的名称、所属命名空间、所在节点以及状态信息。

四、获取服务信息

同样，可以使用API客户端来获取服务的信息。以下是获取所有服务信息的示例代码：

from kubernetes import client, config
加载kubeconfig文件
config.load_kube_config()
创建API客户端
v1 = client.CoreV1Api()
获取所有服务信息
services = v1.list_service_for_all_namespaces()
for service in services.items:
    print(f"Service Name: {service.metadata.name}")
    print(f"Namespace: {service.metadata.namespace}")
    print(f"Service Type: {service.spec.type}")
    print(f"Cluster IP: {service.spec.cluster_ip}")
    print(f"Ports: {[port.port for port in service.spec.ports]}")
    print()

这个代码将输出所有命名空间中的服务的名称、所属命名空间、服务类型、集群IP以及端口信息。

五、获取部署信息

要获取部署（Deployment）信息，可以使用AppsV1Api客户端。以下是获取所有部署信息的示例代码：

from kubernetes import client, config
加载kubeconfig文件
config.load_kube_config()
创建API客户端
apps_v1 = client.AppsV1Api()
获取所有部署信息
deployments = apps_v1.list_deployment_for_all_namespaces()
for deployment in deployments.items:
    print(f"Deployment Name: {deployment.metadata.name}")
    print(f"Namespace: {deployment.metadata.namespace}")
    print(f"Replicas: {deployment.spec.replicas}")
    print(f"Available Replicas: {deployment.status.available_replicas}")
    print()

这个代码将输出所有命名空间中的部署的名称、所属命名空间、期望副本数以及可用副本数。

六、监控资源变化

Kubernetes Python客户端还提供了监控资源变化的功能。可以使用watch模块来实现。以下是一个监控Pods变化的示例代码：

from kubernetes import client, config, watch
加载kubeconfig文件
config.load_kube_config()
创建API客户端
v1 = client.CoreV1Api()
创建watch对象
w = watch.Watch()
监控Pods变化
for event in w.stream(v1.list_pod_for_all_namespaces):
    pod = event['object']
    event_type = event['type']
    print(f"Event Type: {event_type}")
    print(f"Pod Name: {pod.metadata.name}")
    print(f"Namespace: {pod.metadata.namespace}")
    print(f"Pod Status: {pod.status.phase}")
    print()

这个代码将输出所有命名空间中的Pods的变化事件，包括事件类型（添加、更新、删除）、Pods名称、所属命名空间以及状态信息。

七、处理权限问题

在实际使用中，可能会遇到权限问题。这时需要确保Kubernetes集群中的角色绑定（RoleBinding）和集群角色绑定（ClusterRoleBinding）配置正确。例如，如果你在集群中运行一个Pod并希望它能够获取集群信息，需要为该Pod配置适当的服务账户和角色绑定。

可以通过以下YAML文件创建一个具有读取权限的服务账户和角色绑定：

apiVersion: v1 kind: ServiceAccount metadata: name: read-only-sa namespace: default --- apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRole metadata: name: read-only rules: - apiGroups: [""] resources: ["pods", "services", "nodes"] verbs: ["get", "list", "watch"] --- apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRoleBinding metadata: name: read-only-binding roleRef: apiGroup: rbac.authorization.k8s.io kind: ClusterRole name: read-only subjects: - kind: ServiceAccount name: read-only-sa namespace: default

这个YAML文件创建了一个名为read-only-sa的服务账户，一个名为read-only的集群角色，以及一个将该角色绑定到服务账户的集群角色绑定。

八、处理Kubernetes中的事件

可以通过API客户端获取Kubernetes中的事件信息。这些事件通常用于调试和监控。以下是获取所有命名空间中的事件信息的示例代码：

from kubernetes import client, config
加载kubeconfig文件
config.load_kube_config()
创建API客户端
v1 = client.CoreV1Api()
获取所有事件信息
events = v1.list_event_for_all_namespaces()
for event in events.items:
    print(f"Event Type: {event.type}")
    print(f"Event Reason: {event.reason}")
    print(f"Event Message: {event.message}")
    print(f"Event Source: {event.source.component}")
    print()

这个代码将输出所有命名空间中的事件的类型、原因、消息以及事件来源。

九、与其他工具结合使用

除了直接使用Kubernetes Python客户端库，还可以结合其他工具来获取和处理Kubernetes数据信息。例如，可以使用Prometheus来监控Kubernetes集群，并通过Prometheus的API获取监控数据。此外，还可以使用Grafana来可视化监控数据。

以下是一个通过Prometheus API获取Kubernetes集群中Pods CPU使用率的示例代码：

import requests
Prometheus API地址
prometheus_url = 'http://prometheus-server/api/v1/query'
查询Kubernetes集群中Pods CPU使用率
query = 'sum(rate(container_cpu_usage_seconds_total{image!=""}[5m])) by (pod, namespace)'
response = requests.get(prometheus_url, params={'query': query})
result = response.json()
for pod in result['data']['result']:
    print(f"Pod: {pod['metric']['pod']}")
    print(f"Namespace: {pod['metric']['namespace']}")
    print(f"CPU Usage: {pod['value'][1]}")
    print()

这个代码将输出Kubernetes集群中所有Pods的CPU使用率信息。

十、总结

通过使用Kubernetes官方提供的Python客户端库，可以方便地获取Kubernetes集群中的各种数据信息，包括节点、Pods、服务、部署、事件等。使用该库的主要步骤包括安装库、加载配置、创建API客户端以及调用相应的API接口获取数据。此外，还可以结合其他工具如Prometheus和Grafana进行监控和可视化。无论是在本地开发环境还是在生产环境中，使用Python客户端库都能大大简化与Kubernetes集群的交互，提高开发效率和运维管理水平。

相关问答FAQs：

列出所有命名空间中的Pods。

获取集群的Deployment信息

Deployments用于管理Pod的副本和更新策略。以下是获取集群中所有Deployments信息的代码：

from kubernetes import client, config

# 加载Kubeconfig文件
config.load_kube_config()

# 创建API客户端
apps_v1 = client.AppsV1Api()

# 获取所有Deployments的信息
deployments = apps_v1.list_deployment_for_all_namespaces(watch=False)
for deployment in deployments.items:
    print(f"Namespace: {deployment.metadata.namespace}")
    print(f"Deployment Name: {deployment.metadata.name}")
    print(f"Replicas: {deployment.spec.replicas}")
    print("-----")

该代码创建了一个AppsV1Api实例，用于获取Deployment的信息，并打印相关细节。

获取集群的Service信息

Services提供了对Pod的访问能力，以下代码可以用来获取集群中的所有Service信息：

from kubernetes import client, config

# 加载Kubeconfig文件
config.load_kube_config()

# 创建API客户端
v1 = client.CoreV1Api()

# 获取所有Services的信息
services = v1.list_service_for_all_namespaces(watch=False)
for service in services.items:
    print(f"Namespace: {service.metadata.namespace}")
    print(f"Service Name: {service.metadata.name}")
    print("-----")

获取集群的ConfigMap和Secret信息

ConfigMaps和Secrets用于存储配置信息和敏感数据。以下代码演示了如何获取ConfigMap和Secret的信息：

from kubernetes import client, config

# 加载Kubeconfig文件
config.load_kube_config()

# 创建API客户端
v1 = client.CoreV1Api()

# 获取所有ConfigMaps的信息
configmaps = v1.list_config_map_for_all_namespaces(watch=False)
for configmap in configmaps.items:
    print(f"Namespace: {configmap.metadata.namespace}")
    print(f"ConfigMap Name: {configmap.metadata.name}")
    print("-----")

# 获取所有Secrets的信息
secrets = v1.list_secret_for_all_namespaces(watch=False)
for secret in secrets.items:
    print(f"Namespace: {secret.metadata.namespace}")
    print(f"Secret Name: {secret.metadata.name}")
    print("-----")

通过上述代码，您可以获取Kubernetes集群中各种资源的详细信息。掌握这些信息有助于更好地管理和监控您的集群。

关于 GitLab 的更多内容，可以查看官网文档：
官网地址： https://gitlab.cn
文档地址： https://docs.gitlab.cn
论坛地址： https://forum.gitlab.cn

原创文章，作者：jihu002，如若转载，请注明出处：https://devops.gitlab.cn/archives/46628