Skip to content

Commit 2f54532

Browse files
miguelvelezsagcf-owl-bot[bot]leahecole
authored
fix: disable linkinator until 429 issue is fixed. (#2138)
* fix: disable linkinator until 429 issue is fixed. * fix: remove docs from ci * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix: broken link in readme * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix: remove docs generation in kokoro job * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Leah E. Cole <[email protected]>
1 parent fce828c commit 2f54532

File tree

3 files changed

+43
-2
lines changed

3 files changed

+43
-2
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -423,6 +423,8 @@ your workloads are running in other AWS environments, such as ECS, EKS, Fargate,
423423

424424
Note that the client does not cache the returned AWS security credentials, so caching logic should be implemented in the supplier to prevent multiple requests for the same resources.
425425

426+
For a sample on how to access Google Cloud resources from AWS with a custom credential supplier, see [samples/customCredentialSupplierAwsWorkload.js](https://github.com/googleapis/google-auth-library-nodejs/blob/main/samples/customCredentialSupplierAwsWorkload.js).
427+
426428
```ts
427429
import { AwsClient, AwsSecurityCredentials, AwsSecurityCredentialsSupplier, ExternalAccountSupplierContext } from 'google-auth-library';
428430
import { fromNodeProviderChain } from '@aws-sdk/credential-providers';
@@ -1103,6 +1105,8 @@ and the workforce pool user project is the project number associated with the [w
11031105

11041106
The values for audience, service account impersonation URL, and any other builder field can also be found by generating a [credential configuration file with the gcloud CLI](https://cloud.google.com/iam/docs/workforce-obtaining-short-lived-credentials#use_configuration_files_for_sign-in).
11051107

1108+
For a sample on how to access Google Cloud resources from an Okta identity provider with a custom credential supplier, see [samples/customCredentialSupplierOktaWorkforce.js](https://github.com/googleapis/google-auth-library-nodejs/blob/main/samples/customCredentialSupplierOktaWorkforce.js).
1109+
11061110
### Using External Identities
11071111

11081112
External identities (AWS, Azure and OIDC-based providers) can be used with `Application Default Credentials`.
@@ -1409,6 +1413,8 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-auth-librar
14091413
| Authenticate Implicit With Adc | [source code](https://github.com/googleapis/google-auth-library-nodejs/blob/main/samples/authenticateImplicitWithAdc.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-auth-library-nodejs&page=editor&open_in_editor=samples/authenticateImplicitWithAdc.js,samples/README.md) |
14101414
| Compute | [source code](https://github.com/googleapis/google-auth-library-nodejs/blob/main/samples/compute.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-auth-library-nodejs&page=editor&open_in_editor=samples/compute.js,samples/README.md) |
14111415
| Credentials | [source code](https://github.com/googleapis/google-auth-library-nodejs/blob/main/samples/credentials.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-auth-library-nodejs&page=editor&open_in_editor=samples/credentials.js,samples/README.md) |
1416+
| Custom Credential Supplier Aws Workload | [source code](https://github.com/googleapis/google-auth-library-nodejs/blob/main/samples/customCredentialSupplierAwsWorkload.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-auth-library-nodejs&page=editor&open_in_editor=samples/customCredentialSupplierAwsWorkload.js,samples/README.md) |
1417+
| Custom Credential Supplier Okta Workload | [source code](https://github.com/googleapis/google-auth-library-nodejs/blob/main/samples/customCredentialSupplierOktaWorkload.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-auth-library-nodejs&page=editor&open_in_editor=samples/customCredentialSupplierOktaWorkload.js,samples/README.md) |
14121418
| Downscopedclient | [source code](https://github.com/googleapis/google-auth-library-nodejs/blob/main/samples/downscopedclient.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-auth-library-nodejs&page=editor&open_in_editor=samples/downscopedclient.js,samples/README.md) |
14131419
| Headers | [source code](https://github.com/googleapis/google-auth-library-nodejs/blob/main/samples/headers.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-auth-library-nodejs&page=editor&open_in_editor=samples/headers.js,samples/README.md) |
14141420
| Id Token From Impersonated Credentials | [source code](https://github.com/googleapis/google-auth-library-nodejs/blob/main/samples/idTokenFromImpersonatedCredentials.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-auth-library-nodejs&page=editor&open_in_editor=samples/idTokenFromImpersonatedCredentials.js,samples/README.md) |

package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@
4949
"karma-sourcemap-loader": "^0.4.0",
5050
"karma-webpack": "^5.0.1",
5151
"keypair": "^1.0.4",
52-
"linkinator": "^6.1.2",
5352
"mocha": "^11.1.0",
5453
"mv": "^2.1.1",
5554
"ncp": "^2.0.0",
@@ -81,7 +80,7 @@
8180
"presystem-test": "npm run compile -- --sourceMap",
8281
"webpack": "webpack",
8382
"browser-test": "karma start",
84-
"docs-test": "linkinator docs",
83+
"docs-test": "echo 'disabled until linkinator is fixed'",
8584
"predocs-test": "npm run docs",
8685
"prelint": "cd samples; npm link ../; npm install"
8786
},

samples/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ This is Google's officially supported [node.js](http://nodejs.org/) client libra
1818
* [Authenticate Implicit With Adc](#authenticate-implicit-with-adc)
1919
* [Compute](#compute)
2020
* [Credentials](#credentials)
21+
* [Custom Credential Supplier Aws Workload](#custom-credential-supplier-aws-workload)
22+
* [Custom Credential Supplier Okta Workload](#custom-credential-supplier-okta-workload)
2123
* [Downscopedclient](#downscopedclient)
2224
* [Headers](#headers)
2325
* [Id Token From Impersonated Credentials](#id-token-from-impersonated-credentials)
@@ -153,6 +155,40 @@ __Usage:__
153155

154156

155157

158+
### Custom Credential Supplier Aws Workload
159+
160+
View the [source code](https://github.com/googleapis/google-auth-library-nodejs/blob/main/samples/customCredentialSupplierAwsWorkload.js).
161+
162+
[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-auth-library-nodejs&page=editor&open_in_editor=samples/customCredentialSupplierAwsWorkload.js,samples/README.md)
163+
164+
__Usage:__
165+
166+
167+
`node samples/customCredentialSupplierAwsWorkload.js`
168+
169+
170+
-----
171+
172+
173+
174+
175+
### Custom Credential Supplier Okta Workload
176+
177+
View the [source code](https://github.com/googleapis/google-auth-library-nodejs/blob/main/samples/customCredentialSupplierOktaWorkload.js).
178+
179+
[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-auth-library-nodejs&page=editor&open_in_editor=samples/customCredentialSupplierOktaWorkload.js,samples/README.md)
180+
181+
__Usage:__
182+
183+
184+
`node samples/customCredentialSupplierOktaWorkload.js`
185+
186+
187+
-----
188+
189+
190+
191+
156192
### Downscopedclient
157193

158194
View the [source code](https://github.com/googleapis/google-auth-library-nodejs/blob/main/samples/downscopedclient.js).

0 commit comments

Comments
 (0)