Repository files navigation

A CLI tool that generatestf/json andtfstate files based on existing infrastructure(reverse Terraform).

• Disclaimer: This is not an official Google product
• Created by: Waze SRE

• Demo GCP
• Capabilities
• Installation
• Supported Providers
  • Major Cloud
    • Google Cloud
    • AWS
    • Azure
    • AliCloud
    • IBM Cloud
  • Cloud
    • DigitalOcean
    • Equinix Metal
    • Fastly
    • Heroku
    • LaunchDarkly
    • Linode
    • NS1
    • OpenStack
    • TencentCloud
    • Vultr
    • Yandex Cloud
    • Ionos Cloud
  • Infrastructure Software
    • Kubernetes
    • OctopusDeploy
    • RabbitMQ
  • Network
    • Cloudflare (broken, see #1761)
    • Myrasec
    • PAN-OS
  • VCS
    • Azure DevOps
    • GitHub
    • Gitlab
  • Monitoring & System Management
    • Datadog
    • New Relic
    • Mackerel
    • PagerDuty
    • Opsgenie
    • Honeycomb.io
    • Opal
  • Community
    • Keycloak
    • Logz.io
    • Commercetools
    • Mikrotik
    • Xen Orchestra
    • GmailFilter
    • Grafana
    • Vault
  • Identity
    • Okta
    • Auth0
    • AzureAD
• Contributing
• Developing
• Infrastructure
• Stargazers over time

1. Generatetf/json +tfstate files from existing infrastructure for allsupported objects by resource.
2. Remote state can be uploaded to a GCS bucket.
3. Connect between resources withterraform_remote_state (local and bucket).
4. Savetf/json files using a custom folder tree pattern.
5. Import by resource name and type.
6. Support terraform 0.13 (for terraform 0.11 use v0.7.9).

Terraformer uses Terraform providers and is designed to easily support newly added resources.To upgrade resources with new fields, all you need to do is upgrade the relevant Terraform providers.

Import current state to Terraform configuration from a providerUsage:   import [provider] [flags]   import [provider] [command]Available Commands:  list        List supported resources for a providerFlags:  -b, --bucket string         gs://terraform-state  -c, --connect                (default true)  -С, --compact                (default false)  -x, --excludes strings      firewalls,networks  -f, --filter strings        compute_firewall=id1:id2:id4  -h, --help                  help for google  -O, --output string         output format hcl or json (default "hcl")  -o, --path-output string     (default "generated")  -p, --path-pattern string   {output}/{provider}/ (default "{output}/{provider}/{service}/")      --projects strings  -z, --regions strings       europe-west1, (default [global])  -r, --resources strings     firewall,networks or * for all services  -s, --state string          local or bucket (default "local")  -v, --verbose               verbose mode  -n, --retry-number          number of retries to perform if refresh fails  -m, --retry-sleep-ms        time in ms to sleep between retriesUse " import [provider] [command] --help" for more information about a command.

The tool requires read-only permissions to list service resources.

You can use--resources parameter to tell resources from what service you want to import.

To import resources from all services, use--resources="*" . If you want to exclude certain services, you can combine the parameter with--excludes to exclude resources from services you don't want to import e.g.--resources="*" --excludes="iam".

Filters are a way to choose which resourcesterraformer imports. It's possible to filter resources by its identifiers or attributes. Multiple filtering values are separated by:. If an identifier contains this symbol, value should be wrapped in' e.g.--filter=resource=id1:'project:dataset_id'. Identifier based filters will be executed before Terraformer will try to refresh remote state.

UseType when you need to filter only one of several types of resources. Multiple filters can be combined when importing different resource types. An example would be importing all AWS security groups from a specific AWS VPC:

terraformer import aws -r sg,vpc --filter Type=sg;Name=vpc_id;Value=VPC_ID --filter Type=vpc;Name=id;Value=VPC_ID

Notice how theName is different forsg than it is forvpc.

For terraform >= 0.13, you can usereplace-provider to migrate state from previous versions.

Example usage:

terraform state replace-provider -auto-approve "registry.terraform.io/-/aws" "hashicorp/aws"

Filtering is based on Terraform resource ID patterns. To find valid ID patterns for your resource, check the import part of theTerraform documentation.

Example usage:

terraformer import aws --resources=vpc,subnet --filter=vpc=myvpcid --regions=eu-west-1

Will only import the vpc with idmyvpcid. This form of filters can help when it's necessary to select resources by its identifiers.

It is possible to filter by specific field name only. It can be used e.g. when you want to retrieve resources only with a specific tag key.

Example usage:

terraformer import aws --resources=s3 --filter="Name=tags.Abc" --regions=eu-west-1

Will only import the s3 resources that have tagAbc. This form of filters can help when the field values are not important from filtering perspective.

It is possible to filter by a field that contains a dot.

Example usage:

terraformer import aws --resources=s3 --filter="Name=tags.Abc.def" --regions=eu-west-1

Will only import the s3 resources that have tagAbc.def.

Theplan command generates a planfile that contains all the resources set to be imported. By modifying the planfile before running theimport command, you can rename or filter the resources you'd like to import.

The rest of subcommands and parameters are identical to theimport command.

$ terraformer plan google --resources=networks,firewall --projects=my-project --regions=europe-west1-d(snip)Saving planfile to generated/google/my-project/terraformer/plan.json

After reviewing/customizing the planfile, begin the import by runningimport plan.

$ terraformer import plan generated/google/my-project/terraformer/plan.json

Terraformer by default separates each resource into a file, which is put into a given service directory.

The default path for resource files is{output}/{provider}/{service}/{resource}.tf and can vary for each provider.

It's possible to adjust the generated structure by:

1. Using--compact parameter to group resource files within a single service into oneresources.tf file
2. Adjusting the--path-pattern parameter and passing e.g.--path-pattern {output}/{provider}/ to generate resources for all services in one directory

It's possible to combine--compact--path-pattern parameters together.

Both Terraformer and a Terraform provider plugin need to be installed.

From a package manager

• Homebrew users can usebrew install terraformer.
• MacPorts users can usesudo port install terraformer.
• Chocolatey users can usechoco install terraformer.

From releasesThis installs all providers, setPROVIDER to one ofgoogle,aws orkubernetes if you only need one.

• Linux

export PROVIDER=allcurl -LO "https://github.com/GoogleCloudPlatform/terraformer/releases/download/$(curl -s https://api.github.com/repos/GoogleCloudPlatform/terraformer/releases/latest | grep tag_name | cut -d '"' -f 4)/terraformer-${PROVIDER}-linux-amd64"chmod +x terraformer-${PROVIDER}-linux-amd64sudo mv terraformer-${PROVIDER}-linux-amd64 /usr/local/bin/terraformer

• MacOS

export PROVIDER=allcurl -LO "https://github.com/GoogleCloudPlatform/terraformer/releases/download/$(curl -s https://api.github.com/repos/GoogleCloudPlatform/terraformer/releases/latest | grep tag_name | cut -d '"' -f 4)/terraformer-${PROVIDER}-darwin-amd64"chmod +x terraformer-${PROVIDER}-darwin-amd64sudo mv terraformer-${PROVIDER}-darwin-amd64 /usr/local/bin/terraformer

• Windows

1. Install Terraform -https://www.terraform.io/downloads
2. Download exe file for required provider from here -https://github.com/GoogleCloudPlatform/terraformer/releases
3. Add the exe file path to path variable

From source

1. Rungit clone <terraformer repo> && cd terraformer/
2. Rungo mod download
3. Rungo build -v for all providers OR build with one providergo run build/main.go {google,aws,azure,kubernetes,etc}

Create a working folder and initialize the Terraform provider plugin. This folder will be where you run Terraformer commands.

Runterraform init against aversions.tf file to install the plugins required for your platform. For example, if you need plugins for the google provider,versions.tf should contain:

terraform {  required_providers {    google = {      source = "hashicorp/google"    }  }  required_version = ">= 0.13"}

Or, copy your Terraform provider's plugin(s) from the list below to folder~/.terraform.d/plugins/, as appropriate.

Links to download Terraform provider plugins:

• Major Cloud
  • Google Cloud provider >2.11.0 -here
  • AWS provider >2.25.0 -here
  • Azure provider >1.35.0 -here
  • Alicloud provider >1.57.1 -here
• Cloud
  • DigitalOcean provider >1.9.1 -here
  • Heroku provider >2.2.1 -here
  • LaunchDarkly provider >=2.1.1 -here
  • Linode provider >1.8.0 -here
  • OpenStack provider >1.21.1 -here
  • TencentCloud provider >1.50.0 -here
  • Vultr provider >1.0.5 -here
  • Yandex provider >0.42.0 -here
  • Ionoscloud provider >6.3.3 -here
• Infrastructure Software
  • Kubernetes provider >=1.9.0 -here
  • RabbitMQ provider >=1.1.0 -here
• Network
  • Myrasec provider >1.44 -here
  • Cloudflare provider >1.16 -here
  • Fastly provider >0.16.1 -here
  • NS1 provider >1.8.3 -here
  • PAN-OS provider >= 1.8.3 -here
• VCS
  • GitHub provider >=2.2.1 -here
• Monitoring & System Management
  • Datadog provider >2.1.0 -here
  • New Relic provider >2.0.0 -here
  • Mackerel provider > 0.0.6 -here
  • Pagerduty >=1.9 -here
  • Opsgenie >= 0.6.0here
  • Honeycomb.io >= 0.10.0 -here
  • Opal >= 0.0.2 -here
• Community
  • Keycloak provider >=1.19.0 -here
  • Logz.io provider >=1.1.1 -here
  • Commercetools provider >= 0.21.0 -here
  • Mikrotik provider >= 0.2.2 -here
  • Xen Orchestra provider >= 0.18.0 -here
  • GmailFilter provider >= 1.0.1 -here
  • Vault provider -here
  • Auth0 provider -here
  • AzureAD provider -here

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

• Initialize provider details in cmd/root.go and create a provider initialization file in the terraformer/cmd folder
• Create a folder under terraformer/providers/ for your provider
• Create two files under this folder
  • <provide_name>_provider.go
  • <provide_name>_service.go
• Initialize all provider's supported services in <provide_name>_provider.go file
• Create script for each supported service in same folder

If you have improvements or fixes, we would love to have your contributions.Please readCONTRIBUTING.md for more information on the process we would likecontributors to follow.

Terraformer was built so you can easily add new providers of any kind.

Process for generatingtf/json +tfstate files:

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

1. Call to provider using the refresh method and get all data.
2. Convert refresh data to go struct.
3. Generate HCL file -tf/json files.
4. Generatetfstate files.

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

For GCP compute resources, use generated code fromproviders/gcp/gcp_compute_code_generator.

To regenerate code:

go run providers/gcp/gcp_compute_code_generator/*.go

• Simpler to add new providers and resources - already supports AWS, GCP, GitHub, Kubernetes, and Openstack. Terraforming supports only AWS.
• Better support for HCL + tfstate, including updates for Terraform 0.12.
• If a provider adds new attributes to a resource, there is no need change Terraformer code - just update the Terraform provider on your laptop.
• Automatically supports connections between resources in HCL files.

Terraforming gets all attributes from cloud APIs and creates HCL and tfstate files with templating. Each attribute in the API needs to map to attribute in Terraform. Generated files from templating can be broken with illegal syntax. When a provider adds new attributes the terraforming code needs to be updated.

Terraformer instead uses Terraform provider files for mapping attributes, HCL library from Hashicorp, and Terraform code.

Look for S3 support in terraforming here and official S3 supportTerraforming lacks full coverage for resources - as an example you can see that 70% of S3 options are not supported:

• terraforming -https://github.com/dtan4/terraforming/blob/master/lib/terraforming/template/tf/s3.erb
• official S3 support -https://www.terraform.io/docs/providers/aws/r/s3_bucket