mirror of
https://github.com/letic/terraform-provider-google.git
synced 2024-07-22 17:46:01 +00:00
118 lines
4.4 KiB
Markdown
118 lines
4.4 KiB
Markdown
---
|
|
layout: "google"
|
|
page_title: "Provider: Google Cloud"
|
|
sidebar_current: "docs-google-index"
|
|
description: |-
|
|
The Google Cloud provider is used to interact with Google Cloud services. The provider needs to be configured with the proper credentials before it can be used.
|
|
---
|
|
|
|
# Google Cloud Provider
|
|
|
|
The Google Cloud provider is used to interact with
|
|
[Google Cloud services](https://cloud.google.com/). The provider needs
|
|
to be configured with the proper credentials before it can be used.
|
|
|
|
Use the navigation to the left to read about the available resources.
|
|
|
|
## Example Usage
|
|
|
|
```hcl
|
|
// Configure the Google Cloud provider
|
|
provider "google" {
|
|
credentials = "${file("account.json")}"
|
|
project = "my-gce-project-id"
|
|
region = "us-central1"
|
|
}
|
|
|
|
// Create a new instance
|
|
resource "google_compute_instance" "default" {
|
|
# ...
|
|
}
|
|
```
|
|
|
|
## Configuration Reference
|
|
|
|
The following keys can be used to configure the provider.
|
|
|
|
* `credentials` - (Optional) Contents of a file that contains your service
|
|
account private key in JSON format. You can download this file from the
|
|
Google Cloud Console. More details on retrieving this file are below.
|
|
|
|
Credentials can also be specified using any of the following environment
|
|
variables (listed in order of precedence):
|
|
|
|
* `GOOGLE_CREDENTIALS`
|
|
* `GOOGLE_CLOUD_KEYFILE_JSON`
|
|
* `GCLOUD_KEYFILE_JSON`
|
|
|
|
The [`GOOGLE_APPLICATION_CREDENTIALS`](https://developers.google.com/identity/protocols/application-default-credentials#howtheywork)
|
|
environment variable can also contain the path of a file to obtain credentials
|
|
from.
|
|
|
|
If no credentials are specified, the provider will fall back to using the
|
|
[Google Application Default
|
|
Credentials](https://developers.google.com/identity/protocols/application-default-credentials).
|
|
If you are running Terraform from a GCE instance, see [Creating and Enabling
|
|
Service Accounts for
|
|
Instances](https://cloud.google.com/compute/docs/authentication) for
|
|
details. On your computer, if you have made your identity available as the
|
|
Application Default Credentials by running [`gcloud auth application-default
|
|
login`](https://cloud.google.com/sdk/gcloud/reference/auth/application-default/login),
|
|
the provider will use your identity.
|
|
|
|
* `project` - (Optional) The ID of the project to apply any resources to. This
|
|
can also be specified using any of the following environment variables (listed
|
|
in order of precedence):
|
|
|
|
* `GOOGLE_PROJECT`
|
|
* `GOOGLE_CLOUD_PROJECT`
|
|
* `GCLOUD_PROJECT`
|
|
* `CLOUDSDK_CORE_PROJECT`
|
|
|
|
* `region` - (Optional) The region to operate under, if not specified by a given resource.
|
|
This can also be specified using any of the following environment variables (listed in order of
|
|
precedence):
|
|
|
|
* `GOOGLE_REGION`
|
|
* `GCLOUD_REGION`
|
|
* `CLOUDSDK_COMPUTE_REGION`
|
|
|
|
* `zone` - (Optional) The zone to operate under, if not specified by a given resource.
|
|
This can also be specified using any of the following environment variables (listed in order of
|
|
precedence):
|
|
|
|
* `GOOGLE_ZONE`
|
|
* `GCLOUD_ZONE`
|
|
* `CLOUDSDK_COMPUTE_ZONE`
|
|
|
|
## Authentication JSON File
|
|
|
|
Authenticating with Google Cloud services requires a JSON
|
|
file which we call the _account file_.
|
|
|
|
This file is downloaded directly from the
|
|
[Google Developers Console](https://console.developers.google.com). To make
|
|
the process more straightforwarded, it is documented here:
|
|
|
|
1. Log into the [Google Developers Console](https://console.developers.google.com)
|
|
and select a project.
|
|
|
|
2. The API Manager view should be selected, click on "Credentials" on the left,
|
|
then "Create credentials", and finally "Service account key".
|
|
|
|
3. Select "Compute Engine default service account" in the "Service account"
|
|
dropdown, and select "JSON" as the key type.
|
|
|
|
4. Clicking "Create" will download your `credentials`.
|
|
|
|
## Beta Features
|
|
|
|
Some Google Provider resources contain Beta features; Beta GCP Features have no
|
|
deprecation policy, and no SLA, but are otherwise considered to be feature-complete
|
|
with only minor outstanding issues after their Alpha period. Beta is when a GCP feature
|
|
is publicly announced, and is when they generally become publicly available.
|
|
|
|
Terraform resources that support beta features will always use the Beta APIs to provision
|
|
the resource. Importing a resource that supports beta features will always import those
|
|
features, even if the resource was created in a matter that was not explicitly beta.
|