NOTE: We are in the process of planning v2 of the provider which will not be backwards compatible. See the v2Plan for further details.
Requirements
- Terraform 0.10.x
- Go 1.10 (to build the provider plugin)
Building The Provider
Clone repository to: $GOPATH/src/github.com/terraform-providers/terraform-provider-vcd
$ mkdir -p $GOPATH/src/github.com/terraform-providers; cd $GOPATH/src/github.com/terraform-providers
$ git clone git@github.com:terraform-providers/terraform-provider-vcd
Enter the provider directory and build the provider
$ cd $GOPATH/src/github.com/terraform-providers/terraform-provider-vcd
$ make build
Using the provider
Fill in for each provider
Developing the Provider
If you wish to work on the provider, you'll first need Go installed on your machine (version 1.10+ 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-vcd
...
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
The acceptance tests will run against your own vCloud Director setup, using the configuration in your file ./vcd/vcd_test_config.json
See the file ./vcd/sample_vcd_test_config.json
for an example of which variables need to be defined.
Installing the built provider
For a more thorough test using the Terraform client, you may want to transfer the plugin in the Terraform directory. A make
command can do this for you:
$ make install
This command will build the plugin and transfer it to $HOME/.terraform/plugins
, with a name that includes the version (as taken from the ./VERSION
file).