From 0918567e11e2a102a7e0f120866dead6f4846eaa Mon Sep 17 00:00:00 2001 From: Giacomo Di Clerico <84620724+MishowHD@users.noreply.github.com> Date: Wed, 8 Jul 2026 22:51:37 +0200 Subject: [PATCH] flux, flux-{bootstrap, build, check, create}: add pages (#22295) --- pages/common/flux-bootstrap.md | 16 +++++++++++++++ pages/common/flux-build.md | 16 +++++++++++++++ pages/common/flux-check.md | 12 ++++++++++++ pages/common/flux-create.md | 20 +++++++++++++++++++ pages/common/flux.md | 36 ++++++++++++++++++++++++++++++++++ 5 files changed, 100 insertions(+) create mode 100644 pages/common/flux-bootstrap.md create mode 100644 pages/common/flux-build.md create mode 100644 pages/common/flux-check.md create mode 100644 pages/common/flux-create.md create mode 100644 pages/common/flux.md diff --git a/pages/common/flux-bootstrap.md b/pages/common/flux-bootstrap.md new file mode 100644 index 0000000000..2e26d4a153 --- /dev/null +++ b/pages/common/flux-bootstrap.md @@ -0,0 +1,16 @@ +# flux bootstrap + +> Bootstrap Flux on a Kubernetes cluster. +> More information: . + +- 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}}` diff --git a/pages/common/flux-build.md b/pages/common/flux-build.md new file mode 100644 index 0000000000..8c04d77b0d --- /dev/null +++ b/pages/common/flux-build.md @@ -0,0 +1,16 @@ +# flux build + +> Build Flux manifests. +> More information: . + +- 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 -` diff --git a/pages/common/flux-check.md b/pages/common/flux-check.md new file mode 100644 index 0000000000..5ccfc1442d --- /dev/null +++ b/pages/common/flux-check.md @@ -0,0 +1,12 @@ +# flux check + +> Check Flux prerequisites and cluster health. +> More information: . + +- Check pre-requisites before installing Flux: + +`flux check --pre` + +- Check the status and health of all Flux controllers: + +`flux check` diff --git a/pages/common/flux-create.md b/pages/common/flux-create.md new file mode 100644 index 0000000000..ecb57e3672 --- /dev/null +++ b/pages/common/flux-create.md @@ -0,0 +1,20 @@ +# flux create + +> Create or update Flux resources. +> More information: . + +- 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}}"` diff --git a/pages/common/flux.md b/pages/common/flux.md new file mode 100644 index 0000000000..84e9cd2f0e --- /dev/null +++ b/pages/common/flux.md @@ -0,0 +1,36 @@ +# flux + +> Continuous and progressive delivery solution for Kubernetes. +> More information: . + +- 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`