flux, flux-{bootstrap, build, check, create}: add pages (#22295)

This commit is contained in:
Giacomo Di Clerico
2026-07-08 22:51:37 +02:00
committed by GitHub
parent 3bd07af7ee
commit 0918567e11
5 changed files with 100 additions and 0 deletions
+16
View File
@@ -0,0 +1,16 @@
# flux bootstrap
> Bootstrap Flux on a Kubernetes cluster.
> More information: <https://fluxcd.io/flux/cmd/flux_bootstrap/>.
- Bootstrap using a GitHub repository:
`flux bootstrap github --owner {{owner}} --repository {{repository}} --path {{path/to/cluster_directory}} --personal`
- Bootstrap using a GitLab repository:
`flux bootstrap gitlab --owner {{owner}} --repository {{repository}} --path {{path/to/cluster_directory}}`
- Bootstrap from a generic Git repository via SSH:
`flux bootstrap git --url {{ssh://git@example.com/repository.git}} --branch {{main}} --path {{path/to/cluster_directory}}`
+16
View File
@@ -0,0 +1,16 @@
# flux build
> Build Flux manifests.
> More information: <https://fluxcd.io/flux/cmd/flux_build/>.
- Build a Kustomization:
`flux build kustomization {{name}} --path {{path/to/kustomization}}`
- Build a Kustomization and output the manifests to a file:
`flux build kustomization {{name}} --path {{path/to/kustomization}} > {{path/to/manifests.yaml}}`
- Build a Kustomization and pipe it directly to `kubectl`:
`flux build kustomization {{name}} --path {{path/to/kustomization}} | kubectl apply -f -`
+12
View File
@@ -0,0 +1,12 @@
# flux check
> Check Flux prerequisites and cluster health.
> More information: <https://fluxcd.io/flux/cmd/flux_check/>.
- Check pre-requisites before installing Flux:
`flux check --pre`
- Check the status and health of all Flux controllers:
`flux check`
+20
View File
@@ -0,0 +1,20 @@
# flux create
> Create or update Flux resources.
> More information: <https://fluxcd.io/flux/cmd/flux_create/>.
- Create a GitRepository source:
`flux create source git {{source_name}} --url {{https://github.com/repository}} --branch {{branch_name}}`
- Create a Kustomization resource to sync a directory from a Git source:
`flux create kustomization {{kustomization_name}} --source {{source_name}} --path {{path/to/directory}}`
- Create a HelmRelease:
`flux create helmrelease {{release_name}} --chart {{chart_name}} --source {{HelmRepository/repository_name}}`
- Create a Secret to authenticate with a Git repository:
`flux create secret git {{secret_name}} --url {{https://github.com/repository}} --username "{{username}}" --password "{{password}}"`
+36
View File
@@ -0,0 +1,36 @@
# flux
> Continuous and progressive delivery solution for Kubernetes.
> More information: <https://fluxcd.io/flux/cmd/>.
- Check if the Flux prerequisites are met on the cluster:
`flux check --pre`
- Bootstrap Flux on a Kubernetes cluster:
`flux bootstrap {{github|gitlab}} --owner {{owner}} --repository {{repository}} --path {{path/to/cluster_directory}}`
- Create a new GitRepository source:
`flux create source git {{source_name}} --url {{https://github.com/repository}} --branch {{branch_name}}`
- List all Flux custom resources:
`flux get all`
- Trigger a reconciliation for a specific Kustomization and apply changes from source:
`flux reconcile kustomization {{name}} --with-source`
- Suspend reconciliation for a Kustomization:
`flux suspend kustomization {{name}}`
- Resume reconciliation for a Kustomization:
`flux resume kustomization {{name}}`
- Display help for a specific subcommand:
`flux {{subcommand}} --help`