Skip to content

Commit

Permalink
fix: create PAT docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rafalgalaw committed Dec 4, 2024
1 parent 4a43839 commit e2cb200
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,27 @@ To start developing, you need the following tools installed:

## Getting Started

1. Get yourself a GitHub PAT for development purposes with access to an Organization where the runners will be registered.
1. Get yourself a GitHub PAT for development purposes with access to a Repository where the runners will be
registered. Your PAT needs the following permissions:
If you'll use a PAT (classic), you'll have to grant access for the following scopes. See official [cloudbase/garm]
(https://github.com/cloudbase/garm/blob/main/doc/github_credentials.md) docs for more information.

* ```public_repo``` - for access to a repository
* ```repo``` - for access to a private repository
* ```admin:org``` - if you plan on using this with an organization to which you have access
* ```manage_runners:enterprise``` - if you plan to use garm at the enterprise level
* ```admin:repo_hook``` - if you want to allow GARM to install webhooks on repositories (optional)
* ```admin:org_hook``` - if you want to allow GARM to install webhooks on organizations (optional)

Fine grained PATs are also supported as long as you grant the required privileges:

* **Repository permissions**:
* `Administration: Read & write` - needed to generate JIT config/registration token, remove runners, etc.
* `Metadata: Read-only` - automatically enabled by above
* `Webhooks: Read & write` - needed to install webhooks on repositories
* **Organization permissions**:
* `Self-hosted runners: Read & write` - needed to manage runners in an organization
* `Webhooks: Read & write` - needed to install webhooks on organizations

1. To spin up GitHub Action Runners with `garm`, the `garm-operator` needs some CRs which can be created by the
following command.
Expand Down

0 comments on commit e2cb200

Please sign in to comment.