actions/fluxcd-flux2
3
0
Fork 0
mirror of https://github.com/fluxcd/flux2.git synced 2026-02-22 15:41:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Update bootstrap github docs to list permissions

Browse source 
Document the required permissions for bootstrapping pre-existing repositories.

I'm not sure if this is the correct place to document this as it feels to detailed for CLI output
but (as I understand it) the output of this is then passed to the website automatically and, not
knowing this took a while to debug the problems I was having.

Signed-off-by: Sam Cook <sam.cook@weave.works>
This commit is contained in:
Sam Cook 2021-12-09 12:31:51 +00:00
parent 26ea167524
commit f9299a5973
1 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
cmd/flux/bootstrap_github.go
View file

@ -38,11 +38,12 @@ import (
var bootstrapGitHubCmd = &cobra.Command{ var bootstrapGitHubCmd = &cobra.Command{
Use: "github", Use: "github",
Short: "Bootstrap toolkit components in a GitHub repository", Short: "Bootstrap toolkit components in a GitHub repository",
Long: `The bootstrap github command creates the GitHub repository if it doesn't exists and Long: `The bootstrap github command creates the GitHub repository if it doesn't exist and
commits the toolkit components manifests to the main branch. commits the toolkit components manifests to the main branch.
Then it configures the target cluster to synchronize with the repository. Then it configures the target cluster to synchronize with the repository.
If the toolkit components are present on the cluster, If the toolkit components are present on the cluster,
the bootstrap command will perform an upgrade if needed.`, the bootstrap command will perform an upgrade if needed.
Admin permissions are needed on pre-existing repositories.`,
Example: ` # Create a GitHub personal access token and export it as an env var Example: ` # Create a GitHub personal access token and export it as an env var
export GITHUB_TOKEN=<my-token> export GITHUB_TOKEN=<my-token>