Aviatrix Terraform Tutorial

This document walks you through the steps to make use of Aviatrix Terraform provider. As an example, an Aviatrix gateway will be launched. It is assumed that terraform is already set up. If so, skip steps 1 and 2

1. Download Terraform Package

Terraform is delivered as a zip file in binary. Click this link, select your respective OS and simply download the package as you would for any software.

For Mac, terraform is also present in Homebrew . Perform “brew install terraform” to install terraform( Skip step 2 if done this way)

Once it is downloaded, double click to unzip the file. The executable file terraform should be in your Downloads folder. (We use this as an example in this document)

Open a terminal, type the command “Downloads/terraform –version”, you should see some output like the following, for Unix systems


command for Windows is “terraform.exe –version”

2. Setup Execution Path

The terraform binary file is in your Downloads directory, in order for you to execute the commands anywhere, the next step is to setup execution path.

In the home directory, open the file .bash_profile for editing.

Append this line to the end of the file

Unix example

export PATH=$PATH:$HOME/Downloads

Type the following command to allow terraform to be executed anywhere.

Unix example

$ source ~/.bash_profile

To verify, go to home or any directory and type “terraform –version”, you should see the same outputs

For windows, PATH and other environment variables can be edited from System Properties.

3. Download and Install Go

Aviatrix terraform provider requires you to download Go, the software that the terraform provider is written in.

Follow the instructions listed here to download and install Go, as shown below:


For Mac, Go is also present in Homebrew . Perform “brew install go” to install go

4. Download and Build Aviatrix Terraform Provider

After you have installed Go, follow these steps.

4.1 Create a directory go, setup GOPATH.

Example for Unix/Linux

$ cd
$ mkdir go
$ export GOPATH=$HOME/go

Line 3 can also be made permanent: Edit ~/.bash_profile by appending line “export GOPATH=$HOME/go”, and then run a command “source ~/.bash_profile” for the GOPATH path to take effect.

For windows, GOPATH and other environment variables can be edited from System Properties.

4.2 Download the Aviatrix terraform provider repo:

$ mkdir -p $GOPATH/src/github.com/terraform-providers
$ cd $GOPATH/src/github.com/terraform-providers
$ git clone https://github.com/AviatrixSystems/terraform-provider-aviatrix

To clone on windows

mkdir %GOPATH%\src\github.com\terraform-providers\terraform-provider-aviatrix
cd %GOPATH%\src\github.com\terraform-providers\terraform-provider-aviatrix
git clone https://github.com/AviatrixSystems/terraform-provider-aviatrix

4.3 Build the provider:

$ cd $GOPATH/src/github.com/terraform-providers/terraform-provider-aviatrix
$ make fmt
$ make build

to build on Windows, run

cd %GOPATH%\src\github.com\terraform-providers\terraform-provider-aviatrix
go fmt
go install

4.4 Activate the provider by adding the following to ~/.terraformrc. If the file ~/.terraformrc does not exist, you need to create one by adding the text below.

providers {
  "aviatrix" = "$GOPATH/bin/terraform-provider-aviatrix"

For Windows, the file should be at ‘%APPDATA%terraform.rc’. Do not change $GOPATH to %GOPATH%

5. Prepare Aviatrix Controller

Follow the Aviatrix Controller Startup Guide to launch a Controller and go through the onboarding process.

Once onboarding is completed, a primary account should be created. This primary account will be used to launch a gateway.

Create a terraform configuration file, for example, aviatrix_gateway_test.tf, copy and paste the the below text into the file. Modify the parameters to suit your environment!

# specify aviatrix as the provider with these parameters:
# controller_ip - public IP address of the controller
# username - login user name, default is admin
# password - password

provider "aviatrix" {
    controller_ip = ""
    username = "admin"
    password = "ControllerPSWD#"

# Launch a gateway with these parameters:
# cloud_type - Enter 1 for AWS. Only AWS is currently supported.
# account_name - Aviatrix account name to launch GW with.
# gw_name - Name of gateway.
# vpc_id - AWS VPC ID.
# vpc_reg - AWS VPC region.
# vpc_size - Gateway instance size
# vpc_net - VPC subnet CIDR where you want to launch GW instance

resource "aviatrix_gateway" "testGW" {
    account_name = "for-create2"
    cloud_type = 1
    gw_name = "testGW1"
    vpc_id = "vpc-01dd5643eca66486c"
    vpc_reg = "us-west-2"
    vpc_net = ""
    vpc_size = "t2.micro"

6. Run the Terrafrom Configuration

In the directory where the terraform configuration file resides, run terraform init command to prepare the new configuration file.

$ terraform init

Then run terraform plan command to see what will be executed.

$ terraform plan

Then run terraform apply command to launch the gateway.

$ terraform apply

When the above command finishes, you can login to Aviatrix Controller console, click Gateway page and see the new gateway with name testGW1 launched.

7. Simple Troubleshooting

A simple terraform debug method is to set TF_LOG level in ~/.bash_profile, as shown in the below example (remember to run command “source ~/.bash_profile” after editing .bash_profil):


With this log set to TRACE, you should see TRACE and ERROR when running terraform commands. Pay attention to ERRORs if a terraform command is not successful.

8. More Examples

To learn what are the resources are provided, check out Aviatrix Terraform Provider.

To learn more examples, read on Setup Aviatrix Transit Network with Terraform.

9. Contribute to the Community

Aviatrix terraform provider is an open source project. All reviews, comments and contributions are welcome.