Developing the Provider
Note: This project uses Go Modules making it safe to work with it outside of your existing GOPATH. The instructions that follow assume a directory in your home directory outside of the standard GOPATH (i.e
Clone repository to:
$ mkdir -p $HOME/development/terraform-providers/; cd $HOME/development/terraform-providers/ $ git clone email@example.com:terraform-providers/terraform-provider-aws ...
Enter the provider directory and run
make tools. This will install the needed tools for the provider.
$ make tools
To compile the provider, run
make build. This will build the provider and put the provider binary in the
$ make build ... $ $GOPATH/bin/terraform-provider-aws ...
Using the Provider
To use a released provider in your Terraform environment, run
terraform init and Terraform will automatically install the provider. To specify a particular provider version when installing released providers, see the Terraform documentation on provider versioning.
To instead use a custom-built provider in your Terraform environment (e.g. the provider binary from the build instructions above), follow the instructions to install it as a plugin. After placing it into your plugins directory, run
terraform init to initialize it.
For either installation method, documentation about the provider specific configuration options can be found on the provider's website.
Testing the Provider
In order to test the provider, you can run
Note: Make sure no
AWS_SECRET_ACCESS_KEY variables are set, and there's no
[default] section in the AWS credentials file
$ make test
In order to run the full suite of Acceptance tests, run
Note: Acceptance tests create real resources, and often cost money to run. Please read Running an Acceptance Test in the contribution guidelines for more information on usage.
$ make testacc
Terraform is the work of thousands of contributors. We appreciate your help!
To contribute, please read the contribution guidelines: Contributing to Terraform - AWS Provider
Issues on GitHub are intended to be related to bugs or feature requests with provider codebase. See https://www.terraform.io/docs/extend/community/index.html for a list of community resources to ask questions about Terraform.