Skip to content

Commit

Permalink
Highlight that nscloud runners do not require token exchanges.
Browse files Browse the repository at this point in the history
  • Loading branch information
n-g committed Jul 7, 2023
1 parent a9ebd13 commit 5915bd6
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,31 @@ jobs:
nsc cluster create
```
### Using Namespace GitHub Runners
Namespace GitHub Runners are already authenticated with Namespace.
Hence, no token exchange is needed and `id-token: write` permissions can be skipped.

```yaml
jobs:
deploy:
name: Ephemeral cluster
runs-on: nscloud
permissions:
contents: read
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Configure access to Namespace
uses: namespacelabs/nscloud-setup@v0
- name: Create an ephemeral cluster
run: |
nsc cluster create
```

## Requirements

`nsc` authenticates workloads by talking to GitHub's OIDC Token endpoint.
Please ensure to grant `id-token: write` for your workflow (see [example](#example)).

When Namespace GitHub Runners are used, no token exchange is needed and `id-token: write` permissions can be skipped (see [example](#using-namespace-github-runners)).

0 comments on commit 5915bd6

Please sign in to comment.