使用 Django 构建支持 Kubernetes API 测试连接的 POST 接口

XMYX-02024-11-27 18:22

文章目录

使用 Django 构建支持 Kubernetes API 测试连接的 POST 接口

在 Kubernetes 集群运维和开发中，验证集群的连通性和资源访问权限是常见需求。本文将以 Django 框架为基础，构建一个只支持 POST 请求的接口，用于测试 Kubernetes 集群连接并获取默认命名空间中的 Pod 列表。

功能需求

  • 用户通过 HTTP 接口传递 Kubernetes API 地址、Token 和端口。
  • 系统验证请求参数的完整性并测试 Kubernetes 集群的连通性。
  • 返回默认命名空间的 Pod 列表或具体的错误信息。
  • 限制接口仅支持 POST 请求。

使用 kubectl 获取 Token

在 Kubernetes 中，Token 通常存储在 Secret 资源中，并且用于访问集群的 API。以下命令可以帮助您获取 Kubernetes 系统命名空间中的 Token：

bash 复制代码 
kubectl -n kube-system describe $(kubectl -n kube-system get secret -n kube-system -o name | grep namespace) | grep token

命令解析

  1. kubectl -n kube-system get secret -n kube-system -o name: 该命令列出 kube-system 命名空间中的所有 Secret 资源，并只输出 Secret 的名字。
  2. grep namespace: 过滤出包含 namespace 字符串的 Secret 名称。通常，集群的服务账户 Token 存储在名为 namespace-xxxxx 的 Secret 中。
  3. kubectl -n kube-system describe <secret_name>: 通过 describe 命令获取该 Secret 的详细信息。
  4. grep token: 从 Secret 的详细信息中提取包含 Token 的部分。

输出示例

该命令会输出类似于以下内容的 Token：

text 复制代码 
token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

完整代码实现

以下代码基于 Python 和 Django 框架，分为 Kubernetes API 客户端类、接口视图函数以及路由配置三部分。

Kubernetes API 客户端类

我们定义了一个 KubernetesClient 类，封装与 Kubernetes API 的交互逻辑。

python 复制代码 
from kubernetes import client

class KubernetesClient:
    def __init__(self, host, token):
        """
        初始化 Kubernetes API 客户端
        """
        # 配置 Kubernetes API 客户端
        k8s_config = client.Configuration()
        k8s_config.host = host
        k8s_config.verify_ssl = False  # 禁用 SSL 验证（仅测试环境使用）
        k8s_config.api_key = {"authorization": "Bearer " + token}
        client.Configuration.set_default(k8s_config)

        # 初始化核心和应用 API
        self.k8s_core_v1 = client.CoreV1Api()

    def get_pods(self, namespace="default"):
        """
        获取指定命名空间中的 Pod 列表
        """
        try:
            pods = self.k8s_core_v1.list_namespaced_pod(namespace=namespace)
            return [pod.metadata.name for pod in pods.items]
        except client.ApiException as e:
            raise Exception(f"获取 Pod 列表失败：{e}")

功能说明

  • 初始化时配置 Kubernetes API 地址和认证 Token。
  • get_pods 方法通过 list_namespaced_pod 获取 Pod 列表并返回 Pod 名称。

Django 接口视图

在 Django 中，我们通过视图函数实现接口逻辑，并限制只支持 POST 请求。

python 复制代码 
from django.http import JsonResponse
import json

def test_join(request):
    """
    测试 Kubernetes 集群的连接
    """
    # 检查请求方法是否为 POST
    if request.method != "POST":
        return JsonResponse({"code": 405, "message": "仅支持 POST 请求"})

    # 提取请求参数
    try:
        body = json.loads(request.body)
        ipaddr = body.get("ipaddr")
        token = body.get("secret_key")
        port = body.get("port")
        if not all([ipaddr, token, port]):
            return JsonResponse({"code": 400, "message": "请输入正确的参数"})
    except json.JSONDecodeError:
        return JsonResponse({"code": 400, "message": "请求数据格式错误"})

    # 构造 Kubernetes API 地址
    host = f"https://{ipaddr}:{port}"
    try:
        # 初始化 Kubernetes 客户端
        kube_client = KubernetesClient(host, token)
        pods = kube_client.get_pods()
        return JsonResponse({"code": 200, "message": "连接成功", "data": pods})
    except Exception as e:
        return JsonResponse({"code": 400, "message": f"连接失败: {str(e)}"})

