mirror of
https://github.com/letic/terraform-provider-google.git
synced 2024-06-29 06:42:36 +00:00
3d43932a49
Adding `.x` to Travis means use the latest minor version according to its docs. I didn't update the "Requirements" header because this is just because of Go Modules; see https://github.com/terraform-providers/terraform-provider-google/pull/2932 for why. Since it's just a development change, it doesn't impact _using_ the provider. Although, out of curiosity- is that header for development? Or is there a real requirement to have Go installed to use Terraform providers?
78 lines
3.1 KiB
Markdown
78 lines
3.1 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+
|
|
- [Go](https://golang.org/doc/install) 1.11.0 or higher
|
|
|
|
|
|
Using the provider
|
|
----------------------
|
|
|
|
See the [Google Provider documentation](https://www.terraform.io/docs/providers/google/index.html) to get started using the
|
|
Google provider.
|
|
|
|
We recently introduced the `google-beta` provider. See [Provider Versions](https://www.terraform.io/docs/providers/google/provider_versions.html)
|
|
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
|
|
|
|
```bash
|
|
terraform init -upgrade
|
|
```
|
|
|
|
to upgrade to the latest stable version of the Google provider. See the [Terraform website](https://www.terraform.io/docs/configuration/providers.html#provider-versions)
|
|
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`
|
|
|
|
```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
|
|
```
|
|
|
|
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.11.4+ 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
|
|
...
|
|
```
|
|
|
|
For guidance on common development practices such as testing changes or vendoring libraries, see the [contribution guidelines](https://github.com/terraform-providers/terraform-provider-google/blob/master/.github/CONTRIBUTING.md). If you have other development questions we don't cover, please file an issue!
|