Imports your current Cloud infrastructure to an Infrastructure As Code Terraform configuration (HCL) or/and to a Terraform State.
At Cycloid, Infrastructure As Code is in the company DNA since the beginning. To help our new customers adopting this best practice, we decided to build Terracognita to convert an existing infrastructure on Cloud Infrastructure into Terraform code in an automated way, relying on Terraform providers built by the community. We focused on AWS, GCP and Azure but Alibaba, Vmware and Openstack will be the next to be integrated.
We decided to Open Source this tool as we believe that it will help people to adopt IaC in an easy way. Cycloid provides this tool to let people import their infrastructure into Cycloid's pipelines, allow them to generate infrastructure diagram and manage all infra/application life cycle from a single interface.
If you are interested in contributing to Terracognita or simply curious about what's next, take a look at the public roadmap. For a high level overview, check out the What is Terracognita? blogpost or watch this video.
Terracognita currently imports AWS, GCP and AzureRM cloud provider as Terraform (0.13.5) resource/state. Please see the following versions as follow:
Providers:
- AWS: 3.40.0
- AzureRM: 2.58.0
- Google: 3.67.0
Visit the releases page to select your system, architecture and version you need. To pull the latest release:
curl -L https://github.com/cycloidio/terracognita/releases/latest/download/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/terracognitaYou can build and install with the latest sources, you will enjoy the new features and bug fixes. It uses Go Modules, so GO 1.16+ is required.
git clone https://github.com/cycloidio/terracognita
cd terracognita
make installThere are two entries in the AUR: terracognita-git (targets the latest git commit) and terracognita (targets the latest stable release).
yay -Ss terracognita
aur/terracognita 1:0.3.0-1 (+0 0.00%)
Reads from existing Cloud Providers (reverse Terraform) and generates your infrastructure as code on Terraform configuration
aur/terracognita-git 1:v0.3.0.r27.gdfc5a99-1 (+0 0.00%)
Reads from existing Cloud Providers (reverse Terraform) and generates your infrastructure as code on Terraform configurationIf you're macOS user and using Homebrew, you can install via brew command:
brew install terracognitaThe main usage of Terracognita is:
terracognita [TERRAFORM_PROVIDER] [--flags]You replace the TERRAFORM_PROVIDER with the Provider you want to use (for example aws) and then add the other required flags.
Each Provider has different flags and different required flags.
The more general ones are the --hcl or --module and --tfstate which indicates the output file for the HCL (or module)
and the TFState that will be generated.
You can also --include or --exclude multiple resources by using the Terraform name it has like aws_instance.
For more options you can always use terracognita --help and terracognita [TERRAFORM_PROVIDER] --help for the
specific documentation of the Provider.
We also have make help that provide some helpers on using the actual codebase of Terracognita
Terracognita can generate Terraform Modules directly when importing. To enable this feature you'll need to use the --module {module/path/name} and then on that specific path is where the module will be generated. The path has to be directory or a none existent path (it'll be created), the content of the path will be deleted (after user confirmation) so we can have a clean import.
The output structure will look like (having --module test) this where each file aggregates the resources from the same "category":
test/
├── module-test
│ ├── autoscaling.tf
│ ├── cloud_front.tf
│ ├── cloud_watch.tf
│ ├── ec2.tf
│ ├── elastic_load_balancing_v2_alb_nlb.tf
│ ├── iam.tf
│ ├── rds.tf
│ ├── route53_resolver.tf
│ ├── route53.tf
│ ├── s3.tf
│ ├── ses.tf
│ └── variables.tf
└── module.tf
By default all the attributes will be changed for variables, those variables will then be on the module-{name}/variables.tf and exposed on the module.tf like so:
module "test" {
# aws_instance_front_instance_type = "t2.small"
[...]
source = "module-test"
}If you want to change this behavior, as for big infrastructures this will create a lot of variables, you can use the --module-varibles path/to/file and the file will have the list of attributes that you want to actually be used as variables, it can be in JSON or YAML:
{
"aws_instance": [
"instance_type",
"cpu_threads_per_core",
"cpu_core_count"
]
}aws_instance:
- instance_type
- cpu_threads_per_core
- cpu_core_countYou can use directly the image built, or you can build your own. To build your Docker image just run:
make dbuildAnd then depending on the image you want to use (cycloid/terracognita or your local build terracognita):
docker run cycloid/terracognita -hExample:
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 \
--hcl app/outputs/resources.tfThe local version can be used the same way as docker. You simply need to be build it locally.
To speed up the testing, you can write a small provider.tffile within the same folder you imported your resources & tfstate:
terraform {
backend "local" {
path = "./$TFSTATE_PATH"
}
required_providers {
aws = {
source = "hashicorp/aws"
}
}
required_version = ">= 0.13"
}
provider "aws" {
access_key = "${var.access_key}"
secret_key = "${var.secret_key}"
region = "${var.region}"
}
variable "access_key" {}
variable "secret_key" {}
variable "region" {}Then run the terraform init & plan commands:
terraform init
terraform plan -var access_key=$AWS_ACCESS_KEY_ID -var secret_key=$AWS_SECRET_ACCESS_KEY -var region=$AWS_DEFAULT_REGIONPlease see the MIT LICENSE file.
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
Cycloid is a European fully-remote company, building a product to simplify, accelerate and optimize your DevOps and Cloud adoption.
We built Cycloid, your DevOps framework to encourage Developers and Ops to work together with the respect of best practices. We want to provide a tool that eliminates the silo effect in a company and allows to share the same level of informations within all professions.
Cycloid supports you to factorize your application in a reproducible way, to deploy a new environment in one click. This is what we call a stack.
A stack is composed of 3 pillars:
Thanks to the flexible pipeline, all the steps and technologies are configurable.
To make it easier to create a stack, we build an Infrastructure designer named StackCraft that allows you to drag & drop Terraform resources and generate your Terraform files for you.
Terracognita is a brick that will help us to import an existing infrastructure into a stack to easily adopt Cycloid product.
The product comes also with an Open Source service catalog (all our public stacks are on Github) to deploy applications seamlessly. To manage the whole life cycle of an application, it also integrates the diagram of the infrastructure and the application, a cost management control to centralize Cloud billing, the monitoring, logs and events centralized with Prometheus, Grafana, ELK.