2017-06-20 18:29:10 +00:00
Terraform Provider for Google Cloud Platform
2017-06-05 20:54:03 +00:00
==================
- Website: https://www.terraform.io
2017-11-14 21:19:15 +00:00
- Documentation: https://www.terraform.io/docs/providers/google/index.html
2017-06-05 20:54:03 +00:00
- [![Gitter chat ](https://badges.gitter.im/hashicorp-terraform/Lobby.png )](https://gitter.im/hashicorp-terraform/Lobby)
- Mailing list: [Google Groups ](http://groups.google.com/group/terraform-tool )
2017-07-26 17:27:20 +00:00
< img src = "https://cdn.rawgit.com/hashicorp/terraform-website/master/content/source/assets/images/logo-hashicorp.svg" width = "600px" >
2017-06-05 20:54:03 +00:00
2017-11-10 16:48:36 +00:00
Maintainers
-----------
This provider plugin is maintained by:
* The [Google Cloud Graphite Team ](https://cloudplatform.googleblog.com/2017/03/partnering-on-open-source-Google-and-HashiCorp-engineers-on-managing-GCP-infrastructure.html ) at Google
* The Terraform team at [HashiCorp ](https://www.hashicorp.com/ )
2017-06-05 20:54:03 +00:00
Requirements
------------
- [Terraform ](https://www.terraform.io/downloads.html ) 0.10.x
2018-01-27 00:37:19 +00:00
- [Go ](https://golang.org/doc/install ) 1.9 (to build the provider plugin)
2017-06-05 20:54:03 +00:00
Building The Provider
---------------------
2017-06-12 17:14:00 +00:00
Clone repository to: `$GOPATH/src/github.com/terraform-providers/terraform-provider-google`
2017-06-05 20:54:03 +00:00
```sh
2017-06-09 23:04:05 +00:00
$ mkdir -p $GOPATH/src/github.com/terraform-providers; cd $GOPATH/src/github.com/terraform-providers
2017-06-12 17:14:00 +00:00
$ git clone git@github.com:terraform-providers/terraform-provider-google
2017-06-05 20:54:03 +00:00
```
Enter the provider directory and build the provider
```sh
2017-06-12 17:14:00 +00:00
$ cd $GOPATH/src/github.com/terraform-providers/terraform-provider-google
2017-06-05 20:54:03 +00:00
$ make build
```
2017-11-07 22:50:30 +00:00
Using the provider
2017-08-17 23:50:32 +00:00
----------------------
2017-11-07 22:50:30 +00:00
See the [Google Provider documentation ](https://www.terraform.io/docs/providers/google/index.html ) to get started using the Google provider.
2017-08-17 23:50:32 +00:00
2017-11-07 22:50:30 +00:00
Upgrading the provider
2017-06-05 20:54:03 +00:00
----------------------
2017-06-12 17:14:00 +00:00
2017-11-07 22:50:30 +00:00
To upgrade to the latest stable version of the Google provider run `terraform init -upgrade` . See the [Terraform website ](https://www.terraform.io/docs/configuration/providers.html#provider-versions ) for more information.
2017-06-05 20:54:03 +00:00
Developing the Provider
---------------------------
2018-01-27 00:37:19 +00:00
If you wish to work on the provider, you'll first need [Go ](http://www.golang.org ) installed on your machine (version 1.9+ is *required* ). You'll also need to correctly setup a [GOPATH ](http://golang.org/doc/code.html#GOPATH ), as well as adding `$GOPATH/bin` to your `$PATH` .
2017-06-05 20:54:03 +00:00
To compile the provider, run `make build` . This will build the provider and put the provider binary in the `$GOPATH/bin` directory.
```sh
2017-06-13 12:04:48 +00:00
$ make build
2017-06-05 20:54:03 +00:00
...
2017-06-12 17:14:00 +00:00
$ $GOPATH/bin/terraform-provider-google
2017-06-05 20:54:03 +00:00
...
```
In order to test the provider, you can simply run `make test` .
```sh
$ 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.
```sh
$ make testacc
```