Terraform Google Cloud Platform provider
Switch branches/tags
Clone or download

README.md

Terraform Provider for Google Cloud Platform

Maintainers

This provider plugin is maintained by:

Requirements

Using the provider

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

We recently introduced the google-beta provider. See Provider Versions for more details on how to use google-beta.

Upgrading the provider

The Google provider doesn't upgrade automatically once you've started using it. After a new release you can run

terraform init -upgrade

to upgrade to the latest stable version of the Google provider. See the Terraform website for more information on provider upgrades, and how to set version constraints on your provider.

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

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-google
...

For guidance on common development practices such as testing changes or vendoring libraries, see the contribution guidelines. If you have other development questions we don't cover, please file an issue!