antrea/antrea-ui-backend

Antrea UI 后端 Docker 镜像文档

1. 镜像概述和主要用途

antrea/antrea-ui-backend 是 Antrea UI 的后端实现（API 服务器）Docker 镜像。该镜像作为 Antrea UI 的核心后端组件，负责处理前端请求、与 Antrea CNI 组件及 Kubernetes API 交互，提供数据接口以支撑 Web 用户界面功能。其主要用途是配合 antrea/antrea-ui-frontend 前端镜像，共同为 Antrea CNI 提供完整的 Web 管理界面。

2. 核心功能和特性

2.1 核心功能

• Antrea 组件运行时信息展示：提供 Antrea CNI 核心组件（如 antrea-agent、antrea-controller 等）的实时运行状态、配置信息及关键指标数据。
• Traceflow 请求处理：提供 Traceflow 网络路径跟踪功能的后端接口，支持通过 Web 界面发起网络跟踪请求并返回结果。

2.2 特性

• 轻量级 API 服务，专注于数据交互与业务逻辑处理；
• 与 Antrea CNI 深度集成，原生支持 Antrea 网络模型的数据采集与解析；
• 模块化架构设计，支持未来功能扩展。

3. 使用场景和适用范围

3.1 使用场景

• 部署于采用 Antrea 作为 CNI 插件的 Kubernetes 集群，与 antrea/antrea-ui-frontend 配合提供完整 Web 管理界面；
• 供集群管理员通过图形界面监控 Antrea 网络状态、诊断网络连通性问题（如通过 Traceflow）；
• 作为 Antrea 生态可视化工具，简化 Antrea 网络的日常运维与管理。

3.2 适用范围

• 环境要求：运行 Antrea CNI 的 Kubernetes 集群（Antrea 版本需与 UI 兼容，具体参考官方兼容性说明）；
• 依赖组件：必须与 antrea/antrea-ui-frontend 前端镜像配合使用；
• 用户群体：Kubernetes 集群管理员、网络运维人员、需可视化管理 Antrea 网络的技术团队。

4. 使用方法和配置说明

4.1 前提条件

• Kubernetes 集群已部署 Antrea CNI（部署指南参考 Antrea 官方文档）；
• 集群已配置容器镜像拉取权限（可访问 Docker Hub 或私有仓库中的 antrea/antrea-ui-backend 镜像）；
• （可选）已部署 antrea/antrea-ui-frontend 前端服务。

4.2 部署方案示例

4.2.1 Kubernetes 集群部署（推荐）

在 Kubernetes 集群中，通过 Deployment 管理后端服务，结合 Service 暴露访问端口：

1. 创建后端 Deployment

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: antrea-ui-backend
  namespace: kube-system  # 建议与 Antrea 组件同命名空间
spec:
  replicas: 1
  selector:
    matchLabels:
      app: antrea-ui-backend
  template:
    metadata:
      labels:
        app: antrea-ui-backend
    spec:
      serviceAccountName: antrea-ui  # 需提前创建具备集群访问权限的 ServiceAccount
      containers:
      - name: antrea-ui-backend
        image: antrea/antrea-ui-backend:latest  # 替换为具体版本标签（如 v1.0.0）
        ports:
        - containerPort: 8080  # 默认 API 服务端口
        resources:
          requests:
            cpu: 100m
            memory: 128Mi
          limits:
            cpu: 500m
            memory: 256Mi
        livenessProbe:
          httpGet:
            path: /healthz
            port: 8080
          initialDelaySeconds: 10
          periodSeconds: 5
        readinessProbe:
          httpGet:
            path: /readyz
            port: 8080
          initialDelaySeconds: 5
          periodSeconds: 3

2. 创建 Service 暴露服务

yaml
apiVersion: v1
kind: Service
metadata:
  name: antrea-ui-backend
  namespace: kube-system
spec:
  selector:
    app: antrea-ui-backend
  ports:
  - port: 80
    targetPort: 8080
  type: ClusterIP  # 可根据需求调整为 NodePort 或 LoadBalancer

4.2.2 本地测试部署（Docker Compose）

适用于本地开发或测试环境，需确保可访问 Kubernetes 集群 API：

yaml
version: '3'
services:
  antrea-ui-backend:
    image: antrea/antrea-ui-backend:latest
    ports:
      - "8080:8080"
    environment:
      - KUBERNETES_SERVICE_HOST=192.168.1.100  # 替换为 Kubernetes API 主机地址
      - KUBERNETES_SERVICE_PORT=6443  # 替换为 Kubernetes API 端口
    volumes:
      - ./kubeconfig:/root/.kube/config  # 挂载本地 kubeconfig 文件以访问集群

4.3 配置参数与环境变量

该镜像的核心配置围绕 Kubernetes 集群访问及服务运行参数展开，主要通过以下方式配置：

4.3.1 Kubernetes API 访问

• 生产环境：默认通过集群内 ServiceAccount 自动获取访问凭证（推荐），需为 Pod 绑定具备 antrea.io 资源访问权限的 RBAC 角色。
• 测试环境：可通过挂载 kubeconfig 文件（如示例 4.2.2）或设置以下环境变量指定外部 API 地址：
  • KUBERNETES_SERVICE_HOST：Kubernetes API 服务器主机地址；
  • KUBERNETES_SERVICE_PORT：Kubernetes API 服务器端口（默认 6443）。

4.3.2 服务运行参数

• 监听端口：默认监听 8080 端口，可通过 --port 命令行参数或 PORT 环境变量修改（如 PORT=8081）；
• 健康检查：内置 /healthz（存活检查）和 /readyz（就绪检查）接口，支持 Kubernetes 探针配置（如示例 4.2.1）。

5. 参考信息

• 源代码仓库：https://github.com/antrea-io/antrea-ui
• Antrea CNI 官方文档：[***]
• 前端镜像：https://hub.docker.com/r/antrea/antrea-ui-frontend