kubeseal-webgui API镜像文档

镜像概述

本镜像为kubeseal-webgui项目的后端API组件，提供Web界面所需的核心API服务。基于kubeseal工具链构建，用于在Kubernetes集群中安全管理、加密和解密Secrets资源，是完整Web管理解决方案的后端支撑组件。

核心功能与特性

核心功能

• 与kubeseal工具深度集成，支持Secrets资源的加密、解密及管理操作
• 提供RESTful API接口，供前端Web界面调用以实现交互功能
• 支持Kubernetes集群连接配置，通过kubeconfig或集群内服务账户访问集群资源

关键特性

• 安全合规：遵循kubeseal加密标准，确保Secrets以加密形式存储
• 可配置性：支持通过环境变量自定义端口、日志级别、认证策略等
• 兼容性：兼容主流Kubernetes版本及kubeseal工具版本
• 可观测性：内置日志记录功能，支持集成外部监控系统

使用场景与适用范围

典型使用场景

• 配合kubeseal-webgui前端镜像部署，构建完整的Kubernetes Secrets Web管理平台
• 为Kubernetes管理员提供图形化界面，简化Secrets创建、加密、更新及删除流程
• 适用于多团队协作环境，实现Secrets资源的集中化管理与权限控制

适用范围

• Kubernetes集群管理员及运维团队
• 需要安全管理集群敏感信息（如数据库凭证、API密钥）的场景
• 采用GitOps工作流，需对Secrets进行版本化管理的环境

使用方法与配置说明

前置条件

• 已部署Kubernetes集群（v1.19+推荐）
• 集群内已安装kubeseal控制器（参考kubeseal官方文档）
• 如需外部访问集群，需准备有效的kubeconfig文件

环境变量配置

Docker运行示例

集群内部署（使用服务账户）

docker run -d \
  --name kubeseal-webgui-api \
  -p 3000:3000 \
  -e LOG_LEVEL=info \
  -e AUTH_ENABLED=true \
  -e JWT_SECRET=your-secure-jwt-secret \
  --mount type=secret,source=kube-api-access-xxxx,target=/var/run/secrets/kubernetes.io/serviceaccount \
  jaydee94/kubeseal-webgui-api:latest

集群外部署（使用kubeconfig）

docker run -d \
  --name kubeseal-webgui-api \
  -p 3000:3000 \
  -e KUBECONFIG=/app/kubeconfig \
  -e LOG_LEVEL=debug \
  -v /path/to/your/kubeconfig:/app/kubeconfig \
  jaydee94/kubeseal-webgui-api:latest

Docker Compose配置示例（配合前端）

version: '3.8'

services:
  api:
    image: jaydee94/kubeseal-webgui-api:latest
    container_name: kubeseal-webgui-api
    ports:
      - "3000:3000"
    environment:
      - LOG_LEVEL=info
      - AUTH_ENABLED=true
      - JWT_SECRET=your-jwt-secret-here
      - KUBECONFIG=/app/kubeconfig
    volumes:
      - ./kubeconfig:/app/kubeconfig
    restart: unless-stopped

  frontend:
    image: jaydee94/kubeseal-webgui:latest
    container_name: kubeseal-webgui-frontend
    ports:
      - "80:80"
    environment:
      - API_URL=[***]
    depends_on:
      - api
    restart: unless-stopped

注意事项

• 生产环境中必须启用AUTH_ENABLED并配置强JWT_SECRET，避免未授权访问
• 确保kubeconfig文件权限设置正确（仅运行用户可读取），避免敏感信息泄露
• 镜像版本应与kubeseal-webgui前端镜像版本保持一致，避免API兼容性问题
• 集群内部署时，建议通过Kubernetes Deployment而非直接docker run部署，以利用集群自愈能力

参考链接

• 项目主页：[***]
• kubeseal官方文档：[***]