bridgecrew/terraformer

Terraformer

镜像概述

Terraformer是一个命令行工具，用于基于现有基础设施生成Terraform配置文件（.tf/.json）和状态文件（tfstate），实现"反向Terraform"功能。该工具支持多种云服务提供商、基础设施软件及网络服务，帮助用户将现有手动部署的资源纳入Terraform管理，实现基础设施即代码（IaC）的迁移与维护。

核心功能

1. 配置文件生成：为支持的资源生成Terraform配置文件（HCL或JSON格式）和对应的状态文件
2. 远程状态支持：可将生成的状态文件上传至GCS存储桶
3. 资源关联：通过terraform_remote_state连接本地或存储桶中的资源
4. 自定义文件结构：支持通过参数自定义生成文件的文件夹树模式
5. 资源过滤：可按资源名称、类型、ID或属性筛选需要导入的资源
6. 版本兼容：支持Terraform 0.13+（Terraform 0.11需使用v0.7.9版本）
7. 计划功能：生成导入计划文件，支持在导入前编辑资源列表

使用场景

• 基础设施迁移：将现有手动部署的云资源（如AWS、GCP、Azure等）转换为Terraform配置
• IaC审计：生成现有基础设施的Terraform配置，用于审计和合规检查
• 配置基线生成：为新项目提供基于现有资源的配置基线
• 多环境同步：基于生产环境资源生成测试/开发环境的配置模板
• 资源文档化：通过生成的配置文件记录现有基础设施结构

使用方法

Docker运行示例

bash
# 基本使用：生成AWS VPC和子网的配置
docker run -v $(pwd):/app terraformer import aws --resources=vpc,subnet --regions=eu-west-1 --profile=prod

# 带过滤条件：仅导入指定ID的VPC
docker run -v $(pwd):/app terraformer import aws --resources=vpc --filter=vpc=vpc-12345678 --regions=eu-west-1

# 生成计划文件，编辑后再导入
docker run -v $(pwd):/app terraformer plan google --resources=networks,firewall --projects=my-project --regions=europe-west1-d
docker run -v $(pwd):/app terraformer import plan generated/google/my-project/terraformer/plan.json

主要配置参数

资源过滤

ID过滤

通过资源ID筛选要导入的资源，多个ID用冒号分隔：

bash
docker run -v $(pwd):/app terraformer import aws --resources=vpc --filter=vpc=vpc-123456:vpc-789012 --regions=eu-west-1

属性过滤

通过资源属性筛选，格式为Name=属性名;Value=值1:值2：

bash
docker run -v $(pwd):/app terraformer import aws --resources=ec2_instance --filter="Name=tags.env;Value=prod:staging" --regions=eu-west-1

资源结构

默认生成文件路径：{output}/{provider}/{service}/{resource}.tf

可通过参数调整：

• --compact：将服务下所有资源合并到resources.tf
• --path-pattern：自定义路径模式，如--path-pattern {output}/{provider}/将所有服务资源放在同一目录

支持的服务提供商

主要云服务

• Google Cloud (GCP)
• AWS
• Azure
• AliCloud

其他云服务

• DigitalOcean、Fastly、Heroku、Linode、NS1、OpenStack、Vultr、Yandex.Cloud

基础设施软件

• Kubernetes、OctopusDeploy、RabbitMQ

网络服务

• Cloudflare

版本控制

• GitHub

监控与系统管理

• Datadog、New Relic

社区支持

• Keycloak、Logz.io、Commercetools、Mikrotik、GmailFilter

权限要求

工具需要对目标服务具有只读权限，以列出和获取资源信息。具体权限因服务提供商而异，通常需要能列出资源、获取资源详情的权限。

注意事项

• Terraform 0.11用户需使用Terraformer v0.7.9版本
• 生成配置后，建议手动检查和调整，特别是资源依赖关系
• 部分资源可能需要特定版本的Terraform provider支持，需确保provider版本兼容