ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

website/docs/backends/types/gcs.html.md: Update. 

* Remove the (unused) "project" option.
* Mark the "credentials" option as optional; document behavior when
  unset.
* Mark the "path" option as deprecated (was: legacy) to match
  Terraform's terminology.
This commit is contained in:
Florian Forster 2017-09-12 11:12:23 +02:00 committed by James Bardin
parent 816c98f387
commit 5205c63bc9
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
website/docs/backends/types/gcs.html.md
View File

@ -17,7 +17,6 @@ Stores the state as an object in a configurable prefix and bucket on [Google Clo
```hcl ```hcl
terraform { terraform {
backend "gcs" { backend "gcs" {
project = "myproject"
bucket = "tf-state-prod" bucket = "tf-state-prod"
prefix = "terraform/state" prefix = "terraform/state"
} }
@ -30,7 +29,6 @@ terraform {
data "terraform_remote_state" "foo" { data "terraform_remote_state" "foo" {
backend = "gcs" backend = "gcs"
config { config {
project = "goopro"
bucket = "terraform-state" bucket = "terraform-state"
prefix = "prod" prefix = "prod"
} }
@ -50,6 +48,7 @@ resource "template_file" "bar" {
The following configuration options are supported: The following configuration options are supported:
* `bucket` - (Required) The name of the GCS bucket. * `bucket` - (Required) The name of the GCS bucket.
* `credentials` / `GOOGLE_CREDENTIALS` - (Required) Local path to Google Cloud Platform account credentials in JSON format. * `credentials` / `GOOGLE_CREDENTIALS` - (Optional) Local path to Google Cloud Platform account credentials in JSON format.
If unset, [Google Application Default Credentials](https://developers.google.com/identity/protocols/application-default-credentials) are used.
* `prefix` - (Optional) GCS prefix inside the bucket. Named states are stored in an object called `<prefix>/<name>.tfstate`. * `prefix` - (Optional) GCS prefix inside the bucket. Named states are stored in an object called `<prefix>/<name>.tfstate`.
* `path` - (Legacy) GCS path to the state file of the default state. For backwards compatibility only, use `prefix` instead. * `path` - (Deprecated) GCS path to the state file of the default state. For backwards compatibility only, use `prefix` instead.