关键点解析

  1. 请求方法限制 :
    • 使用 request.method 检查请求类型，如果不是 POST 返回 HTTP 405 状态码。
  2. 参数验证 :
    • 从请求体中解析 ipaddr、token 和 port，确保参数完整且格式正确。
  3. 连接测试 :
    • 通过 KubernetesClient 测试连接并获取默认命名空间中的 Pod 列表。
  4. 错误处理 :
    • 捕获参数错误、Kubernetes API 异常等，并返回详细的错误信息。

路由配置

将视图函数绑定到路由，使其可以通过 HTTP 调用：

python 复制代码 
from django.urls import path
from .views import test_join

urlpatterns = [
    path('join_test/', test_join),
]

接口测试

以下是测试接口的示例。

请求示例

使用 curl 工具发送 POST 请求：

bash 复制代码 
curl -X POST http://127.0.0.1:8000/join_test/ \
-H "Content-Type: application/json" \
-d '{
  "ipaddr": "192.168.1.10",
  "secret_key": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "port": 6443
}'

响应结果

成功

如果连接成功并获取到 Pod 列表，返回如下结果：

json 复制代码 
{
  "code": 200,
  "message": "连接成功",
  "data": ["nginx-deployment-7c77f6df69-8wmdt", "redis-pod"]
}

错误

  • 非 POST 请求：

    json 复制代码 
    {
  "code": 405,
  "message": "仅支持 POST 请求"
}

  • 参数缺失：

    json 复制代码 
    {
  "code": 400,
  "message": "请输入正确的参数"
}

  • 集群认证失败：

    json 复制代码 
    {
  "code": 400,
  "message": "连接失败: Unauthorized"
}

优化建议

1. 安全性

  • 启用 SSL 验证：将 verify_ssl 设置为 True，并配置证书路径。
  • 使用环境变量管理敏感信息（如 Token）。

2. 错误处理

  • 针对不同异常返回精确的错误码（如认证失败返回 401，资源未找到返回 404）。

3. 扩展返回数据

在返回的 Pod 列表中附加更多信息，例如 Pod 的状态、节点信息等：

python 复制代码 
return [{
    "name": pod.metadata.name,
    "status": pod.status.phase,
    "node": pod.spec.node_name
} for pod in pods.items]

完整代码示例

以下是完整的代码示例，包括 Kubernetes API 客户端类、Django 视图函数和路由配置，确保能够实现测试 Kubernetes 集群连接并返回 Pod 列表的功能：

Kubernetes API 客户端类

python 复制代码 
from kubernetes import client

class KubernetesClient:
    def __init__(self, host, token):
        """
        初始化 Kubernetes API 客户端
        """
        # 配置 Kubernetes API 客户端
        k8s_config = client.Configuration()
        k8s_config.host = host
        k8s_config.verify_ssl = False  # 禁用 SSL 验证（仅测试环境使用）
        k8s_config.api_key = {"authorization": "Bearer " + token}
        client.Configuration.set_default(k8s_config)

        # 初始化核心和应用 API
        self.k8s_core_v1 = client.CoreV1Api()

    def get_pods(self, namespace="default"):
        """
        获取指定命名空间中的 Pod 列表
        """
        try:
            pods = self.k8s_core_v1.list_namespaced_pod(namespace=namespace)
            return [pod.metadata.name for pod in pods.items]
        except client.ApiException as e:
            raise Exception(f"获取 Pod 列表失败：{e}")

Django 接口视图

python 复制代码 
from django.http import JsonResponse
import json
from .kubernetes_client import KubernetesClient

