- Dockerfile 82.3%
- Shell 17.7%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| .devcontainer | ||
| .github/workflows | ||
| .scripts | ||
| .woodpecker | ||
| apps | ||
| cluster | ||
| infrastructure | ||
| .gitignore | ||
| AGENTS.md | ||
| readme.md | ||
| sops.md | ||
Flux CD Deployment
This repository is a Flux CD deployment for a k3s cluster, running on three Beelink Mini PC's. One k3s server node and one k3s worker node on each host. If you're reading this, and you're not the owner of this particular cluster, you really shouldn't try to use this repository directly. Feel free to reference the deployment strategy and specifics, but don't try to use them unless you know what you're doing.
- Github: https://github.com/cvsickle/cluster-flux
- Codeberg: https://codeberg.org/cvsickle/cluster-flux
- Forgejo (Mirror): https://git.cvsickle.com/cvsickle/cluster-flux
Repository Structure
├── .devcontainer # Dev container definition
|
├── .github # GitHub actions
|
├── .woodpecker # Woodpecker CI actions
|
├── apps # Apps Folder:
│ ├── application1 # All top-level applications
│ ├── application2 # running in the cluster are
│ └── application3 # defined in this folder.
|
├── cluster # Cluster Folder:
│ ├── cluster-apps # Kustomization
│ ├── cluster-infrastructure # Kustomization
│ ├── flux-system # Flux Kustomization - NO TOUCHY
│ └── update-automation # Flux Update Automations
|
└── infrastructure # Infrastructure Folder:
├── service1 # Core services required for the cluster
├── service2 # to operate are defined in this folder.
└── service3 # Storage, Ingress, Databases, etc.
Reconciliation
Watch the Flux Kustomizations
flux get kustomizations --watch
Reconcile any changes
# Cluster
flux reconcile kustomization flux-system --with-source
# Apps
flux reconcile kustomization cluster-apps --with-source
# Infrastructure
flux reconcile kustomization cluster-infrastructure --with-source
Redeploy a HelmRelease
flux reconcile helmrelease <helmrelease_name> -n <namespace> --with-source --force
Local Machine Setup
This repo uses two dev container defined in the .devcontainer directory. The containers contains all the tools required for interacting with the cluster.
- kubectl (with cnpg plugin)
- helm
- flux
- k9s
- longhornctl
- sops
The admin container
The admin container has unrestricted access to the included tools. GitHub Copilot Chat is disabled in this container, preventing an AI slop agent from having the ability to directly mutate the cluster.
Using the admin container requires 2 mounts.
~/.sshwith a valid SSH key for the cluster hosts.~/.kubewith a valid kube config for the cluster.
The agent container
The agent container has read-only access to the included tools. GitHub Copilot Chat is available in this container, allow the agent to have diagnostic tools to read state and configuration from the cluster.
Using the agent container requires 1 mount.
~/.kube-agentwith a valid kube config for theagent-readonlyservice account in the cluster.
This agent-readonly kube config can be generated from the admin container by running:
.scripts/make-agent-kubeconfig.sh
Create a GitHub Token
The token needs to have repo access. I had to create it as a classic token.
https://github.com/settings/tokens
Bootstrap the Cluster
The command below will install Flux on the cluster and reference the repository.
flux bootstrap github \
--components-extra=image-reflector-controller,image-automation-controller,source-watcher \
--owner=cvsickle \
--repository=cluster-flux \
--branch=main \
--path=cluster \
--personal \
--token-auth
# verify
flux check
# double verify
kubectl get pods -n flux-system
Misc. Commands
Get Helm Chart Versions
helm search repo <reponame>/<chartname> --versions