keploy/enterprise

Keploy 企业版 Docker 镜像文档

1. 镜像概述和主要用途

Keploy 企业版 Docker 镜像是 Keploy 官方提供的企业级容器化部署方案，基于 Keploy 开源项目构建，针对企业级用户提供增强功能和服务支持。Keploy 是一款面向 API 和微服务的自动化测试工具，核心能力包括测试用例自动生成、请求录制与回放、集成测试验证等，帮助企业简化测试流程、提升测试效率。企业版在开源版基础上，新增团队协作、安全合规、SLA 保障等企业级特性，适用于中大型企业的测试自动化与质量保障场景。

2. 核心功能和特性

2.1 企业级增强功能

• 团队协作与权限管理：支持多角色权限控制（管理员、测试工程师、开发者）、团队空间隔离、测试用例共享与版本控制。
• SLA 与技术支持：提供 7×24 小时企业级技术支持、服务等级协议（SLA）保障，确保生产环境稳定运行。
• 高级安全合规：支持 LDAP/SSO 身份认证、数据加密传输（TLS 1.3）、符合 GDPR/ISO 27001 等合规要求。
• 多环境集成：深度集成企业级 CI/CD 工具（Jenkins、GitLab CI、GitHub Actions）、监控平台（Prometheus、Grafana）及测试管理系统（JIRA、TestRail）。

2.2 基础功能（继承自开源版）

• 零代码测试用例生成：通过流量录制自动生成 API 测试用例，支持 HTTP/HTTPS、gRPC、数据库等协议。
• 动态测试验证：自动对比录制流量与实际运行结果，检测接口行为一致性。
• 测试数据管理：自动隔离测试数据依赖，支持动态数据替换与 Mock 服务生成。
• 跨平台兼容性：支持 Linux、macOS、Windows 环境，兼容 Docker、Kubernetes 部署。

3. 使用场景和适用范围

3.1 典型使用场景

• 企业级应用测试自动化：为微服务、分布式系统提供全流程测试用例生成与执行，降低人工编写成本。
• CI/CD 流水线集成：嵌入持续集成流程，在代码提交阶段自动执行测试，提前发现回归问题。
• 多环境测试验证：在开发、测试、预发环境中复用测试用例，确保环境一致性。
• 合规性与审计需求：满足***、***等行业对测试过程可追溯、权限可控的合规要求。

3.2 适用范围

• 中大型企业研发团队（10 人以上）
• 微服务架构或分布式系统测试
• 需满足安全合规要求的行业（、政务、）
• 追求测试效率提升的 DevOps 团队

4. 使用方法和配置说明

4.1 前提条件

• Docker Engine 20.10+ 或 Docker Desktop 4.0+
• 有效的 Keploy 企业版许可证密钥（联系 Keploy 销售团队获取）
• 至少 2GB 可用内存，10GB 磁盘空间

4.2 快速启动（Docker Run）

通过 docker run 命令直接启动 Keploy 企业版容器：

bash
docker run -d \
  --name keploy-enterprise \
  -p 8080:8080 \  # Web 管理界面端口
  -p 9090:9090 \  # 测试流量录制端口（按需开放）
  -v /path/to/keploy/data:/data \  # 持久化配置与测试数据
  -e LICENSE_KEY="your-enterprise-license-key" \  # 企业许可证密钥（必填）
  -e LOG_LEVEL="info" \  # 日志级别：debug/info/warn/error
  -e PORT=8080 \  # Web 界面端口（容器内）
  keploy/enterprise:latest

参数说明：

• -p 8080:8080：映射容器内 Web 管理界面端口到主机，通过 http://localhost:8080 访问。
• -v /path/to/keploy/data:/data：挂载主机目录到容器 /data，持久化存储配置文件、测试用例、日志等数据。
• -e LICENSE_KEY：企业版激活密钥，必填项，无此密钥容器无法启动。

4.3 Docker Compose 部署

创建 docker-compose.yml 文件，定义完整部署配置（含持久化、网络隔离）：

yaml
version: "3.8"
services:
  keploy-enterprise:
    image: keploy/enterprise:latest
    container_name: keploy-enterprise
    restart: always  # 自动重启
    ports:
      - "8080:8080"  # Web 管理界面
      - "9090:9090"  # 测试流量录制端口
    volumes:
      - keploy-data:/data  # 命名卷持久化数据
    environment:
      - LICENSE_KEY=your-enterprise-license-key  # 替换为实际许可证密钥
      - LOG_LEVEL=info
      - PORT=8080
      - AUTH_MODE=sso  # 启用 SSO 认证（可选，默认 basic）
      - DB_CONNECTION_STRING=postgresql://user:pass@db:5432/keploy  # 外部数据库连接（可选）
    networks:
      - keploy-net  # 独立网络隔离

  # 可选：外部数据库（如需替换内置 SQLite）
  db:
    image: postgres:14
    container_name: keploy-db
    volumes:
      - postgres-data:/var/lib/postgresql/data
    environment:
      - POSTGRES_USER=user
      - POSTGRES_PASSWORD=pass
      - POSTGRES_DB=keploy
    networks:
      - keploy-net

networks:
  keploy-net:
    driver: bridge

volumes:
  keploy-data:  # Keploy 数据持久化卷
  postgres-data:  # 数据库数据卷（如使用外部 DB）

启动服务：

bash
docker-compose up -d

4.4 访问 Web 管理界面

容器启动后，通过浏览器访问 http://<主机IP>:8080 进入 Keploy 企业版管理界面：

• 默认登录凭据（首次登录需修改）：
  • 用户名：admin
  • 密码：keploy@enterprise（首次登录强制修改）

5. 环境变量配置

Keploy 企业版容器通过环境变量控制核心配置，以下为常用参数说明：

6. 数据持久化

Keploy 企业版需持久化以下数据，避免容器重启后丢失：

• 测试用例与配置：存储于 /data/tests 和 /data/config
• 日志文件：存储于 /data/logs
• 许可证状态：存储于 /data/license

推荐配置：通过 Docker 数据卷（Volume）或主机目录挂载 /data 目录（如 4.2/4.3 示例）。

7. 常见问题

7.1 容器启动失败，提示 "Invalid license key"

• 原因：LICENSE_KEY 未设置或无效。
• 解决：确认许可证密钥正确，联系 Keploy 支持团队检查密钥状态。

7.2 Web 界面无法访问

• 检查：容器是否运行（docker ps）、端口映射是否正确（-p 8080:8080）、防火墙是否放行 8080 端口。
• 日志排查：通过 docker logs keploy-enterprise 查看启动日志，定位错误原因。

7.3 测试用例丢失

• 原因：未配置数据持久化，容器删除后 /data 目录被清理。
• 解决：通过 -v 参数挂载数据卷（见 4.2/4.3 示例），确保数据持久化。

8. 版本更新

通过以下步骤更新镜像版本：

1. 拉取最新镜像：docker pull keploy/enterprise:latest
2. 停止旧容器：docker stop keploy-enterprise
3. 删除旧容器：docker rm keploy-enterprise
4. 重新启动容器（使用原 docker run 或 docker-compose up -d 命令）

注意：更新前建议备份 /data 目录数据，避免配置丢失。