cycloid/terracognita

TerraCognita

镜像概述和主要用途

TerraCognita是由Cycloid开发的工具，用于将现有云基础设施自动导入为Terraform配置（HCL）和/或Terraform状态文件。作为Cycloid DevOps框架的一部分，其核心目标是帮助用户轻松采用基础设施即代码（IaC）最佳实践，尤其适用于已有云资源但需迁移到Terraform管理的场景。

核心功能和特性

支持的云提供商及版本

• AWS：2.31.0
• GCP：2.16.0

主要特性

• 从云提供商读取现有基础设施资源
• 生成Terraform HCL配置文件
• 创建Terraform状态文件
• 支持集成到Cycloid流水线，实现基础设施生命周期管理
• 开源工具，便于社区贡献和扩展

使用场景和适用范围

• 现有云基础设施（AWS/GCP）迁移到Terraform管理
• 快速生成基础设施即代码配置，加速IaC adoption
• 集成到Cycloid DevOps框架，实现基础设施可视化和生命周期管理
• 生成基础设施图表，辅助架构文档和审计

详细使用方法和配置说明

安装方式

二进制安装

1. 访问https://github.com/cycloidio/terracognita/releases%E9%80%89%E6%8B%A9%E9%80%82%E5%90%88%E7%9A%84%E7%B3%BB%E7%BB%9F%E3%80%81%E6%9E%B6%E6%9E%84%E5%92%8C%E7%89%88%E6%9C%AC
2. 执行以下命令安装：

shell
$ curl -L https://github.com/cycloidio/terracognita/releases/download/v0.3.0/terracognita-linux-amd64.tar.gz -o terracognita-linux-amd64.tar.gz
$ tar -xf terracognita-linux-amd64.tar.gz
$ chmod u+x terracognita-linux-amd64
$ sudo mv terracognita-linux-amd64 /usr/local/bin/terracognita

开发版安装

需Go 1.11+（支持Go Modules）：

shell
$ git clone https://github.com/cycloidio/terracognita
$ cd terracognita
$ make install

Arch Linux安装

通过AUR安装：

shell
# 稳定版
$ yay -S terracognita

# 开发版（最新git提交）
$ yay -S terracognita-git

Docker使用

构建Docker镜像

bash
$ make dbuild

运行Docker镜像

bash
$ docker run cycloid/terracognita -h

AWS示例

bash
$ export AWS_ACCESS_KEY_ID=XXXXXXXXXXXXXXXXXXXX
$ export AWS_SECRET_ACCESS_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
$ export AWS_DEFAULT_REGION=xx-yyyy-0
$ docker run \
    -v "${PWD}"/outputs:/app/outputs \
    cycloid/terracognita aws \
    --access-key="${AWS_ACCESS_KEY_ID}" \
    --secret-key="${AWS_SECRET_ACCESS_KEY}" \
    --region="${AWS_DEFAULT_REGION}" \
    --hcl app/outputs/resources.tf

本地使用

本地版本使用方式与Docker版本类似，需先本地构建：

bash
$ make build
$ terracognita -h

测试导入结果

1. 在导入资源和tfstate的同一目录创建provider.tf文件：

hcl
terraform {
  backend "local" {
    path = "./$TFSTATE_PATH"
  }
}

provider "aws" {
  access_key = "${var.access_key}"
  secret_key = "${var.secret_key}"
  region     = "${var.region}"
  version    = "2.12.0"
}

variable "access_key" {}
variable "secret_key" {}
variable "region" {}

2. 执行Terraform命令验证：

bash
$ terraform init
$ terraform plan -var access_key=$AWS_ACCESS_KEY_ID -var secret_key=$AWS_SECRET_ACCESS_KEY -var region=$AWS_DEFAULT_REGION

许可证

采用https://github.com/cycloidio/terracognita/blob/master/LICENSE%E3%80%82

变更日志

所有重要变更将记录在此文件中，格式基于Keep a Changelog，并遵循https://semver.org/spec/v2.0.0.html%E3%80%82

关于Cycloid

Cycloid是一家欧洲全远程公司，致力于构建简化、加速和优化DevOps与云 adoption的产品。其DevOps框架鼓励开发人员和运维人员协作，并遵循最佳实践。通过Terracognita，用户可以将现有基础设施导入Cycloid栈，实现一键部署新环境、统一管理基础设施和应用生命周期。