Skip to content

Commit

Permalink
Update provider name in various spots (GoogleCloudPlatform#10092)
Browse files Browse the repository at this point in the history
  • Loading branch information
rileykarson authored and jashansudan committed Mar 6, 2024
1 parent 23c06a8 commit 9f7697a
Show file tree
Hide file tree
Showing 14 changed files with 56 additions and 57 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

# Magic Modules

Magic Modules is a code generator and CI system that's used to develop the Terraform providers
for Google Cloud Platform, [`google`](https://github.com/hashicorp/terraform-provider-google) (or TPG) and
Magic Modules is a code generator and CI system that's used to develop the Terraform provider
for Google Cloud, [`google`](https://github.com/hashicorp/terraform-provider-google) (or TPG) and
[`google-beta`](https://github.com/hashicorp/terraform-provider-google-beta) (or TPGB).

Magic Modules allows contributors to make changes against a single codebase and develop both
Expand Down
6 changes: 3 additions & 3 deletions docs/content/best-practices/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ aliases:

# Best practices

The following is a list of best practices that contributions are expected to follow in order to ensure a consistent UX for the Google Terraform provider internally and also compared to other Terraform providers.
The following is a list of best practices that contributions are expected to follow in order to ensure a consistent UX for the Terraform provider for Google Cloud internally and also compared to other Terraform providers.

## ForceNew

Expand Down Expand Up @@ -44,7 +44,7 @@ See [magic-modules#13107](https://github.com/hashicorp/terraform-provider-google

## Add labels and annotations support

The new labels model and the new annotations model are introduced in [Terraform Google Provider 5.0.0](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/version_5_upgrade#provider).
The new labels model and the new annotations model are introduced in [Terraform provider for Google Cloud 5.0.0](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/version_5_upgrade#provider).

There are now three label-related fields with the new labels model:
* The `labels` field is now non-authoritative and only manages the label keys defined in your configuration for the resource.
Expand Down Expand Up @@ -189,4 +189,4 @@ if err := tpgresource.SetDataSourceAnnotations(d); err != nil {
6. In the read mehtod, set `annotations`, and `effective_annotations` to state.
7. In the handwritten acceptance tests, add `annotations` to `ImportStateVerifyIgnore`.
8. In the corresponding data source, after the resource read method, call the function `tpgresource.SetDataSourceAnnotations(d)` to make `annotations` have all of the labels on the resource.
9. Add the documentation for these annotation-related fields.
9. Add the documentation for these annotation-related fields.
12 changes: 6 additions & 6 deletions docs/content/develop/breaking-changes/make-a-breaking-change.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ The `google` and `google-beta` providers are both considered "stable surfaces"
for the purpose of releases, which means that neither provider allows breaking
changes except during major releases, which are typically yearly.

Terraform users rely on the stability of Terraform providers (including the GCP
provider and other major providers.) Even as part of a major release, breaking
changes that are overly broad and/or have little benefit to users can cause
deeply negative reactions and significantly delay customers upgrading to the
new major version.
Terraform users rely on the stability of Terraform providers (including the
Google Cloud provider and other major providers.) Even as part of a major
release, breaking changes that are overly broad and/or have little benefit to
users can cause deeply negative reactions and significantly delay customers
upgrading to the new major version.

Breaking changes may cause significant churn for users by forcing them to
update their configurations. It also causes churn in tooling built on top of
Expand Down Expand Up @@ -177,7 +177,7 @@ Entries should focus on the changes that users need to make when upgrading
to `{{% param "majorVersion" %}}`, rather than how to write configurations
after upgrading.

See [Terraform Google Provider 4.0.0 Upgrade Guide](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/version_4_upgrade)
See [Terraform provider for Google Cloud 4.0.0 Upgrade Guide](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/version_4_upgrade)
and other upgrade guides for examples.

The upgrade guide and the actual breaking change will be merged only after both are completed.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/get-started/how-magic-modules-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ aliases:

# How Magic Modules works

Magic Modules can be thought of as a source of truth for how to map a GCP API resource representation to a Terraform resource (or datasource) representation. Magic Modules uses that mapping (and additional handwritten code where necessary) to generate "downstream" repositories - in particular, the Terraform providers for Google Platform: [`google`](https://github.com/hashicorp/terraform-provider-google) (or TPG) and [`google-beta`](https://github.com/hashicorp/terraform-provider-google-beta) (or TPGB).
Magic Modules can be thought of as a source of truth for how to map a GCP API resource representation to a Terraform resource (or datasource) representation. Magic Modules uses that mapping (and additional handwritten code where necessary) to generate "downstream" repositories - in particular, the Terraform providers for Google Cloud: [`google`](https://github.com/hashicorp/terraform-provider-google) (or TPG) and [`google-beta`](https://github.com/hashicorp/terraform-provider-google-beta) (or TPGB).

Generation of the downstream repositories happens for every new commit in a PR (to a temporary branch owned by the [`modular-magician`](https://github.com/modular-magician/) robot user) and on every merge into the main branch (to the main branch of downstreams). Generation for PR commits allows contributors to manually examine the changes, as well as allowing automatic running of unit tests, acceptance tests, and automated checks such as breaking change detection.

Expand Down
4 changes: 2 additions & 2 deletions mmv1/third_party/terraform/META.d/_summary.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ partition: tf-ecosystem
summary:
owner: team-tf-hybrid-cloud
description: |
The Terraform Google provider is a plugin that allows Terraform to manage resources on Google Cloud Platform.
The Terraform provider for Google Cloud is a plugin that allows Terraform to manage resources on Google Cloud.
visibility: external
visibility: external
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
page_title: "Getting Started with the Google provider"
page_title: "Getting Started with the Google Cloud provider"
description: |-
Getting started with the Google Cloud Platform provider
Getting started with the Google Cloud provider
---

# Getting Started with the Google Provider
# Getting Started with the Google Cloud provider

## Before you begin

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
page_title: "Google Provider Configuration Reference"
page_title: "Google Cloud Provider Configuration Reference"
description: |-
Configuration reference for the Google provider for Terraform.
Configuration reference for the Terraform provider for Google Cloud.
---

# Google Provider Configuration Reference
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
page_title: "Terraform Google Provider 2.0.0 Upgrade Guide"
page_title: "Terraform provider for Google Cloud 2.0.0 Upgrade Guide"
description: |-
Terraform Google Provider 2.0.0 Upgrade Guide
Terraform provider for Google Cloud 2.0.0 Upgrade Guide
---

# Terraform Google Provider 2.0.0 Upgrade Guide
# Terraform provider for Google Cloud 2.0.0 Upgrade Guide

Version `2.0.0` of the Google provider for Terraform is a major release and
Version `2.0.0` of the Terraform provider for Google Cloud is a major release and
includes some changes that you will need to consider when upgrading. This guide
is intended to help with that process and focuses only on the changes necessary
to upgrade from version `1.20.0` to `2.0.0`.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
page_title: "Terraform Google Provider 3.0.0 Upgrade Guide"
page_title: "Terraform provider for Google Cloud 3.0.0 Upgrade Guide"
description: |-
Terraform Google Provider 3.0.0 Upgrade Guide
Terraform provider for Google Cloud 3.0.0 Upgrade Guide
---

# Terraform Google Provider 3.0.0 Upgrade Guide
# Terraform provider for Google Cloud 3.0.0 Upgrade Guide

The `3.0.0` release of the Google provider for Terraform is a major version and
The `3.0.0` release of the Terraform provider for Google Cloud is a major version and
includes some changes that you will need to consider when upgrading. This guide
is intended to help with that process and focuses only on the changes necessary
to upgrade from the final `2.X` series release to `3.0.0`.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
page_title: "Terraform Google Provider 4.0.0 Upgrade Guide"
page_title: "Terraform provider for Google Cloud 4.0.0 Upgrade Guide"
description: |-
Terraform Google Provider 4.0.0 Upgrade Guide
Terraform provider for Google Cloud 4.0.0 Upgrade Guide
---

# Terraform Google Provider 4.0.0 Upgrade Guide
# Terraform provider for Google Cloud 4.0.0 Upgrade Guide

The `4.0.0` release of the Google provider for Terraform is a major version and
The `4.0.0` release of the Terraform provider for Google Cloud is a major version and
includes some changes that you will need to consider when upgrading. This guide
is intended to help with that process and focuses only on the changes necessary
to upgrade from the final `3.X` series release to `4.0.0`.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
page_title: "Terraform Google Provider 5.0.0 Upgrade Guide"
page_title: "Terraform provider for Google Cloud 5.0.0 Upgrade Guide"
description: |-
Terraform Google Provider 5.0.0 Upgrade Guide
Terraform provider for Google Cloud 5.0.0 Upgrade Guide
---

# Terraform Google Provider 5.0.0 Upgrade Guide
# Terraform provider for Google Cloud 5.0.0 Upgrade Guide

The `5.0.0` release of the Google provider for Terraform is a major version and
The `5.0.0` release of the Terraform provider for Google Cloud is a major version and
includes some changes that you will need to consider when upgrading. This guide
is intended to help with that process and focuses only on the changes necessary
to upgrade from the final `4.X` series release to `5.0.0`.
Expand Down Expand Up @@ -113,8 +113,8 @@ included in requests to the API. Replacing those labels' values with `_` or
`true` are recommended.

Not all of Google Cloud resources support labels and annotations. Please check
the Terraform Google provider resource documentation to figure out if a given
resource supports `labels` or `annotations` fields.
the resource documentation to figure out if a given resource supports `labels`
or `annotations` fields.

#### Provider default labels

Expand Down Expand Up @@ -188,7 +188,7 @@ Provider-level default annotations are not supported at this time.

#### Resource labels

Previously, `labels` and `annotations` fields in the Terraform Google provider
Previously, `labels` and `annotations` fields in the Google Cloud provider
were authoritative and Terraform thought it was the only owner of the fields.
This model worked well initially, but with the introduction of system labels and
other client-managed labels, Terraform would conflict with their labels and show
Expand Down
30 changes: 15 additions & 15 deletions mmv1/third_party/terraform/website/docs/index.html.markdown
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
page_title: "Provider: Google Cloud Platform"
page_title: "Provider: Google Cloud"
description: |-
The Google provider is used to configure your Google Cloud Platform infrastructure
The Terraform provider for Google Cloud is used to configure your Google Cloud infrastructure
---

# Google Cloud Platform Provider
# Terraform provider for Google Cloud

The Google provider is used to configure your [Google Cloud Platform](https://cloud.google.com/) infrastructure.
The Google Cloud provider is used to configure your [Google Cloud](https://cloud.google.com/) infrastructure.

To learn the basics of Terraform using this provider, follow the hands-on
[get started tutorials](https://developer.hashicorp.com/terraform/tutorials/gcp-get-started/infrastructure-as-code).
For more involved examples, try [provisioning a GKE cluster](https://learn.hashicorp.com/tutorials/terraform/gke)
and deploying [Consul-backed Vault into it using Terraform Cloud](https://learn.hashicorp.com/tutorials/terraform/kubernetes-consul-vault-pipeline).

Already experienced with Terraform? Check out the [Getting Started](/docs/providers/google/guides/getting_started.html)
page for a short introduction to using Terraform with Google Cloud Platform.
page for a short introduction to using Terraform with Google Cloud.

## Example Usage

Expand All @@ -31,17 +31,17 @@ See the [provider reference](/docs/providers/google/guides/provider_reference.ht
page for details on authentication and configuring the provider.

Take advantage of [Modules](https://www.terraform.io/docs/modules/index.html)
to simplify your config by browsing the [Module Registry for GCP modules](https://registry.terraform.io/browse?provider=google).
to simplify your config by browsing the [Module Registry for Google Cloud modules](https://registry.terraform.io/browse?provider=google).

The Google provider is jointly maintained by:
The Google Cloud provider is jointly maintained by:

* The [Terraform Team](https://cloud.google.com/docs/terraform) at Google
* The Terraform team at [HashiCorp](https://www.hashicorp.com/)

If you have configuration questions, or general questions about using the provider, try checking out:

* [The Google category on discuss.hashicorp.com](https://discuss.hashicorp.com/c/terraform-providers/tf-google/32)
* The [Google Cloud Platform Community Slack](https://googlecloud-community.slack.com/) `#terraform` channel. If you are not registered with that Slack Workspace yet, the up-to-date **public sign-up link** can be found in the "Stay Connected" section of the [Google Developer Center](https://cloud.google.com/developers#stay-connected).
* The [Google Cloud Community Slack](https://googlecloud-community.slack.com/) `#terraform` channel. If you are not registered with that Slack Workspace yet, the up-to-date **public sign-up link** can be found in the "Stay Connected" section of the [Google Developer Center](https://cloud.google.com/developers#stay-connected).
* [Terraform's community resources](https://www.terraform.io/docs/extend/community/index.html)
* [HashiCorp support](https://support.hashicorp.com) for Terraform Enterprise customers

Expand All @@ -53,22 +53,22 @@ and the [`google-beta` provider Releases](https://github.com/hashicorp/terraform
for release notes and additional information.

Per [Terraform Provider Versioning](https://www.hashicorp.com/blog/hashicorp-terraform-provider-versioning),
the Google provider follows [semantic versioning](https://semver.org/).
the Google Cloud provider follows [semantic versioning](https://semver.org/).

In practice, patch / bugfix-only releases of the provider are infrequent. Most
provider releases are either minor or major releases.

### Minor Releases

The Google provider currently aims to publish a minor release every week,
The Google Cloud provider currently aims to publish a minor release every week,
although the timing of individual releases may differ if required by the
provider team.

### Major Releases

The Google provider publishes major releases roughly yearly. An upgrade guide
will be published to help ease you through the transition between the prior
releases series and the new major release.
The Google Cloud provider publishes major releases roughly yearly. An upgrade
guide will be published to help ease you through the transition between the
prior releases series and the new major release.

During major releases, all current deprecation warnings will be resolved,
removing the field in question unless the deprecation warning message specifies
Expand All @@ -80,7 +80,7 @@ lifecycle to give users plenty of time to safely update their configs.

## Features and Bug Requests

The Google provider's bugs and feature requests can be found in the [GitHub repo issues](https://github.com/hashicorp/terraform-provider-google/issues).
The Google Cloud provider's bugs and feature requests can be found in the [GitHub repo issues](https://github.com/hashicorp/terraform-provider-google/issues).
Please avoid "me too" or "+1" comments. Instead, use a thumbs up [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/)
on enhancement requests. Provider maintainers will often prioritize work based on the
number of thumbs on an issue.
Expand Down Expand Up @@ -110,7 +110,7 @@ page for details on configuring the provider.

## Contributing

If you'd like to help extend the Google provider, we gladly accept community
If you'd like to help extend the Google Cloud provider, we gladly accept community
contributions! Development on the providers is done through the
[Magic Modules](https://github.com/GoogleCloudPlatform/magic-modules)
repository. Our full contribution guide is available on the
Expand Down
3 changes: 1 addition & 2 deletions tools/go-changelog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,7 @@ formatting.

## Prior Art

This package is based on a bunch of experiments with the [Google Cloud Platform
Terraform provider](https://github.com/terraform-providers/terraform-provider-google)
This package is based on a bunch of experiments with the [Terraform provider for Google Cloud](https://github.com/terraform-providers/terraform-provider-google)
and the lessons learned while generating it. It is also based on prior art in
the community:

Expand Down
4 changes: 2 additions & 2 deletions tpgtools/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# tpgtools

`tpgtools` is the generator responsible for creating DCL-based resources in the
Terraform Google Provider (TPG). The DCL provides
Terraform provider for Google Cloud (TPG). The DCL provides
[OpenAPI schema objects](https://swagger.io/specification/#schema-object) to
describe the available types, and `tpgtools` uses those to construct Terraform
resource schemas.
Expand Down Expand Up @@ -55,7 +55,7 @@ go run . --path "api" --overrides "overrides" --output ~/some/dir --mode "serial
## New Resource Guide

This guide is written to document the process for adding a resource to the
Google Terraform Provider (TPG) after it has been added to the
Terraform provider for Google Cloud (TPG) after it has been added to the
[DCL](https://github.com/GoogleCloudPlatform/declarative-resource-client-library).

### Adding Resource Overrides
Expand Down

0 comments on commit 9f7697a

Please sign in to comment.