Getting Started

These instructions will assume you have an Kubernetes cluster and want to bootstrap this GitOps repository to it.

Install the CLI tool

For all installation methods visit the Flux install guide

brew install fluxcd/tap/flux

Install Flux

For the full installation guide visit the Flux bootstrap guide

Validate the cluster and its connectivity

kubectl cluster-info

Export your GitHub personal access token, username, repository and cluster

export GITHUB_TOKEN=<your-token>
export GITHUB_USER=<your-username>
export GITHUB_REPO=<your-repo>
export CLUSTER=<target-cluster>

Verify that your cluster satisfies the prerequisites

flux check --pre

Run the bootstrap command to install Flux

flux bootstrap github \
  --owner="${GITHUB_USER}" \
  --repository="${GITHUB_REPO}" \
  --path=kubernetes/clusters/"${CLUSTER}" \
  --branch=main \
  --personal

Note: If you have network issues with Flux starting you may need to set --network-policies=false in the bootstrap command.

You may also use the automated installation script - Either override the defaults in the install script or as environment variables.