Requirements
- Terraform 0.10.x
- Go 1.11 (to build the provider plugin)
Building The Provider
Clone repository to: $GOPATH/src/github.com/terraform-providers/terraform-provider-tfe
$ mkdir -p $GOPATH/src/github.com/terraform-providers; cd $GOPATH/src/github.com/terraform-providers
$ git clone git@github.com:terraform-providers/terraform-provider-tfe
Enter the provider directory and build the provider
$ cd $GOPATH/src/github.com/terraform-providers/terraform-provider-tfe
$ make build
Using the provider
If you're building the provider, follow the instructions to
install it as a plugin.
After placing it into your plugins directory, run terraform init
to initialize it.
Developing the Provider
If you wish to work on the provider, you'll first need Go installed
on your machine (version 1.11+ is required). You'll also need to correctly setup a
GOPATH, as well as adding $GOPATH/bin
to your $PATH
.
To compile the provider, run make build
. This will build the provider and put the provider binary
in the $GOPATH/bin
directory.
$ make build
...
$ $GOPATH/bin/terraform-provider-tfe
...
In order to test the provider, you can simply run make test
.
$ make test
In order to run the full suite of Acceptance tests, run make testacc
.
Note: Acceptance tests create real resources, and often cost money to run.
$ make testacc
Testing
A hostname and token must be provided in order to run the acceptance tests. We recomment configuring
the required credentials
in the CLI config file.