Skip to content

Commit 9d5242b

Browse files
committed
Link to GitHub fine-grained PAT from get started guide
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
1 parent f6b720e commit 9d5242b

2 files changed

Lines changed: 6 additions & 2 deletions

File tree

content/en/flux/get-started.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ To follow the guide, you need the following:
1414
- **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.
1515
- **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).
1616

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

1922
- Bootstrap Flux on a Kubernetes Cluster.

content/en/flux/installation/bootstrap/github.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,14 +78,15 @@ If you want to use an existing repository, the Flux user must have `admin` permi
7878

7979
{{% alert color="info" title="GitHub fine-grained PAT" %}}
8080
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),
81-
but the GitHub repository must be created ahead of time by an organization admin.
81+
for repositories that are created ahead of time by an organization admin.
8282

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

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

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

9192
Run the bootstrap for a repository owned by a GitHub organization:

0 commit comments

Comments
 (0)