Spell out how to configure credentials for GCS. (#10589)

This commit is contained in:
Nick Cabatoff 2021-01-20 09:09:23 -05:00 committed by GitHub
parent 8cbc63d572
commit b93c5ff304
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 1 deletions

View File

@ -87,7 +87,23 @@ other mechanisms to provide access to cloud resources.
- `google_gcs_bucket` `(string: <required>)` GCS bucket to write snapshots to.
- `google_service_account_key` `(string)` - Google service account key in JSON format
- `google_service_account_key` `(string)` - Google service account key in JSON format. Depending
on how the API is invoked, this may be need to be JSON-escaped, e.g. for newlines and double quotes.
The raw value looks like this:
```json
{
"type": "service_account",
"project_id": "project-id",
"private_key_id": "key-id",
"private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpQ ... /WZs=\n-----END RSA PRIVATE KEY-----\n",
"client_email": "service-account-email",
"client_id": "client-id",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://accounts.google.com/o/oauth2/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/service-account-email"
}
```
- `google_endpoint` `(string)` - GCS endpoint. This is typically only set when
using a non-Google GCS implementation like fake-gcs-server.