mirror of
https://github.com/letic/terraform-provider-google.git
synced 2024-07-03 08:42:39 +00:00
aa1f07c5c6
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.
66 lines
2.6 KiB
Markdown
66 lines
2.6 KiB
Markdown
Terraform Provider for Google Cloud Platform
|
|
==================
|
|
|
|
- Website: https://www.terraform.io
|
|
- Documentation: https://www.terraform.io/docs/providers/google/index.html
|
|
- [](https://gitter.im/hashicorp-terraform/Lobby)
|
|
- Mailing list: [Google Groups](http://groups.google.com/group/terraform-tool)
|
|
<img src="https://cdn.rawgit.com/hashicorp/terraform-website/master/content/source/assets/images/logo-hashicorp.svg" width="600px">
|
|
|
|
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/)
|
|
|
|
Requirements
|
|
------------
|
|
|
|
- [Terraform](https://www.terraform.io/downloads.html) 0.10.x
|
|
- [Go](https://golang.org/doc/install) 1.9 (to build the provider plugin)
|
|
|
|
Building The Provider
|
|
---------------------
|
|
|
|
Clone repository to: `$GOPATH/src/github.com/terraform-providers/terraform-provider-google`
|
|
|
|
```sh
|
|
$ 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
|
|
|
|
```sh
|
|
$ cd $GOPATH/src/github.com/terraform-providers/terraform-provider-google
|
|
$ make build
|
|
```
|
|
|
|
Using the provider
|
|
----------------------
|
|
|
|
See the [Google Provider documentation](https://www.terraform.io/docs/providers/google/index.html) 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](https://www.terraform.io/docs/configuration/providers.html#provider-versions) for more information.
|
|
|
|
Developing the Provider
|
|
---------------------------
|
|
|
|
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`.
|
|
|
|
To compile the provider, run `make build`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.
|
|
|
|
```sh
|
|
$ make build
|
|
...
|
|
$ $GOPATH/bin/terraform-provider-google
|
|
...
|
|
```
|
|
|
|
In order to test the Google provider, see the [Tests section of the contribution guidelines](https://github.com/terraform-providers/terraform-provider-google/blob/master/.github/CONTRIBUTING.md#tests).
|