Created by Waze SRE

What is Terraformer?

Terraformer is a tool for generating Terraform tf and tfstate configuration files from existing infrastructure.

**Disclaimer**: This is not an official Google product The project is in beta phase

Features

1. Generate tf + tfstate configuration files from existing infrastructure for a supported objects by resource.
2. Save a the state data to a remote data store such as GCS.
3. Link between resources with terraform_remote_state (local and bucket).
4. Compatible with terraform 0.12 syntax.
5. Save tf files with custom folder tree pattern.

Terraformer was built to easily create new providers and resources. For upgrade resources with new fields you need upgrade only terraform providers.

Import current state to terraform configuration from google cloud

Usage:
   import google [flags]

Flags:
  -b, --bucket string        gs://terraform-state
  -c, --connect               (default true)
  -h, --help                 help for google
  -o, --path-output string    (default "generated")
  -p, --path-patter string   {output}/{provider}/custom/{service}/ (default "{output}/{provider}/{service}/")
  -r, --resources strings    firewalls,networks
  -s, --state string         local or bucket (default "local")
      --projects strings
  -z, --zone string

Supported Providers

1. Google Cloud Platform
2. Amazon Web Services

We would need you to add more providers

Permissions

Terraformer requires read-only API permissions.

Getting Started

Installation

Prerequisite

You can download Terraform provider plugins from here:

• Google Cloud Platform Provider - here
• Amazon Web Services Provider - here

1. Copy Terraform provider's plugin(s) to: ~/.terraform.d/plugins/{darwin,linux}_amd64

Information on provider plugins: https://www.terraform.io/docs/configuration/providers.html

Binary

1. Download the binary and run ./terraformer

From source

1. Run git clone <terraformer repo>
2. Run GO111MODULE=on go mod vendor
3. Run go build -v
4. Copy your Terraform provider's plugin(s) to ~/.terraform.d/plugins/{darwin,linux}_amd64, as appropriate.

See it in action with GCP provider

Example:

terraformer import google --resources=gcs,forwardingRules,httpHealthChecks --connect=true --zone=europe-west1-a --projects=aaa,fff

List of supported GCP services:

• addresses
• autoscalers
• backendBuckets
• backendServices
• disks
• firewalls
• forwardingRules
• globalAddresses
• globalForwardingRules
• healthChecks
• httpHealthChecks
• httpsHealthChecks
• images (bug: Either raw_disk or source_disk configuration is required.)
• instanceGroupManagers
• instanceGroups
• instanceTemplates
• instances
• networks
• regionAutoscalers
• regionBackendServices
• regionDisks
• regionInstanceGroupManagers
• routers
• routes
• securityPolicies
• sslPolicies
• subnetworks
• targetHttpProxies (bug with proxy_id uint64 issue)
• targetHttpsProxies
• targetSslProxies
• targetTcpProxies
• urlMaps
• vpnTunnels
• gcs
• monitoring
• dns
• cloudsql (bug, bug)

Your tf and tfstate configuration files are written by default to generated/gcp/zone/service.

Use with AWS

Example:

 terraformer import aws --resources=vpc,subnet --connect=true --regions=eu-west-1

Import current State to terraform configuration from aws

Usage:
   import aws [flags]

Flags:
  -b, --bucket string        gs://terraform-state
  -c, --connect               (default true)
  -h, --help                 help for aws
  -o, --path-output string    (default "generated")
  -p, --path-patter string   {output}/{provider}/custom/{service}/ (default "{output}/{provider}/{service}/")
      --regions strings      eu-west-1,eu-west-2,us-east-1
  -r, --resources strings    vpc,subnet,nacl
  -s, --state string         local or bucket (default "local")

List of support AWS services:

• elb
• alb
• auto_scaling
• rds
• iam
• igw
• nacl
• s3
• sg
• subnet
• vpc
• vpn_connection
• vpn_gateway
• route53
• elasticache

Contributing

If you have improvements or fixes, we would love to have your contributions. Please read CONTRIBUTING.md for more information on the process we would like contributors to follow.

Developing

Terraformer built for easy to add new providers and not only cloud providers.

Process for generating tf + tfstate files:

1. Call GCP/AWS/other api and get list of resources.
2. Iterate over resources and take only ID (we don't need mapping fields!!!)
3. Call to provider for readonly fields.
4. Call to infrastructure and take tf + tfstate.

Infrastructure

1. Call to provider for refresh method and get all data.
2. Convert refresh data to go struct.
3. Generate HCL file - tf files.
4. Generate tfstate files.

All mapping of resource is made by providers and Terraform. Upgrades are needed only for providers.

GCP compute resources

For GCP compute resources, use generated code from gcp_terraforming/gcp_compute_code_generator.

To regenerate code:

go run gcp_terraforming/gcp_compute_code_generator/*.go

Similar projects

1. https://github.com/dtan4/terraforming