Skip to content

docs: remove references to ADC environment variable #14914

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dbolduc merged 8 commits into from
Dec 30, 2024
Merged

docs: remove references to ADC environment variable #14914

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0156205
docs: remove references to ADC envrionment variable
coryan Dec 28, 2024
550699a
Restore references to the roles needed by the benchmark principal
coryan Dec 28, 2024
de08547
Another special file
coryan Dec 28, 2024
d2cf3a4
Maybe I should move this workspace to Linux so I can run checkers
coryan Dec 28, 2024
2054851
Change link
coryan Dec 30, 2024
d881721
Reformat and fix a few files I missed
coryan Dec 30, 2024
779c18b
Fix authentication quickstart link
coryan Dec 30, 2024
41ebc8e
Fix formatting
coryan Dec 30, 2024
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
21 changes: 2 additions & 19 deletions generator/internal/scaffold_generator.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -779,24 +779,7 @@ To run the quickstart examples you will need a working Google Cloud Platform
Like most Google Cloud Platform (GCP) services, $title$ requires that
your application authenticates with the service before accessing any data. If
you are not familiar with GCP authentication please take this opportunity to
review the [Authentication Overview][authentication-quickstart]. This library
uses the `GOOGLE_APPLICATION_CREDENTIALS` environment variable to find the
credentials file. For example:

| Shell | Command |
| :----------------- | ---------------------------------------------- |
| Bash/zsh/ksh/etc. | `export GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |
| sh | `GOOGLE_APPLICATION_CREDENTIALS=[PATH];`<br> `export GOOGLE_APPLICATION_CREDENTIALS` |
| csh/tsch | `setenv GOOGLE_APPLICATION_CREDENTIALS [PATH]` |
| Windows Powershell | `$$env:GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |
| Windows cmd.exe | `set GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |

Setting this environment variable is the recommended way to configure the
authentication preferences, though if the environment variable is not set, the
library searches for a credentials file in the same location as the [Cloud
SDK](https://cloud.google.com/sdk/). For more information about *Application
Default Credentials*, see
https://cloud.google.com/docs/authentication/production
review the [Authentication methods at Google][authentication-quickstart].

## Using with Bazel

Expand Down Expand Up @@ -897,7 +880,7 @@ set GRPC_DEFAULT_SSL_ROOTS_FILE_PATH=%cd%\roots.pem
[choco-cmake-link]: https://chocolatey.org/packages/cmake
[homebrew-cmake-link]: https://formulae.brew.sh/formula/cmake
[cmake-download-link]: https://cmake.org/download/
[authentication-quickstart]: https://cloud.google.com/docs/authentication/getting-started 'Authentication Getting Started'
[authentication-quickstart]: https://cloud.google.com/docs/authentication 'Authentication methods at Google'
)""";
google::protobuf::io::OstreamOutputStream output(&os);
google::protobuf::io::Printer printer(&output, '$');
Expand Down
21 changes: 2 additions & 19 deletions google/cloud/accessapproval/quickstart/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,24 +29,7 @@ detail.
Like most Google Cloud Platform (GCP) services, Access Approval requires that
your application authenticates with the service before accessing any data. If
you are not familiar with GCP authentication please take this opportunity to
review the [Authentication Overview][authentication-quickstart]. This library
uses the `GOOGLE_APPLICATION_CREDENTIALS` environment variable to find the
credentials file. For example:

| Shell | Command |
| :----------------- | ------------------------------------------------------------------------------------ |
| Bash/zsh/ksh/etc. | `export GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |
| sh | `GOOGLE_APPLICATION_CREDENTIALS=[PATH];`<br> `export GOOGLE_APPLICATION_CREDENTIALS` |
| csh/tsch | `setenv GOOGLE_APPLICATION_CREDENTIALS [PATH]` |
| Windows Powershell | `$env:GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |
| Windows cmd.exe | `set GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |

