Skip to content

Commit f991938

Browse files
authored
chore: remove credentials_path from docs (#672)
1 parent e444e2a commit f991938

File tree

1 file changed

+13
-38
lines changed

1 file changed

+13
-38
lines changed

README.md

+13-38
Original file line numberDiff line numberDiff line change
@@ -253,44 +253,19 @@ permissions:
253253

254254
#### Specifying credentials
255255

256-
The Project Factory uses external scripts to perform a few tasks that are not implemented
257-
by Terraform providers. Because of this the Project Factory needs a copy of service account
258-
credentials to pass to these scripts. Credentials can be provided via two mechanisms:
259-
260-
1. Explicitly passed to the Project Factory with the `credentials_path` variable. This approach
261-
typically uses the same credentials for the `google` provider and the Project Factory:
262-
```terraform
263-
provider "google" {
264-
credentials = "${file(var.credentials_path)}"
265-
version = "~> 3.3"
266-
}
267-
268-
module "project-factory" {
269-
source = "terraform-google-modules/project-factory/google"
270-
271-
name = "explicit-credentials"
272-
credentials_path = "${var.credentials_path}"
273-
# other variables follow ...
274-
}
275-
```
276-
2. Implicitly provided by the [Application Default Credentials][application-default-credentials]
277-
flow, which typically uses the `GOOGLE_APPLICATION_CREDENTIALS` environment variable:
278-
```terraform
279-
# `GOOGLE_APPLICATION_CREDENTIALS` must be set in the environment before Terraform is run.
280-
provider "google" {
281-
# Terraform will check the `GOOGLE_APPLICATION_CREDENTIALS` variable, so no `credentials`
282-
# value is needed here.
283-
version = "~> 3.3"
284-
}
285-
286-
module "project-factory" {
287-
source = "terraform-google-modules/project-factory/google"
288-
289-
name = "adc-credentials"
290-
# Project Factory will also check the `GOOGLE_APPLICATION_CREDENTIALS` environment variable.
291-
# other variables follow ...
292-
}
293-
```
256+
The Project Factory module uses the [Google Terraform provider](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_reference#authentication)
257+
to authenticate all GCP API calls.
258+
To configure credentials, you should configure the `google` and `google-beta` providers.
259+
260+
```terraform
261+
provider "google" {
262+
credentials = "${file(var.credentials_path)}"
263+
}
264+
265+
provider "google-beta" {
266+
credentials = "${file(var.credentials_path)}"
267+
}
268+
```
294269

295270
### APIs
296271

0 commit comments

Comments
 (0)