Skip to content

Commit d4f9c1e

Browse files
authored
Specify optional configuration for gcp-auth-extension (#1845)
1 parent 95c17fe commit d4f9c1e

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

gcp-auth-extension/README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,20 @@ These credentials are built-in running in a Google App Engine, Google Cloud Shel
3232

3333
The extension can be configured either by environment variables or system properties.
3434

35-
Here is a list of configurable options for the extension:
35+
Here is a list of required and optional configuration available for the extension:
36+
37+
#### Required Config
3638

3739
- `GOOGLE_CLOUD_PROJECT`: Environment variable that represents the Google Cloud Project ID to which the telemetry needs to be exported.
40+
3841
- Can also be configured using `google.cloud.project` system property.
3942
- This is a required option, the agent configuration will fail if this option is not set.
40-
- `GOOGLE_CLOUD_QUOTA_PROJECT`: Environment variable that represents the Google Cloud Quota Project ID which will be charged for the GCP API usage. To learn more about a *quota project*, see [here](https://cloud.google.com/docs/quotas/quota-project).
43+
44+
#### Optional Config
45+
46+
- `GOOGLE_CLOUD_QUOTA_PROJECT`: Environment variable that represents the Google Cloud Quota Project ID which will be charged for the GCP API usage. To learn more about a *quota project*, see [here](https://cloud.google.com/docs/quotas/quota-project). Additional details about configuring the *quota project* can be found [here](https://cloud.google.com/docs/quotas/set-quota-project).
47+
4148
- Can also be configured using `google.cloud.quota.project` system property.
42-
- If this option is not configured, the extension will use the Quota Project ID found in the Application Default Credentials (ADC), if available. For more information on application default credentials, see [here](https://cloud.google.com/docs/authentication/application-default-credentials).
4349

4450
## Usage
4551

0 commit comments

Comments
 (0)