Skip to content

README: use environment for apply #77

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

Draft
joneskoo wants to merge 1 commit into
base: main
Choose a base branch
from
+37 −8
Draft

README: use environment for apply #77

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
45 changes: 37 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ on:

jobs:
acls:
if: github.event_name == 'push'
environment: production
permissions:
contents: read
id-token: write # This is required for the Tailscale action to request a JWT from GitHub
Expand All @@ -87,7 +89,6 @@ jobs:
version-cache.json-

- name: Deploy ACL
if: github.event_name == 'push'
id: deploy-acl
uses: tailscale/gitops-acl-action@v1
with:
Expand All @@ -96,26 +97,54 @@ jobs:
tailnet: ${{ secrets.TS_TAILNET }}
action: apply

acls-test:
if: github.event_name == 'pull_request'
permissions:
contents: read
id-token: write # This is required for the Tailscale action to request a JWT from GitHub
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v6

- name: Fetch version-cache.json
uses: actions/cache@v5
with:
path: ./version-cache.json
key: version-cache.json-${{ github.run_id }}
restore-keys: |
version-cache.json-

- name: Test ACL
if: github.event_name == 'pull_request'
id: test-acl
uses: tailscale/gitops-acl-action@v1
with:
oauth-client-id: ${{ secrets.TS_OAUTH_ID }}
audience: ${{ secrets.TS_AUDIENCE }}
oauth-client-id: ${{ secrets.TS_OAUTH_ID_RO }}
audience: ${{ secrets.TS_AUDIENCE_RO }}
tailnet: ${{ secrets.TS_TAILNET }}
action: test
```

Generate a new federated identity. See [here](https://login.tailscale.com/admin/settings/keys) for instructions.
Generate two OpenID Connect federated identities in the Tailscale admin panel under
[Settings → Trust credentials](https://login.tailscale.com/admin/settings/trust-credentials/add):
one with **Policy File - Read** permission for the test job, and one with
**Policy File - Write** permission for the apply job.

Then open the secrets settings for your repo and add two secrets:
Open the secrets settings for your repo and add three repository secrets:

* `TS_OAUTH_ID`: Your federated identity's client ID
* `TS_AUDIENCE`: Your federated identity's audience
* `TS_OAUTH_ID_RO`: Client ID of the read-only (test) federated identity
* `TS_AUDIENCE_RO`: Audience of the read-only (test) federated identity
* `TS_TAILNET`: Your tailnet's name (it's next to the logo on the upper
left-hand corner of the [admin panel](https://login.tailscale.com/admin/machines))

Create a GitHub [environment](https://docs.github.com/en/actions/deployment/targeting-different-deployment-environments/using-environments-for-deployment)
named `production`, and restrict it to the `main` branch under "Deployment branch and tag policies".
Without this restriction the apply job's credentials can be accessed from a pull request branch.
Add two environment secrets:

* `TS_OAUTH_ID`: Client ID of the apply federated identity
* `TS_AUDIENCE`: Audience of the apply federated identity

Once you do that, commit the changes and push them to GitHub. You will have CI
automatically test and push changes to your tailnet policy file to Tailscale.

Expand Down