Terrakube API 镜像文档

镜像概述和主要用途

Terrakube 是一个开源协作平台，专注于通过 Terraform 运行远程基础设施即代码（IaC）操作，旨在完全替代 Terraform Enterprise、Scalr、Env0 等闭源工具。本镜像为 Terrakube 平台的核心组件——API 服务器，负责处理平台的核心 API 请求，是完整 Terrakube 部署的关键部分。

核心功能和特性

• 开源替代方案：提供闭源 Terraform 协作工具的全部核心功能，支持自托管部署，避免供应商锁定。
• Kubernetes 兼容：可轻松部署至任何 Kubernetes 集群，利用容器编排简化管理和扩展。
• 工具生态集成：支持与 Terraform 生态工具集成，如 terratag（资源标记）、infracost（成本分析）、terrascan（安全扫描）等，实现自定义工作流。
• 多认证支持：通过 Dex 集成多种身份提供商，包括 Azure Active Directory、Google Cloud Identity、GitHub、GitLab 等，满足企业级认证需求。

使用场景和适用范围

• 自托管 IaC 协作平台：适合需要在私有环境中部署 Terraform 协作工具的团队，确保数据隐私和合规性。
• 企业级基础设施管理：支持多团队协作、权限精细化控制和基础设施自动化，满足大规模 IaC 治理需求。
• Kubernetes 环境部署：适用于已采用 Kubernetes 的组织，利用现有容器化基础设施简化部署和维护。
• 自定义工作流扩展：需集成第三方工具（如成本估算、安全检测）的场景，通过插件化架构灵活扩展功能。

使用方法和配置说明

部署建议

本镜像仅包含 Terrakube API 组件，需作为完整 Terrakube 部署的一部分使用。推荐通过以下官方方案部署完整平台：

Docker Compose 部署

参考官方 Docker Compose 指南，通过预配置的 Compose 文件快速部署包含 API、UI、数据库、认证服务等组件的完整环境。

Helm Chart 部署

对于 Kubernetes 环境，推荐使用 Terrakube Helm Chart（原英文描述中链接有误，已修正），支持自定义配置和 Kubernetes 原生资源管理。

独立运行（仅调试用）

若需单独测试 API 组件（生产环境不推荐），需手动配置依赖（如数据库、认证服务），示例命令：

docker run -d \
  --name terrakube-api \
  -p 8080:8080 \
  -e SPRING_PROFILES_ACTIVE=prod \
  -e DATABASE_URL=jdbc:postgresql://<db-host>:5432/terrakube \
  -e DEX_URL=http://<dex-host>:5556 \
  -e JWT_SECRET=<your-jwt-secret> \
  terrakube/api:latest

注意：独立运行需确保数据库（如 PostgreSQL）、Dex 认证服务等依赖已部署并正确配置。

支持标签及 Dockerfile 链接

许可证

镜像中软件的许可信息参见 LICENSE 文件。

参考信息

• 维护者：Terrakube
• 获取帮助：GitHub Discussions
• 提交问题：GitHub Issues
• 官方文档：Terrakube 文档
• 支持架构：linux/amd64、linux/arm64