palantir / tfjson

Terraform plan file to JSON

tfjson

Utility to read in a Terraform plan file and dump it out in JSON. Standalone version of Terraform PR #3170.

Installation

$ go get github.com/palantir/tfjson

Usage

Given the following Terraform resources:

provider "aws" {
  region = "us-east-1"
}

resource "aws_vpc" "main" {
  cidr_block = "10.0.0.0/16"
}

module "inner" {
  source = "./inner"
}

// in inner module:

resource "aws_vpc" "inner" {
  cidr_block = "10.0.0.0/8"
}

Running terraform plan -out=terraform.tfplan produces a Terraform plan file. The JSON representation produced by tfjson looks like:

$ tfjson terraform.tfplan
{
    "aws_vpc.main": {
        "cidr_block": "10.0.0.0/16",
        "default_network_acl_id": "",
        "default_route_table_id": "",
        "default_security_group_id": "",
        "destroy": false,
        "destroy_tainted": false,
        "dhcp_options_id": "",
        "enable_classiclink": "",
        "enable_dns_hostnames": "",
        "enable_dns_support": "",
        "id": "",
        "instance_tenancy": "",
        "main_route_table_id": ""
    },
    "destroy": false,
    "inner": {
        "aws_vpc.inner": {
            "cidr_block": "10.0.0.0/8",
            "default_network_acl_id": "",
            "default_route_table_id": "",
            "default_security_group_id": "",
            "destroy": false,
            "destroy_tainted": false,
            "dhcp_options_id": "",
            "enable_classiclink": "",
            "enable_dns_hostnames": "",
            "enable_dns_support": "",
            "id": "",
            "instance_tenancy": "",
            "main_route_table_id": ""
        },
        "destroy": false
    }
}

License

This project is made available under the MIT License.

tfjson's Issues

Very nice tool, thank you!

😄

Error parsing plan

I am getting:

gob: wrong type (map[string]string) for received field InstanceState.Meta

When attempting to parse a .tfplan file.

Terraform v0.9.5

Add to package managers like homebrew

Would be nice to install this using a package managers

brew install tfjson
choco install tfjson
scoop install tfjson

If you think this is a good idea then we could emulate the terraform landscape tool test formula

This project may be too niche according to the Acceptable Criteria and so it might be best to maintain our own tap.

The following criteria should be done and I can help when I have time.

• document how to build this tool
• add a --version or -v that ties into the tag
• add a homebrew tap
• document how to install on osx using the tap
• after we achieve the above, a non author can submit it homebrew to be officially added

Let me know what you think and thanks for making a great tool!

Reference:

• Wrote up something similar for another terraform tool flosell/iam-policy-json-to-terraform#3

Update Circle CI

Circle CI is now using version 2, my pull request has this update but Circle CI is not picking it up. Could this be looked at, it probably just needs a kick to start processing again.

Error parsing plan generated from Terraform v0.10.7

local>terraform --version
Terraform v0.10.7

tfjson ./terraform.tfplan
unknown plan file version: 2

Surface type of change for resources

It appears that the type of change (especially creation vs modification) is not included in the output. It would be useful to be able to easily differentiate between a resource that's being modified and one that's just being created. This could be an additional field or perhaps by providing the full diff of attribute values rather than just the new value of attributes that change.

Terraform >v0.12 Support?

Terraform 12 has been out for a month or so now. In v. 12, the format of the output from running terraform plan has been changed drastically. Any plans to add support for the new format?