Skip to content

Commit

Permalink
Link to GitHub fine-grained PAT from get started guide
Browse files Browse the repository at this point in the history
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
  • Loading branch information
stefanprodan committed Mar 6, 2024
1 parent f6b720e commit 9d5242b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
3 changes: 3 additions & 0 deletions content/en/flux/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ To follow the guide, you need the following:
- **A Kubernetes cluster**. We recommend [Kubernetes kind](https://kind.sigs.k8s.io/docs/user/quick-start/) for trying Flux out in a local development environment.
- **A GitHub personal access token with repo permissions**. See the GitHub documentation on [creating a personal access token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line).

Note that for production use, it is recommended to have a dedicated GitHub account for Flux and
use [fine-grained access tokens](/flux/installation/bootstrap/github/#github-organization) with the minimum required permissions.

## Objectives

- Bootstrap Flux on a Kubernetes Cluster.
Expand Down
5 changes: 3 additions & 2 deletions content/en/flux/installation/bootstrap/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,14 +78,15 @@ If you want to use an existing repository, the Flux user must have `admin` permi

{{% alert color="info" title="GitHub fine-grained PAT" %}}
Bootstrap can be run with a GitHub [fine-grained personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#fine-grained-personal-access-tokens),
but the GitHub repository must be created ahead of time by an organization admin.
for repositories that are created ahead of time by an organization admin.

The fine-grained PAT must be generated with the following permissions:

- `Administration` -> `Access: Read-only` (should be set to `Read and write` when using `bootstrap github --token-auth=false`)
- `Administration` -> `Access: Read-only`
- `Contents` -> `Access: Read and write`
- `Metadata` -> `Access: Read-only`

Note that `Administration` should be set to `Access: Read and write` when using `bootstrap github --token-auth=false`.
{{% /alert %}}

Run the bootstrap for a repository owned by a GitHub organization:
Expand Down

0 comments on commit 9d5242b

Please sign in to comment.