def test_join(request):
    """
    测试 Kubernetes 集群的连接
    """
    # 检查请求方法是否为 POST
    if request.method != "POST":
        return JsonResponse({"code": 405, "message": "仅支持 POST 请求"}, status=405)

    # 提取请求参数
    try:
        body = json.loads(request.body)
        ipaddr = body.get("ipaddr")
        token = body.get("secret_key")
        port = body.get("port")
        if not all([ipaddr, token, port]):
            return JsonResponse({"code": 400, "message": "请输入正确的参数"})
    except json.JSONDecodeError:
        return JsonResponse({"code": 400, "message": "请求数据格式错误"})

    # 构造 Kubernetes API 地址
    host = f"https://{ipaddr}:{port}"
    try:
        # 初始化 Kubernetes 客户端
        kube_client = KubernetesClient(host, token)
        pods = kube_client.get_pods()
        return JsonResponse({"code": 200, "message": "连接成功", "data": pods})
    except Exception as e:
        return JsonResponse({"code": 400, "message": f"连接失败: {str(e)}"})

路由配置

python 复制代码 
from django.urls import path
from .views import test_join

urlpatterns = [
    path('join_test/', test_join),
]

完整代码说明

  1. KubernetesClient 类:

    • KubernetesClient 类封装了与 Kubernetes 集群的连接和交互，特别是获取 Pod 列表的功能。
    • get_pods 方法通过 Kubernetes API 获取指定命名空间中的 Pod 列表。

  2. test_join 视图函数:

    • 视图函数仅支持 POST 请求，使用 request.method 检查请求类型。
    • 提取请求体中的 ipaddr、secret_key 和 port 参数，确保这些参数完整且正确。
    • 使用 KubernetesClient 测试 Kubernetes 集群连接并返回 Pod 列表。

  3. 路由配置:

    • 配置了路由，使得用户可以通过 POST 请求访问 /join_test/ 路径进行集群连接测试。

总结

本文详细介绍了如何通过 Django 构建一个只支持 POST 请求的接口，用于测试 Kubernetes 集群连接和获取 Pod 列表。通过请求方法限制、参数验证和异常处理，该接口在功能性和安全性上都有较好的保障。希望对您有所帮助！

相关推荐
费弗里44 分钟前
Python全栈应用开发利器Dash 3.x新版本介绍（1）
python·dash
李少兄9 天前
解决OSS存储桶未创建导致的XML错误
xml·开发语言·python
就叫飞六吧9 天前
基于keepalived、vip实现高可用nginx （centos）
python·nginx·centos
Vertira9 天前
PyTorch中的permute, transpose, view, reshape和flatten函数详解(已解决)
人工智能·pytorch·python
学Linux的语莫9 天前
python基础语法
开发语言·python
退役小学生呀9 天前
三、kubectl使用详解
云原生·容器·kubernetes·k8s
匿名的魔术师9 天前
实验问题记录：PyTorch Tensor 也会出现 a = b 赋值后，修改 a 会影响 b 的情况
人工智能·pytorch·python
Ven%9 天前
PyTorch 张量（Tensors）全面指南：从基础到实战
人工智能·pytorch·python
mahuifa9 天前
PySide环境配置及工具使用
python·qt·环境配置·开发经验·pyside
大熊猫侯佩9 天前
ruby、Python 以及 Swift 语言关于 “Finally” 实现的趣谈
python·ruby·swift
热门推荐
01鸽了六年的某大厂面试题：你会手写一个模板引擎吗？02扣子（coze）实战|我用扣子搭建了一个自动分析小红薯笔记内容的AI应用|详细步骤拆解03KGG转MP3工具|非KGM文件|解密音频04《C#图解教程 第5版》深度推荐05Coze扣子平台完整体验和实践（附国内和国际版对比）06从零安装 LLaMA-Factory 微调 Qwen 大模型成功及所有的坑07零代码入门 | Coze——让大模型接入自己的数据库08DeepSeek各版本说明与优缺点分析09YOLOv8入门 | 重要性能衡量指标、训练结果评价及分析及影响mAP的因素【发论文关注的指标】10GPU 进阶笔记（二）：华为昇腾 910B GPU