Skip to content

docs: metadata-based verifier example in README #8

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

Open
bonifaido wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: metadata-based verifier example in README #8

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
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Riptides is a zero-trust networking layer that runs as a kernel module on your h

## Prerequisites

1. A Riptides control plane with a `GitHubActionsVerifier` configured for your repository owner:
1. A Riptides control plane with a `GitHubActionsVerifier` scoped to your organisation:

```yaml
apiVersion: auth.riptides.io/v1alpha1
Expand All @@ -21,8 +21,9 @@ metadata:
name: github-actions
spec:
GitHubActions:
repositoryOwner: your-org # required, restricts to your org
audience: riptides # must match the action's audience input
audience: riptides # must match the action's audience input
requiredMetadata:
- githubactions:repository:owner: your-org # restricts to your org (add more groups for more orgs)
```

If you don't have the verifier set up yet, follow the [Connect GitHub Actions Runners](https://docs.riptides.io/guides/connect-github-actions/) guide for the full walkthrough.
Expand Down
Loading