flux-operator-local-dev

Flux Operator local dev environment with Docker and Kubernetes KIND.

Get started

Prerequisites

Start by cloning the repository locally:

git clone https://github.com/controlplaneio-fluxcd/flux-operator-local-dev.git
cd flux-operator-local-dev

The following tools are required:

• Docker
• Kubernetes KIND
• Kubectl
• Flux CLI
• Flux Operator CLI

On macOS, you can install all the required tools with Homebrew by running:

make tools

Bootstrap

Start the dev environment with:

make up

The make up command performs the following steps:

• creates the Docker registry container if it's not already running and exposes it on localhost:5050
• creates the Kubernetes Kind cluster if it's not already running
• pushes the Kubernetes manifests as OCI artifacts to the local registry
  • locahost:5050/flux-cluster-sync is generated from kubernetes/clusters/local
  • locahost:5050/flux-infra-sync is generated from kubernetes/infra
  • locahost:5050/flux-apps-sync is generated from kubernetes/apps
• installs Flux Operator on the cluster and configures it to reconcile the manifests from the local registry
• waits for Flux to reconcile the cluster addons from oci://flux-registry:5000/flux-infra-sync
• waits for Flux to reconcile the demo apps from oci://flux-registry:5000/flux-apps-sync

To list all deployed resources, run:

make ls

Sync changes

To sync changes to the Kubernetes manifests, run:

make sync

The make sync command pushes the Kubernetes manifests to the local registry and waits for Flux to reconcile the changes on the cluster.

Tear down

To tear down the dev environment, run:

make down

The make down command deletes the Kind cluster and the Docker registry container.