Flux Mirror Config
Official Flux CLI plugin documentation.
Flux Mirror is a CLI for mirroring Helm charts, OCI artifacts and container images between registries using a declarative approach.
The intended use case is feeding an internal mirror registry that backs Flux OCIRepository and Kubernetes Deployments, so clusters never reach out to upstream registries at reconcile time.
It also enables migration away from HTTP/S HelmRepository sources: chart
versions are republished as OCI Helm artifacts that HelmRelease consumes
via an OCIRepository in spec.chartRef, dropping the runtime dependency
on upstream chart repositories.
regex → semver → sort → top-N filter. For charts, a semver constraint
plus top-N. Sort by semver, alphabetical, or numerical.text and yaml/json for downstream
tooling, plus a verbose mode that streams every blob and manifest digest
for diagnosing TLS, auth, or push failures.Install the plugin with the Flux CLI:
flux plugin install mirror
Authenticate once against the destination and optionally source registries:
docker login ghcr.io
For private HTTP/S Helm repositories, login with Helm:
helm repo add private https://charts.example.com --username "$USER" --password "$TOKEN"
Write a config file describing what to mirror:
# flux-mirror.yaml
apiVersion: mirror.plugin.fluxcd.io/v1beta1
kind: Config
charts:
- name: external-dns
source: https://kubernetes-sigs.github.io/external-dns/
destination: oci://ghcr.io/my-org/charts
version: "*"
limit: 3
artifacts:
- source: registry.k8s.io/external-dns/external-dns
destination: ghcr.io/my-org/external-dns
selector:
semver: ">=0.15.0"
limit: 3
includeReferrers: true
Run the sync:
flux mirror sync flux-mirror.yaml
You can also read the config from stdin:
flux mirror sync - < flux-mirror.yaml
Preview without writing:
flux mirror sync flux-mirror.yaml --dry-run
Force a resync of drifted tags e.g. latest:
flux mirror sync flux-mirror.yaml --overwrite
See
examples/ for more configurations and
docs/sync.md for the full flag reference.
Official Flux CLI plugin documentation.
Official Flux CLI plugin documentation.
Official Flux CLI plugin documentation.
Official Flux CLI plugin documentation.
Official Flux CLI plugin documentation.
Official Flux CLI plugin documentation.