Skip to content

Commit

Permalink
docs: remove references to ADC environment variable (#14914)
Browse files Browse the repository at this point in the history
  • Loading branch information
coryan authored Dec 30, 2024
1 parent 56f3aec commit 2a5216d
Show file tree
Hide file tree
Showing 143 changed files with 327 additions and 2,699 deletions.
21 changes: 2 additions & 19 deletions generator/internal/scaffold_generator.cc
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
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
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
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
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
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
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
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

0 comments on commit 2a5216d

Please sign in to comment.