installation.md

Installation

This guide walks you through setting up Flux v2 (hereafter: "Flux") to manage one or more Kubernetes clusters.

Prerequisites

You will need a Kubernetes cluster version 1.16 or newer and kubectl version 1.18 or newer.

Install the Flux CLI

With Homebrew:

brew install fluxcd/tap/flux

With Bash:

curl -s https://toolkit.fluxcd.io/install.sh | sudo bash

# enable completions in ~/.bash_profile
. <(flux completion bash)

Command-line completion for zsh, fish, and powershell are also supported with their own sub-commands.

Binaries for macOS, Windows and Linux AMD64/ARM are available for download on the release page.

A container image with kubectl and flux is available on DockerHub and GitHub:

• docker.io/fluxcd/flux-cli:<version>
• ghcr.io/fluxcd/flux-cli:<version>

Verify that your cluster satisfies the prerequisites with:

flux check --pre

Bootstrap

Using the flux bootstrap command you can install Flux on a Kubernetes cluster and configure it to manage itself from a Git repository. If the Flux components are present on the cluster, the bootstrap command will perform an upgrade if needed. The bootstrap is idempotent, it's safe to run the command as many times as you want.

The Flux component images are published to DockerHub and GitHub Container Registry as multi-arch container images with support for Linux amd64, arm64 and armv7 (e.g. 32bit Raspberry Pi) architectures.

If your Git provider is GitHub, GitLab or Azure DevOps please follow the specific bootstrap procedure:

• GitHub.com and GitHub Enterprise
• GitLab.com and GitLab Enterprise
• Azure DevOps