The Terraform provider for Aviatrix
go/
, follow this doc to edit ~/.bash_profile
to setup the GOPATH environment variableClone repository to: $GOPATH/src/github.com/AviatrixSystems/terraform-provider-aviatrix
MacOS / Linux
$ mkdir -p $GOPATH/src/github.com/AviatrixSystems
$ cd $GOPATH/src/github.com/AviatrixSystems
$ git clone https://github.com/AviatrixSystems/terraform-provider-aviatrix.git
Windows
mkdir %GOPATH%\src\github.com\AviatrixSystems
cd %GOPATH%\src\github.com\AviatrixSystems
git clone https://github.com/AviatrixSystems/terraform-provider-aviatrix.git
MacOS / Linux
$ cd $GOPATH/src/github.com/AviatrixSystems/terraform-provider-aviatrix
$ make fmt
$ make build13
Windows
Run the following commands for cmd:
cd %GOPATH%\src\github.com\AviatrixSystems\terraform-provider-aviatrix
go fmt
go install
xcopy "%GOPATH%\bin\terraform-provider-aviatrix.exe" "%APPDATA%\terraform.d\plugins\aviatrix.com\aviatrix\aviatrix\99.0.0\windows_amd64\" /Y
Run the following commands if using Powershell:
cd "$env:GOPATH\src\github.com\AviatrixSystems\terraform-provider-aviatrix"
go fmt
go install
xcopy "$env:GOPATH\bin\terraform-provider-aviatrix.exe" "$env:APPDATA\terraform.d\plugins\aviatrix.com\aviatrix\aviatrix\99.0.0\windows_amd64\" /Y
For Terraform v0.13+, to use a locally built version of a provider you must add the following snippet to every module that you want to use the provider in.
terraform {
required_providers {
aviatrix = {
source = "aviatrix.com/aviatrix/aviatrix"
version = "99.0.0" # this MUST be set as seen here
}
}
}
In order to test out a specific version, you can build the corresponding branch. By default, step 2 will build whatever git branch you are currently on (typically default is master branch)
Check out the Git branch where the fix is, which corresponds to the Controller version, and repeat step 2 to build the provider
# Example - Want to locally build a version with a bug fix for 6.7-patch - corresponding to an unreleased R2.21.3
# assuming current working directory is the local git repo
$ git pull
$ git checkout UserConnect-6.7
$ make fmt
$ make build13
To debug the provider in an IDE or with delve, start the provider with the following command:
$GOPATH/bin/terraform-provider-aviatrix -debug
Run the following command if you are using PowerShell:
"$env:GOROOT/bin/terraform-provider-aviatrix" -debug
The output of the provider will look like this:
{"@level":"debug","@message":"plugin address","@timestamp":"2024-06-20T11:59:55.493839+02:00","address":"/var/folders/sh/tf1ct6kd3vnfckhrtlkmrz200000gp/T/plugin3596224496","network":"unix"}
Provider started. To attach Terraform CLI, set the TF_REATTACH_PROVIDERS environment variable with the following:
TF_REATTACH_PROVIDERS='{"AviatrixSystems/aviatrix":{"Protocol":"grpc","ProtocolVersion":5,"Pid":33330,"Test":true,"Addr":{"Network":"unix","String":"/var/folders/sh/tf1ct6kd3vnfckhrtlkmrz200000gp/T/plugin3596224496"}}}'
Now attach your debugger to the running process and add breakpoints.
Finally, start terraform using the active provider like this:
$ export TF_REATTACH_PROVIDERS='{"AviatrixSystems/aviatrix":{"Protocol":"grpc","ProtocolVersion":5,"Pid":33330,"Test":true,"Addr":{"Network":"unix","String":"/var/folders/sh/tf1ct6kd3vnfckhrtlkmrz200000gp/T/plugin3596224496"}}}'
$ terraform plan
Run the following command if you are using PowerShell:
$ $Env:TF_REATTACH_PROVIDERS = '{"AviatrixSystems/aviatrix":{"Protocol":"grpc","ProtocolVersion":5,"Pid":33509,"Test":true,"Addr":{"Network":"unix","String":"/var/folders/sh/tf1ct6kd3vnfckhrtlkmrz200000gp/T/plugin3596224496"}}}'
$ terraform plan
WARNING: The following instructions are kept for legacy purposes. ONLY follow these instructions below IF you are trying to build an old version of the Aviatrix provider AND are using an old Terraform version (0.12)
MacOS / Linux
$ cd $GOPATH/src/github.com/AviatrixSystems/terraform-provider-aviatrix
$ make fmt
$ make build13
Windows
cd %GOPATH%\src\github.com\AviatrixSystems\terraform-provider-aviatrix
go fmt
go install
To use this provider after building it with Go, you must activate it.
Activate the provider by adding the following to ~/.terraformrc
on Linux/Unix.
If the rc file is not present, it should be created
MacOS / Linux
providers {
"aviatrix" = "$GOPATH/bin/terraform-provider-aviatrix"
}
Windows
providers {
"aviatrix" = "$GOPATH/bin/terraform-provider-aviatrix.exe"
}
For Windows, the file should be at '%APPDATA%\terraform.rc'. Do not change $GOPATH to %GOPATH%.
In versions prior to 0.13, the terraform {}
was not required
Check resource examples and documentation here
Visit here for the complete documentation for all resources on Github
Due to some non-backward compatible changes in REST API, not all controller versions are supported.
If you find a branch with the controller version please use that branch Controller versions older than 3.3 are not supported For example:
master
branch is a development branch, thus it is unverified for all use cases and supports features that may not be available in the latest released version of the controller. For production use cases, please only use a released version from the Terraform Registry.
We also recommend you to update to the latest controller version to stay on top of fixes/features.