Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the repo README #12538

Merged
merged 6 commits into from
Oct 3, 2022
Merged
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 26 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,29 @@
Terraform Provider for Google Cloud Platform
==================
# Terraform Provider for Google Cloud Platform

- Website: https://www.terraform.io
- Tutorials: [learn.hashicorp.com](https://learn.hashicorp.com/terraform?track=getting-started#getting-started)
- Forum: [discuss.hashicorp.com](https://discuss.hashicorp.com/c/terraform-providers/tf-google/)
- Documentation: https://www.terraform.io/docs/providers/google/index.html
- [![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)
<img src="https://cdn.rawgit.com/hashicorp/terraform-website/master/content/source/assets/images/logo-hashicorp.svg" width="600px">

Maintainers
-----------
The Terraform Google provider is a plugin that allows [Terraform](https://www.terraform.io) to manage resources on Google Cloud Platform. This provider is maintained by the [Terraform team at Google](https://cloudplatform.googleblog.com/2017/03/partnering-on-open-source-Google-and-HashiCorp-engineers-on-managing-GCP-infrastructure.html) and the Terraform team at [HashiCorp](https://www.hashicorp.com/)

This provider plugin is maintained by:
The ['google-beta' provider](https://github.com/hashicorp/terraform-provider-google-beta) contains preview features and features at a beta [launch stage](https://cloud.google.com/products#product-launch-stages). Refer to the [provider versions](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_versions) documentation for more information about how to use `google-beta`.
shuyama1 marked this conversation as resolved.
Show resolved Hide resolved

* 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/)
## Quick Starts

Requirements
------------
- [Getting Started with the Google Provider](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/getting_started)
- [Provider Documentation](https://registry.terraform.io/providers/hashicorp/google/latest/docs)

- [Terraform](https://www.terraform.io/downloads.html) 0.12+
## Provider Usage

Please see [instructions](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_reference) on how to configure the Google Provider.

Using the provider
----------------------
### Using local Provider
shuyama1 marked this conversation as resolved.
Show resolved Hide resolved

See the [Google Provider documentation](https://www.terraform.io/docs/providers/google/index.html) to get started using the
Google provider.
Please see [instructions](https://github.com/GoogleCloudPlatform/magic-modules#using-released-terraform-binary-with-local-provider-binary) on how to use your locally generated provider binary.

We also maintain the 'google-beta' provider for preview features and features at a beta [launch stage](https://cloud.google.com/products#product-launch-stages). See [Provider Versions](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_versions)
for more details on how to use `google-beta`.

Upgrading the provider
----------------------
### Upgrading the provider

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

Expand All @@ -42,42 +34,25 @@ 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
---------------------
## Developing the provider

This repository is generated by [magic-modules](https://github.com/GoogleCloudPlatform/magic-modules).
If you wish to work on the provider, you'll need to make changes in [magic-modules](https://github.com/GoogleCloudPlatform/magic-modules). Any changes made directly to this repository will likely be overwritten.

For guidance on how to contribute, see the [contribution guidelines](https://github.com/GoogleCloudPlatform/magic-modules#contributing).
If you have other development questions we don't cover, please [file an issue](https://github.com/hashicorp/terraform-provider-google/issues/new/choose)!







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

```sh
$ mkdir -p $GOPATH/src/github.com/hashicorp; cd $GOPATH/src/github.com/hashicorp
$ git clone [email protected]:hashicorp/terraform-provider-google
```

Enter the provider directory and build the provider

```sh
$ cd $GOPATH/src/github.com/hashicorp/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.16.0+ is *required*). You can use [goenv](https://github.com/syndbg/goenv)
to manage your Go version. 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/hashicorp/terraform-provider-google/blob/master/.github/CONTRIBUTING.md).
If you have other development questions we don't cover, please file an issue!