terraform-provider-google/README.md
Riley Karson aa1f07c5c6 Link to the detailed test guide in project readme (#1854)
Right now, we have a detailed guide to running acceptance tests in [CONTRIBUTING.MD](https://github.com/terraform-providers/terraform-provider-google/blob/master/.github/CONTRIBUTING.md#tests) while this file has the one-size-fits-all guideline of running `make test` and `make testacc` with no arguments. Instead, we can link to the detailed, provider specific guide so that we properly surface the required arguments/environment variables for `make testacc`, and don't incorrectly introduce `make test` as the primary means of testing the Google provider.
2018-08-10 16:18:11 -07:00

2.6 KiB

Terraform Provider for Google Cloud Platform

Maintainers

This provider plugin is maintained by:

Requirements

  • Terraform 0.10.x
  • Go 1.9 (to build the provider plugin)

Building The Provider

Clone repository to: $GOPATH/src/github.com/terraform-providers/terraform-provider-google

$ mkdir -p $GOPATH/src/github.com/terraform-providers; cd $GOPATH/src/github.com/terraform-providers
$ git clone git@github.com:terraform-providers/terraform-provider-google

Enter the provider directory and build the provider

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

Using the provider

See the Google Provider documentation to get started using the Google provider.

Upgrading the provider

To upgrade to the latest stable version of the Google provider run terraform init -upgrade. See the Terraform website for more information.

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.9+ 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-google
...

In order to test the Google provider, see the Tests section of the contribution guidelines.