naorlivne/terraformize

Terraform REST API 镜像文档

镜像概述

本镜像提供了一个轻量级的REST API服务，允许用户通过HTTP请求远程执行Terraform模块的应用（apply）和销毁（destroy）操作。该镜像旨在简化Terraform基础设施即代码（IaC）的管理流程，特别适合需要通过编程方式或自动化工具集成Terraform操作的场景。

核心功能和特性

• REST API接口：提供标准化的HTTP端点，支持Terraform模块的核心操作
• 操作支持：完整支持Terraform模块的apply（应用）和destroy（销毁）命令
• 无命令行依赖：无需在本地安装Terraform CLI，通过API即可完成操作
• 状态管理：内置Terraform状态文件管理机制（默认本地存储，支持远程后端配置）
• 轻量级设计：基于精简基础镜像，部署资源占用低，启动速度快

使用场景和适用范围

• 自动化部署流程：集成到CI/CD流水线中，实现基础设施的自动创建和清理
• 远程管理：通过API接口远程控制多环境（开发/测试/生产）的Terraform资源
• 平台集成：作为中间层服务，为上层应用提供基础设施操作能力
• 开发协作：团队成员无需直接接触Terraform配置文件，通过API即可执行标准化操作

使用方法和配置说明

基本部署（Docker Run）

bash
docker run -d \
  -p 8080:8080 \
  -v /path/to/your/terraform/modules:/modules \
  -e TF_API_PORT=8080 \
  -e TF_MODULES_DIR=/modules \
  --name terraform-api \
  [镜像名称]

Docker Compose 配置

yaml
version: '3'
services:
  terraform-api:
    image: docker.xuanyuan.run/[镜像名称]
    ports:
      - "8080:8080"
    volumes:
      - ./terraform-modules:/modules
    environment:
      - TF_API_PORT=8080
      - TF_MODULES_DIR=/modules
      - TF_STATE_BACKEND=s3://my-terraform-state-bucket
    restart: unless-stopped

环境变量配置

API端点说明

应用Terraform模块

• 请求：POST /apply
• 请求体：

  json
  {
    "module_name": "example-module",  // 模块目录名称
    "variables": {                    // 可选，模块变量
      "instance_count": 2,
      "instance_type": "t2.micro"
    }
  }
  

• 响应：

  json
  {
    "status": "success",
    "operation_id": "apply-12345",
    "output": "Terraform apply completed successfully",
    "resources": ["aws_instance.example"]
  }
  

销毁Terraform模块

• 请求：POST /destroy
• 请求体：

  json
  {
    "module_name": "example-module"  // 模块目录名称
  }
  

• 响应：

  json
  {
    "status": "success",
    "operation_id": "destroy-67890",
    "output": "Terraform destroy completed successfully",
    "resources_destroyed": 2
  }
  

查询操作状态

• 请求：GET /operations/{operation_id}
• 响应：

  json
  {
    "operation_id": "apply-12345",
    "status": "completed",
    "module_name": "example-module",
    "operation_type": "apply",
    "start_time": "2023-10-01T12:00:00Z",
    "end_time": "2023-10-01T12:02:30Z",
    "output": "..."
  }
  

注意事项

• 确保挂载的Terraform模块目录包含有效的.tf配置文件
• 远程状态后端（如S3、GCS）需要提前配置访问权限
• 生产环境建议启用API_AUTH_TOKEN进行访问控制
• 大型模块操作可能需要较长时间，建议通过/operations端点查询状态