Skip to content
This repository has been archived by the owner on Jun 27, 2021. It is now read-only.

WIP: Improve authentication instructions in provider documentation #156

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all 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
11 changes: 6 additions & 5 deletions website/docs/index.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,12 @@ The provider configuration block accepts the following arguments.
In most cases it is recommended to set them via the indicated environment
variables in order to keep credential information out of the configuration.

* `credentials` - (Optional) Path to or string content of your credentials. If
you have authenticated using `gcloud auth login` and want to test using your
personal account you may leave this empty. May be set via the
`GOOGLE_CREDENTIALS`, `GOOGLE_CLOUD_KEYFILE_JSON`, `GOOGLE_KEYFILE_JSON`,
`GOOGLE_APPLICATION_CREDENTIALS` environment variables.
* `credentials` - (Optional) Path to or string content of your credentials.
May be set via the `GOOGLE_CREDENTIALS`, `GOOGLE_CLOUD_KEYFILE_JSON`,
`GOOGLE_KEYFILE_JSON`, `GOOGLE_APPLICATION_CREDENTIALS` environment variables.
You can also use [application default credentials](https://cloud.google.com/docs/authentication/production)
by letting all of those empty. To test using your personal account, you can
set it as application default credentials with `gcloud auth application-default login`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's better to use the same wording as hashicorp/terraform-provider-google, not the test premise.

ref: https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_reference#full-reference


* `impersonated_user_email` - (Optional) Service accounts cannot be granted
access to the Admin API SDK, therefore the service account needs to
Expand Down