TFDSL

A Chef like DSL for Terraform.

Terraform uses HCL for its configuration, which is better than json or yaml in my opinion, but still not quite as flexible as Chef DSL, so here it's a chef like DSL for terraform.

Add this line to your application's Gemfile:

gem 'tfdsl'

And then execute:

$ bundle

Or install it yourself as:

$ gem install terraform_dsl

A quick usage example

require 'tfdsl'
  
stack = TFDSL.stack do
  resource 'aws_vpc', 'main' do
    cidr_block '10.0.0.0/16'
    instance_tenancy 'dedicated'
    tags do
      Name 'main'
    end
  end
end

puts stack

The code above will produce the output below:

resource "aws_vpc" "main" {
  cidr_block = "10.0.0.0/16"
  instance_tenancy = "dedicated"

  tags = {
    Name = "main"
  }
}

Since some terraform object names use Ruby reserved words, we had to do some slight modifications on how resources are named. We use datasource for data and tfmodule for module

Example:

In ruby

datasource 'aws_ami', 'web' do
...
end

In HCL

data 'aws_ami' 'web' {
...
}

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/terraform_dsl. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the TerraformDsl project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.