hexinc/e2e-starburst

Hex项目Docker镜像文档

镜像概述和主要用途

Hex项目的Docker镜像基于其Monorepo结构构建，用于容器化部署前端（packages/client）、后端服务器（packages/server）及执行管理服务（packages/sidecar）。镜像支持开发环境快速搭建、多环境（生产、 staging、rc等）部署，整合项目核心组件，简化开发与部署流程。

核心功能和特性

• 组件容器化：整合前端Web客户端、主应用服务器（含核心后端逻辑）及项目执行管理服务（sidecar），实现一站式部署
• 多环境支持：适配Terraform部署配置，支持生产环境（prod）、测试环境（staging-1）、候选发布环境（rc）及单租户栈等多场景部署需求
• 开发环境集成：提供开发环境设置支持，可参考项目文档进行前端仅开发或全项目环境配置

使用场景和适用范围

• 开发团队：快速搭建一致的开发环境，基于容器化组件进行前端、后端及执行服务的联调开发
• 部署运维：通过Terraform配置实现多环境自动化部署，适用于生产、测试等不同场景的实例部署
• 项目扩展：支持新增组件（如自定义cell类型）的容器化集成，适配项目功能扩展需求

详细的使用方法和配置说明

前置要求

• 已安装Docker及Docker Compose
• 访问Hex项目仓库：https://github.com/hex-inc/hex%E3%80%81https://github.com/hex-inc/terraform-hex-deployments

开发环境配置

参考项目文档进行环境设置：

• 全项目开发环境：详见 https://github.com/hex-inc/hex/blob/main/docs/DEV_SETUP.md
• 仅前端开发环境：详见 https://github.com/hex-inc/hex/blob/main/docs/FE_ONLY_DEV_SETUP.md

多环境部署

1. 克隆Terraform部署仓库：git clone https://github.com/hex-inc/terraform-hex-deployments
2. 根据目标环境（如prod、staging-1）修改部署配置
3. 执行Terraform命令部署容器化实例：

   bash
   terraform init
   terraform apply -var-file=env/prod.tfvars
   

Docker镜像相关文档参考

• 镜像构建及注意事项：https://github.com/hex-inc/hex/blob/main/docs/DOCKER_IMAGES.md
• 多环境部署配置示例：参考Terraform部署仓库中不同环境的配置模板

相关仓库信息

• Monorepo：https://github.com/hex-inc/hex%EF%BC%88%E6%A0%B8%E5%BF%83%E4%BB%A3%E7%A0%81%E5%BA%93%EF%BC%8C%E5%8C%85%E5%90%ABclient%E3%80%81server%E3%80%81sidecar%E7%BB%84%E4%BB%B6%EF%BC%89
• Terraform全局配置：https://github.com/hex-inc/terraform%EF%BC%88%E7%AE%A1%E7%90%86IAM%E7%94%A8%E6%88%B7%E3%80%81S3%E6%A1%B6%E3%80%81Route 53等全局资源）
• Terraform部署配置：https://github.com/hex-inc/terraform-hex-deployments%EF%BC%88%E9%85%8D%E7%BD%AEprod%E3%80%81staging%E7%AD%89%E5%A4%9A%E7%8E%AF%E5%A2%83%E9%83%A8%E7%BD%B2%EF%BC%89
• 公共网站：https://github.com/hex-inc/public-website%EF%BC%88Hex%E5%AE%98%E7%BD%91%E7%9B%B8%E5%85%B3%E4%BB%A3%E7%A0%81%EF%BC%89