Setting this environment variable is the recommended way to configure the
authentication preferences, though if the environment variable is not set, the
library searches for a credentials file in the same location as the
[Cloud SDK](https://cloud.google.com/sdk/). For more information about
*Application Default Credentials*, see
https://cloud.google.com/docs/authentication/production
review the [Authentication methods at Google][authentication-quickstart].

## Using with Bazel

Expand Down Expand Up @@ -142,7 +125,7 @@ trust store for SSL certificates, you can download and configure this using:
set GRPC_DEFAULT_SSL_ROOTS_FILE_PATH=%cd%\roots.pem
```

[authentication-quickstart]: https://cloud.google.com/docs/authentication/getting-started "Authentication Getting Started"
[authentication-quickstart]: https://cloud.google.com/docs/authentication "Authentication methods at Google"
[bazel-install]: https://docs.bazel.build/versions/main/install.html
[choco-cmake-link]: https://chocolatey.org/packages/cmake
[grpc-roots-pem-bug]: https://github.com/grpc/grpc/issues/16571
Expand Down
22 changes: 3 additions & 19 deletions google/cloud/accesscontextmanager/quickstart/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,24 +29,8 @@ detail.
Like most Google Cloud Platform (GCP) services, Access Context Manager API
requires that your application authenticates with the service before accessing
any data. If you are not familiar with GCP authentication please take this
opportunity to review the [Authentication Overview][authentication-quickstart].
This library uses the `GOOGLE_APPLICATION_CREDENTIALS` environment variable to
find the credentials file. For example:

| Shell | Command |
| :----------------- | ------------------------------------------------------------------------------------ |
| Bash/zsh/ksh/etc. | `export GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |
| sh | `GOOGLE_APPLICATION_CREDENTIALS=[PATH];`<br> `export GOOGLE_APPLICATION_CREDENTIALS` |
| csh/tsch | `setenv GOOGLE_APPLICATION_CREDENTIALS [PATH]` |
| Windows Powershell | `$env:GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |
| Windows cmd.exe | `set GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |

Setting this environment variable is the recommended way to configure the
authentication preferences, though if the environment variable is not set, the
library searches for a credentials file in the same location as the
[Cloud SDK](https://cloud.google.com/sdk/). For more information about
*Application Default Credentials*, see
https://cloud.google.com/docs/authentication/production
opportunity to review the
[Authentication methods at Google][authentication-quickstart].

## Using with Bazel

Expand Down Expand Up @@ -142,7 +126,7 @@ trust store for SSL certificates, you can download and configure this using:
set GRPC_DEFAULT_SSL_ROOTS_FILE_PATH=%cd%\roots.pem
```

[authentication-quickstart]: https://cloud.google.com/docs/authentication/getting-started "Authentication Getting Started"
[authentication-quickstart]: https://cloud.google.com/docs/authentication "Authentication methods at Google"
[bazel-install]: https://docs.bazel.build/versions/main/install.html
[choco-cmake-link]: https://chocolatey.org/packages/cmake
[grpc-roots-pem-bug]: https://github.com/grpc/grpc/issues/16571
Expand Down
22 changes: 3 additions & 19 deletions google/cloud/advisorynotifications/quickstart/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,24 +35,8 @@ detail.
Like most Google Cloud Platform (GCP) services, Advisory Notifications API
requires that your application authenticates with the service before accessing
any data. If you are not familiar with GCP authentication please take this
opportunity to review the [Authentication Overview][authentication-quickstart].
This library uses the `GOOGLE_APPLICATION_CREDENTIALS` environment variable to
find the credentials file. For example:

| Shell | Command |
| :----------------- | ------------------------------------------------------------------------------------ |
| Bash/zsh/ksh/etc. | `export GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |
| sh | `GOOGLE_APPLICATION_CREDENTIALS=[PATH];`<br> `export GOOGLE_APPLICATION_CREDENTIALS` |
| csh/tsch | `setenv GOOGLE_APPLICATION_CREDENTIALS [PATH]` |
| Windows Powershell | `$env:GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |
| Windows cmd.exe | `set GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |

Setting this environment variable is the recommended way to configure the
authentication preferences, though if the environment variable is not set, the
library searches for a credentials file in the same location as the
[Cloud SDK](https://cloud.google.com/sdk/). For more information about
*Application Default Credentials*, see
https://cloud.google.com/docs/authentication/production
opportunity to review the
[Authentication methods at Google][authentication-quickstart].

## Using with Bazel

Expand Down Expand Up @@ -148,7 +132,7 @@ trust store for SSL certificates, you can download and configure this using:
set GRPC_DEFAULT_SSL_ROOTS_FILE_PATH=%cd%\roots.pem
```

[authentication-quickstart]: https://cloud.google.com/docs/authentication/getting-started "Authentication Getting Started"
[authentication-quickstart]: https://cloud.google.com/docs/authentication "Authentication methods at Google"
[bazel-install]: https://docs.bazel.build/versions/main/install.html
[choco-cmake-link]: https://chocolatey.org/packages/cmake
[grpc-roots-pem-bug]: https://github.com/grpc/grpc/issues/16571
Expand Down
21 changes: 2 additions & 19 deletions google/cloud/aiplatform/quickstart/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,24 +32,7 @@ detail.
Like most Google Cloud Platform (GCP) services, Vertex AI API requires that your
application authenticates with the service before accessing any data. If you are
not familiar with GCP authentication please take this opportunity to review the
[Authentication Overview][authentication-quickstart]. This library uses the
`GOOGLE_APPLICATION_CREDENTIALS` environment variable to find the credentials
file. For example:

| Shell | Command |
| :----------------- | ------------------------------------------------------------------------------------ |
| Bash/zsh/ksh/etc. | `export GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |
| sh | `GOOGLE_APPLICATION_CREDENTIALS=[PATH];`<br> `export GOOGLE_APPLICATION_CREDENTIALS` |
| csh/tsch | `setenv GOOGLE_APPLICATION_CREDENTIALS [PATH]` |
| Windows Powershell | `$env:GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |
| Windows cmd.exe | `set GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |

Setting this environment variable is the recommended way to configure the
authentication preferences, though if the environment variable is not set, the
library searches for a credentials file in the same location as the
[Cloud SDK](https://cloud.google.com/sdk/). For more information about
*Application Default Credentials*, see
https://cloud.google.com/docs/authentication/production
[Authentication methods at Google][authentication-quickstart].

## Using with Bazel

Expand Down Expand Up @@ -145,7 +128,7 @@ trust store for SSL certificates, you can download and configure this using:
set GRPC_DEFAULT_SSL_ROOTS_FILE_PATH=%cd%\roots.pem
```

[authentication-quickstart]: https://cloud.google.com/docs/authentication/getting-started "Authentication Getting Started"
[authentication-quickstart]: https://cloud.google.com/docs/authentication "Authentication methods at Google"
[bazel-install]: https://docs.bazel.build/versions/main/install.html
[choco-cmake-link]: https://chocolatey.org/packages/cmake
[grpc-roots-pem-bug]: https://github.com/grpc/grpc/issues/16571
Expand Down
21 changes: 2 additions & 19 deletions google/cloud/alloydb/quickstart/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,24 +35,7 @@ detail.
Like most Google Cloud Platform (GCP) services, AlloyDB API requires that your
application authenticates with the service before accessing any data. If you are
not familiar with GCP authentication please take this opportunity to review the
[Authentication Overview][authentication-quickstart]. This library uses the
`GOOGLE_APPLICATION_CREDENTIALS` environment variable to find the credentials
file. For example:

| Shell | Command |
| :----------------- | ------------------------------------------------------------------------------------ |
| Bash/zsh/ksh/etc. | `export GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |
| sh | `GOOGLE_APPLICATION_CREDENTIALS=[PATH];`<br> `export GOOGLE_APPLICATION_CREDENTIALS` |
| csh/tsch | `setenv GOOGLE_APPLICATION_CREDENTIALS [PATH]` |
| Windows Powershell | `$env:GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |
| Windows cmd.exe | `set GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |

Setting this environment variable is the recommended way to configure the
authentication preferences, though if the environment variable is not set, the
library searches for a credentials file in the same location as the
[Cloud SDK](https://cloud.google.com/sdk/). For more information about
*Application Default Credentials*, see
https://cloud.google.com/docs/authentication/production
[Authentication methods at Google][authentication-quickstart].

## Using with Bazel

Expand Down Expand Up @@ -148,7 +131,7 @@ trust store for SSL certificates, you can download and configure this using:
set GRPC_DEFAULT_SSL_ROOTS_FILE_PATH=%cd%\roots.pem
```

[authentication-quickstart]: https://cloud.google.com/docs/authentication/getting-started "Authentication Getting Started"
[authentication-quickstart]: https://cloud.google.com/docs/authentication "Authentication methods at Google"
[bazel-install]: https://docs.bazel.build/versions/main/install.html
[choco-cmake-link]: https://chocolatey.org/packages/cmake
[grpc-roots-pem-bug]: https://github.com/grpc/grpc/issues/16571
Expand Down
21 changes: 2 additions & 19 deletions google/cloud/apigateway/quickstart/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,24 +29,7 @@ detail.
Like most Google Cloud Platform (GCP) services, API Gateway API requires that
your application authenticates with the service before accessing any data. If
you are not familiar with GCP authentication please take this opportunity to
review the [Authentication Overview][authentication-quickstart]. This library
uses the `GOOGLE_APPLICATION_CREDENTIALS` environment variable to find the
credentials file. For example:

| Shell | Command |
| :----------------- | ------------------------------------------------------------------------------------ |
| Bash/zsh/ksh/etc. | `export GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |
| sh | `GOOGLE_APPLICATION_CREDENTIALS=[PATH];`<br> `export GOOGLE_APPLICATION_CREDENTIALS` |
| csh/tsch | `setenv GOOGLE_APPLICATION_CREDENTIALS [PATH]` |
| Windows Powershell | `$env:GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |
| Windows cmd.exe | `set GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |

Setting this environment variable is the recommended way to configure the
authentication preferences, though if the environment variable is not set, the
library searches for a credentials file in the same location as the
[Cloud SDK](https://cloud.google.com/sdk/). For more information about
*Application Default Credentials*, see
https://cloud.google.com/docs/authentication/production
review the [Authentication methods at Google][authentication-quickstart].

## Using with Bazel

Expand Down Expand Up @@ -142,7 +125,7 @@ trust store for SSL certificates, you can download and configure this using:
set GRPC_DEFAULT_SSL_ROOTS_FILE_PATH=%cd%\roots.pem
```

[authentication-quickstart]: https://cloud.google.com/docs/authentication/getting-started "Authentication Getting Started"
[authentication-quickstart]: https://cloud.google.com/docs/authentication "Authentication methods at Google"
[bazel-install]: https://docs.bazel.build/versions/main/install.html
[choco-cmake-link]: https://chocolatey.org/packages/cmake
[grpc-roots-pem-bug]: https://github.com/grpc/grpc/issues/16571
Expand Down
21 changes: 2 additions & 19 deletions google/cloud/apigeeconnect/quickstart/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,24 +29,7 @@ detail.
Like most Google Cloud Platform (GCP) services, Apigee Connect API requires that
your application authenticates with the service before accessing any data. If
you are not familiar with GCP authentication please take this opportunity to
review the [Authentication Overview][authentication-quickstart]. This library
uses the `GOOGLE_APPLICATION_CREDENTIALS` environment variable to find the
credentials file. For example:

| Shell | Command |
| :----------------- | ------------------------------------------------------------------------------------ |
| Bash/zsh/ksh/etc. | `export GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |
| sh | `GOOGLE_APPLICATION_CREDENTIALS=[PATH];`<br> `export GOOGLE_APPLICATION_CREDENTIALS` |
| csh/tsch | `setenv GOOGLE_APPLICATION_CREDENTIALS [PATH]` |
| Windows Powershell | `$env:GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |
| Windows cmd.exe | `set GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |

Setting this environment variable is the recommended way to configure the
authentication preferences, though if the environment variable is not set, the
library searches for a credentials file in the same location as the
[Cloud SDK](https://cloud.google.com/sdk/). For more information about
*Application Default Credentials*, see
https://cloud.google.com/docs/authentication/production
review the [Authentication methods at Google][authentication-quickstart].

## Using with Bazel

Expand Down Expand Up @@ -142,7 +125,7 @@ trust store for SSL certificates, you can download and configure this using:
set GRPC_DEFAULT_SSL_ROOTS_FILE_PATH=%cd%\roots.pem
```

[authentication-quickstart]: https://cloud.google.com/docs/authentication/getting-started "Authentication Getting Started"
[authentication-quickstart]: https://cloud.google.com/docs/authentication "Authentication methods at Google"
[bazel-install]: https://docs.bazel.build/versions/main/install.html
[choco-cmake-link]: https://chocolatey.org/packages/cmake
[grpc-roots-pem-bug]: https://github.com/grpc/grpc/issues/16571
Expand Down
Loading
Loading