663 lines
27 KiB
Markdown
663 lines
27 KiB
Markdown
# Template for deploying a Kubernetes cluster backed by Flux
|
|
|
|
Welcome to my highly opinionated template for deploying a single Kubernetes ([k3s](https://k3s.io)) cluster with [Ansible](https://www.ansible.com) and managing applications with [Flux](https://toolkit.fluxcd.io/). Upon completion you will be able to expose web applications you choose to the internet with [Cloudflare Tunnel](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/).
|
|
|
|
## Overview
|
|
|
|
- [Introduction](https://github.com/onedr0p/flux-cluster-template#-introduction)
|
|
- [Prerequisites](https://github.com/onedr0p/flux-cluster-template#-prerequisites)
|
|
- [Repository structure](https://github.com/onedr0p/flux-cluster-template#-repository-structure)
|
|
- [Lets go!](https://github.com/onedr0p/flux-cluster-template#-lets-go)
|
|
- [Post installation](https://github.com/onedr0p/flux-cluster-template#-post-installation)
|
|
- [Troubleshooting](https://github.com/onedr0p/flux-cluster-template#-troubleshooting)
|
|
- [What's next](https://github.com/onedr0p/flux-cluster-template#-whats-next)
|
|
- [Thanks](https://github.com/onedr0p/flux-cluster-template#-thanks)
|
|
|
|
## 👋 Introduction
|
|
|
|
The following components will be installed in your [k3s](https://k3s.io/) cluster by default. Most are only included to get a minimum viable cluster up and running.
|
|
|
|
- [flux](https://toolkit.fluxcd.io/) - GitOps operator for managing Kubernetes clusters from a Git repository
|
|
- [kube-vip](https://kube-vip.io/) - Load balancer for the Kubernetes control plane nodes
|
|
- [cert-manager](https://cert-manager.io/) - Operator to request SSL certificates and store them as Kubernetes resources
|
|
- [cilium](https://cilium.io/) - Container networking interface for inter pod and service networking
|
|
- [external-dns](https://github.com/kubernetes-sigs/external-dns) - Operator to publish DNS records to Cloudflare (and other providers) based on Kubernetes ingresses
|
|
- [k8s_gateway](https://github.com/ori-edge/k8s_gateway) - DNS resolver that provides local DNS to your Kubernetes ingresses
|
|
- [ingress-nginx](https://kubernetes.github.io/ingress-nginx/) - Kubernetes ingress controller used for a HTTP reverse proxy of Kubernetes ingresses
|
|
- [local-path-provisioner](https://github.com/rancher/local-path-provisioner) - provision persistent local storage with Kubernetes
|
|
|
|
_Additional applications include [grafana](https://github.com/grafana/grafana), [kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack), [hajimari](https://github.com/toboshii/hajimari), [echo-server](https://github.com/Ealenn/Echo-Server), [system-upgrade-controller](https://github.com/rancher/system-upgrade-controller), and [reloader](https://github.com/stakater/Reloader)
|
|
|
|
## 📝 Prerequisites
|
|
|
|
1. Please bring a **positive attitude** and be ready to learn and fail a lot. The more you fail, the more you can learn from.
|
|
2. This was designed to run in your home network on bare metal machines or VMs **NOT** in the cloud.
|
|
3. You **MUST** have a domain you can manage on Cloudflare.
|
|
4. Secrets will be commited to your Git repository **AND** they will be encrypted by SOPS.
|
|
5. By default your domain name will **NOT** be visible to the public.
|
|
6. To reach internal-only apps you **MUST** have a DNS server that supports split DNS (Pi-Hole, Blocky, Dnsmasq, Unbound, etc...) deployed somewhere outside your cluster **ON** your home network.
|
|
7. In order for this all to work you have to use nodes that have access to the internet. This is not going to work in air-gapped environments.
|
|
8. Only **amd64** and/or **arm64** nodes are supported.
|
|
|
|
With that out of the way please continue on if you are still interested...
|
|
|
|
### 📚 Reading material
|
|
|
|
- [Organizing Cluster Access Using kubeconfig Files](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/)
|
|
|
|
### 💻 System Preparation
|
|
|
|
Download [Debian 12](https://cdimage.debian.org/debian-cd/current/amd64/iso-dvd/) (for raspi/arm64 use the [tested images](https://raspi.debian.net/tested-images/))
|
|
|
|
|
|
#### AMD64
|
|
|
|
There is a decent guide [here](https://www.linuxtechi.com/how-to-install-debian-12-step-by-step/) on how to get Debian installed.
|
|
|
|
1. Deviations from that guide
|
|
|
|
```txt
|
|
- Choose "Guided - use entire disk"
|
|
- Choose "All files in one partition"
|
|
- Delete Swap partition
|
|
- Uncheck all Debian desktop environment options
|
|
- Keep ssh server checked
|
|
```
|
|
|
|
2. (Post install) Enable SSH for root user
|
|
|
|
```sh
|
|
sed -i 's/#\?\(PermitRootLogin\s*\).*$/\1yes/' /etc/ssh/sshd_config
|
|
systemctl restart sshd
|
|
```
|
|
|
|
3. (Post install) Add SSH keys (or use `ssh-copy-id` on the client that is connecting)
|
|
|
|
```sh
|
|
mkdir -m 700 ~/.ssh
|
|
curl https://github.com/${github_username}.keys > ~/.ssh/authorized_keys
|
|
chmod 600 ~/.ssh/authorized_keys
|
|
```
|
|
|
|
4. (Post install) If you cannot run `apt update` without errors, try removing CD/DVD as apt source
|
|
|
|
```sh
|
|
sed -i '1d' /etc/apt/sources.list
|
|
apt update
|
|
```
|
|
|
|
#### Raspberry Pi / ARM64
|
|
|
|
If you choose to use a Raspberry Pi for the cluster, it is recommended to have at minimum a Raspberry Pi4 (4GB) and preferably an 8GB model. Additionally, it is also recommended to boot from an external SSD, rather than the SD card. This is supported [natively](https://www.raspberrypi.com/documentation/computers/raspberry-pi.html), however if you have an early Raspberry Pi4, you may need to [update the bootloader](https://www.tomshardware.com/how-to/boot-raspberry-pi-4-usb).
|
|
|
|
According to the documentation [here](https://raspi.debian.net/defaults-and-settings/), after you have flashed the image onto a SSD/NVMe you must mount the drive and do the following.
|
|
|
|
1. Edit the `sysconf.txt`
|
|
2. Add/change `root_authorized_key` to your desired public SSH key
|
|
3. Add/change `root_pw` to your desired root password
|
|
4. Add/change `hostname` to your desired hostname
|
|
|
|
## 📂 Repository structure
|
|
|
|
The Git repository contains the following directories under `kubernetes` and are ordered below by how Flux will apply them.
|
|
|
|
```sh
|
|
📁 kubernetes # Kubernetes cluster defined as code
|
|
├─📁 bootstrap # Flux installation
|
|
├─📁 flux # Main Flux configuration of repository
|
|
└─📁 apps # Apps deployed into the cluster grouped by namespace
|
|
```
|
|
|
|
## 🚀 Lets go
|
|
|
|
Very first step will be to create a new **public** repository by clicking the big green **Use this template** button on this page.
|
|
|
|
Clone **your new repo** to you local workstation and `cd` into it.
|
|
|
|
📍 **All of the below commands** are run on your **local** workstation, **not** on any of your cluster nodes.
|
|
|
|
### 🔧 Workstation Tools
|
|
|
|
📍 Install the **most recent version** of the CLI tools below. If you are **having trouble with future steps**, it is very likely you don't have the most recent version of these CLI tools. The most troublesome are `ansible`, `go-task`, and `sops`.
|
|
|
|
1. Install the following CLI tools on your workstation, if you are **NOT** using [Homebrew](https://brew.sh/) **ignore** steps 2 & 3.
|
|
|
|
- **Required**: [age](https://github.com/FiloSottile/age), [ansible](https://www.ansible.com), [flux](https://toolkit.fluxcd.io/), [cloudflared](https://github.com/cloudflare/cloudflared), [go-task](https://github.com/go-task/task), [direnv](https://github.com/direnv/direnv), [kubectl](https://kubernetes.io/docs/tasks/tools/), [python3](https://www.python.org/), [python-pip3](https://pypi.org/project/pip/), [sops](https://github.com/getsops/sops)
|
|
|
|
- **Recommended**: [helm](https://helm.sh/), [kustomize](https://github.com/kubernetes-sigs/kustomize), [stern](https://github.com/stern/stern)
|
|
|
|
2. [Homebrew] Install [go-task](https://github.com/go-task/task)
|
|
|
|
```sh
|
|
brew install go-task/tap/go-task
|
|
```
|
|
|
|
3. [Homebrew] Install workstation dependencies
|
|
|
|
```sh
|
|
task init
|
|
```
|
|
|
|
### 🔐 Setting up Age
|
|
|
|
📍 Here we will create a Age Private and Public key. Using [SOPS](https://github.com/mozilla/sops) with [Age](https://github.com/FiloSottile/age) allows us to encrypt secrets and use them in Ansible and Flux.
|
|
|
|
1. Create a Age Private / Public Key
|
|
|
|
```sh
|
|
age-keygen -o age.agekey
|
|
```
|
|
|
|
2. Set up the directory for the Age key and move the Age file to it
|
|
|
|
```sh
|
|
mkdir -p ~/.config/sops/age
|
|
mv age.agekey ~/.config/sops/age/keys.txt
|
|
```
|
|
|
|
3. Export the `SOPS_AGE_KEY_FILE` variable in your `bashrc`, `zshrc` or `config.fish` and source it, e.g.
|
|
|
|
```sh
|
|
export SOPS_AGE_KEY_FILE=~/.config/sops/age/keys.txt
|
|
source ~/.bashrc
|
|
```
|
|
|
|
4. Fill out the Age public key in the appropriate variable in configuration section below, **note** the public key should start with `age`...
|
|
|
|
### ☁️ Cloudflare API Token
|
|
|
|
In order to use `cert-manager` with the Cloudflare DNS challenge you will need to create a API Token.
|
|
|
|
1. Head over to Cloudflare and create a API Token by going [here](https://dash.cloudflare.com/profile/api-tokens).
|
|
|
|
2. Under the `API Tokens` section, click the blue "Create Token" button.
|
|
|
|
3. Click the "Use template" blue button for the `Edit zone DNS` template.
|
|
|
|
4. Give your token a name like `home-k8s-cluster`
|
|
|
|
5. Under `Permissions`, click `+ Add More` and add each permission below:
|
|
|
|
```text
|
|
Zone - DNS - Edit # should be there already if using the template from the previous step
|
|
Account - Cloudflare Tunnel - Read
|
|
```
|
|
|
|
📍 Feel free to limit the permissions to a specific account and zone resources.
|
|
|
|
6. Use the API Token in the appropriate variable in configuration section below.
|
|
|
|
### ☁️ Cloudflare Tunnel
|
|
|
|
In order to expose services to the internet you will need to create a [Cloudflare Tunnel](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/).
|
|
|
|
1. Authenticate cloudflared to your domain
|
|
|
|
```sh
|
|
cloudflared tunnel login
|
|
```
|
|
|
|
2. Create the tunnel
|
|
|
|
```sh
|
|
cloudflared tunnel create k8s
|
|
```
|
|
|
|
3. In the `~/.cloudflared` directory there will be a json file with details you need to populate in configuration section below. You can ignore the `cert.pem` file.
|
|
|
|
### 📄 Configuration
|
|
|
|
📍 The `template/vars/config.yaml` file contains necessary configuration that is needed by Ansible and Flux.
|
|
|
|
1. Copy the configuration file and start filling out all the variables.
|
|
|
|
**All are required** unless otherwise noted in the comments.
|
|
|
|
```sh
|
|
cp template/vars/config.sample.yaml template/vars/config.yaml
|
|
```
|
|
|
|
2. Once done run the following command which will verify and generate all the files needed to continue.
|
|
|
|
```sh
|
|
task configure
|
|
```
|
|
|
|
### ⚡ Preparing Debian Server with Ansible
|
|
|
|
📍 Here we will be running an Ansible Playbook to prepare Debian server for running a Kubernetes cluster.
|
|
|
|
📍 Nodes are not security hardened by default, you can do this with [dev-sec/ansible-collection-hardening](https://github.com/dev-sec/ansible-collection-hardening) or similar if supported. This is an advanced configuration and generally not recommended unless you want to [DevSecOps](https://www.ibm.com/topics/devsecops) your cluster and nodes.
|
|
|
|
1. Ensure you are able to SSH into your nodes from your workstation using a private SSH key **without a passphrase**. This is how Ansible is able to connect to your remote nodes.
|
|
|
|
2. Install the Ansible deps
|
|
|
|
```sh
|
|
task ansible:init
|
|
```
|
|
|
|
3. Verify Ansible can view your config
|
|
|
|
```sh
|
|
task ansible:list
|
|
```
|
|
|
|
4. Verify Ansible can ping your nodes
|
|
|
|
```sh
|
|
task ansible:ping
|
|
```
|
|
|
|
5. Run the Ansible prepare playbook
|
|
|
|
```sh
|
|
task ansible:prepare
|
|
```
|
|
|
|
6. Reboot the nodes (if not done in step 5)
|
|
|
|
```sh
|
|
task ansible:force-reboot
|
|
```
|
|
|
|
### ⛵ Installing k3s with Ansible
|
|
|
|
📍 Here we will be running a Ansible Playbook to install [k3s](https://k3s.io/) with [this](https://galaxy.ansible.com/xanmanning/k3s) wonderful k3s Ansible galaxy role. After completion, Ansible will drop a `kubeconfig` in `./kubeconfig` for use with interacting with your cluster with `kubectl`.
|
|
|
|
☢️ If you run into problems, you can run `task ansible:nuke` to destroy the k3s cluster and start over.
|
|
|
|
1. Verify Ansible can view your config
|
|
|
|
```sh
|
|
task ansible:list
|
|
```
|
|
|
|
2. Verify Ansible can ping your nodes
|
|
|
|
```sh
|
|
task ansible:ping
|
|
```
|
|
|
|
3. Install k3s with Ansible
|
|
|
|
```sh
|
|
task ansible:install
|
|
```
|
|
|
|
4. Verify the nodes are online
|
|
|
|
```sh
|
|
task cluster:nodes
|
|
# NAME STATUS ROLES AGE VERSION
|
|
# k8s-0 Ready control-plane,etcd,master 1h v1.27.3+k3s1
|
|
# k8s-1 Ready control-plane,etcd,master 1h v1.27.3+k3s1
|
|
# k8s-2 Ready control-plane,etcd,master 1h v1.27.3+k3s1
|
|
# k8s-3 Ready worker 1h v1.27.3+k3s1
|
|
```
|
|
|
|
### 🔹 GitOps with Flux
|
|
|
|
📍 Here we will be installing [flux](https://toolkit.fluxcd.io/) after some quick bootstrap steps.
|
|
|
|
1. Verify Flux can be installed
|
|
|
|
```sh
|
|
task cluster:verify
|
|
# ► checking prerequisites
|
|
# ✔ kubectl 1.27.3 >=1.18.0-0
|
|
# ✔ Kubernetes 1.27.3+k3s1 >=1.16.0-0
|
|
# ✔ prerequisites checks passed
|
|
```
|
|
|
|
2. Push you changes to git
|
|
|
|
📍 **Verify** all the `*.sops.yaml` and `*.sops.yaml` files under the `./ansible`, and `./kubernetes` directories are **encrypted** with SOPS
|
|
|
|
```sh
|
|
git add -A
|
|
git commit -m "Initial commit :rocket:"
|
|
git push
|
|
```
|
|
|
|
3. Install Flux and sync the cluster to the Git repository
|
|
|
|
```sh
|
|
task cluster:install
|
|
# namespace/flux-system configured
|
|
# customresourcedefinition.apiextensions.k8s.io/alerts.notification.toolkit.fluxcd.io created
|
|
```
|
|
|
|
4. Verify Flux components are running in the cluster
|
|
|
|
```sh
|
|
task cluster:pods -- -n flux-system
|
|
# NAME READY STATUS RESTARTS AGE
|
|
# helm-controller-5bbd94c75-89sb4 1/1 Running 0 1h
|
|
# kustomize-controller-7b67b6b77d-nqc67 1/1 Running 0 1h
|
|
# notification-controller-7c46575844-k4bvr 1/1 Running 0 1h
|
|
# source-controller-7d6875bcb4-zqw9f 1/1 Running 0 1h
|
|
```
|
|
|
|
### 🎤 Verification Steps
|
|
|
|
_Mic check, 1, 2_ - In a few moments applications should be lighting up like a Christmas tree 🎄
|
|
|
|
You are able to run all the commands below with one task
|
|
|
|
```sh
|
|
task cluster:resources
|
|
```
|
|
|
|
1. View the Flux Git Repositories
|
|
|
|
```sh
|
|
task cluster:gitrepositories
|
|
```
|
|
|
|
2. View the Flux kustomizations
|
|
|
|
```sh
|
|
task cluster:kustomizations
|
|
```
|
|
|
|
3. View all the Flux Helm Releases
|
|
|
|
```sh
|
|
task cluster:helmreleases
|
|
```
|
|
|
|
4. View all the Flux Helm Repositories
|
|
|
|
```sh
|
|
task cluster:helmrepositories
|
|
```
|
|
|
|
5. View all the Pods
|
|
|
|
```sh
|
|
task cluster:pods
|
|
```
|
|
|
|
6. View all the certificates and certificate requests
|
|
|
|
```sh
|
|
task cluster:certificates
|
|
```
|
|
|
|
7. View all the ingresses
|
|
|
|
```sh
|
|
task cluster:ingresses
|
|
```
|
|
|
|
🏆 **Congratulations** if all goes smooth you'll have a Kubernetes cluster managed by Flux, your Git repository is driving the state of your cluster.
|
|
|
|
☢️ If you run into problems, you can run `task ansible:nuke` to destroy the k3s cluster and start over.
|
|
|
|
🧠 Now it's time to pause and go get some coffee ☕ because next is describing additional things like how DNS is handled.
|
|
|
|
## 📣 Post installation
|
|
|
|
### 🌱 Environment
|
|
|
|
[direnv](https://direnv.net/) will make it so anytime you `cd` to your repo's directory it export the required environment variables (e.g. `KUBECONFIG`). To set this up make sure you [hook it into your shell](https://direnv.net/docs/hook.html) and after that is done, run `direnv allow` while in your repos directory.
|
|
|
|
### 📜 Certificates
|
|
|
|
By default this template will deploy a wildcard certificate with the Let's Encrypt staging servers. This is to prevent you from getting rate-limited on configuration that might not be valid on bootstrap using the production server. Once you have confirmed the certificate is created and valid, make sure to switch to the Let's Encrypt production servers as outlined below. Do not enable the production certificate until you are sure you will keep the cluster up for more than a few hours.
|
|
|
|
1. Update the resources to use the production Let's Encrypt server:
|
|
|
|
```patch
|
|
diff --git a/kubernetes/apps/networking/ingress-nginx/app/helmrelease.yaml b/kubernetes/apps/networking/ingress-nginx/app/helmrelease.yaml
|
|
index e582d4a..0f80700 100644
|
|
--- a/kubernetes/apps/networking/ingress-nginx/app/helmrelease.yaml
|
|
+++ b/kubernetes/apps/networking/ingress-nginx/app/helmrelease.yaml
|
|
@@ -60,7 +60,7 @@ spec:
|
|
namespaceSelector:
|
|
any: true
|
|
extraArgs:
|
|
- default-ssl-certificate: "networking/${SECRET_DOMAIN/./-}-staging-tls"
|
|
+ default-ssl-certificate: "networking/${SECRET_DOMAIN/./-}-production-tls"
|
|
resources:
|
|
requests:
|
|
cpu: 10m
|
|
diff --git a/kubernetes/apps/networking/ingress-nginx/certificates/kustomization.yaml b/kubernetes/apps/networking/ingress-nginx/certificates/kustomization.yaml
|
|
index d57147d..f58e4a7 100644
|
|
--- a/kubernetes/apps/networking/ingress-nginx/certificates/kustomization.yaml
|
|
+++ b/kubernetes/apps/networking/ingress-nginx/certificates/kustomization.yaml
|
|
@@ -3,4 +3,4 @@ apiVersion: kustomize.config.k8s.io/v1beta1
|
|
kind: Kustomization
|
|
resources:
|
|
- ./staging.yaml
|
|
- # - ./production.yaml
|
|
+ - ./production.yaml
|
|
```
|
|
|
|
2. Commit and push your changes:
|
|
|
|
```sh
|
|
git add -A
|
|
git commit -m "fix: use production LE certificates"
|
|
git push
|
|
```
|
|
|
|
3. Force Flux to pick up the changes:
|
|
|
|
```sh
|
|
task cluster:reconcile
|
|
```
|
|
|
|
- To view the certificate request run `kubectl -n networking get certificaterequests`
|
|
- To verify the certificate is created run `kubectl -n networking get certificates`
|
|
|
|
You should start to see your applications using the new certificate.
|
|
|
|
### 🌐 DNS
|
|
|
|
The `external-dns` application created in the `networking` namespace will handle creating public DNS records. By default, `echo-server` and the `flux-webhook` are the only public sub-domains exposed. In order to make additional applications public you must set an ingress annotation (`external-dns.alpha.kubernetes.io/target`) like done in the `HelmRelease` for `echo-server`.
|
|
|
|
For split DNS to work it is required to have `${SECRET_DOMAIN}` point to the `${K8S_GATEWAY_ADDR}` load balancer IP address on your home DNS server. This will ensure DNS requests for `${SECRET_DOMAIN}` will only get routed to your `k8s_gateway` service thus providing **internal** DNS resolution to your cluster applications/ingresses from any device that uses your home DNS server.
|
|
|
|
For and example with Pi-Hole apply the following file and restart dnsmasq:
|
|
|
|
```sh
|
|
# /etc/dnsmasq.d/99-k8s-gateway-forward.conf
|
|
server=/${SECRET_DOMAIN}/${K8S_GATEWAY_ADDR}
|
|
```
|
|
|
|
Now try to resolve an internal-only domain with `dig @${pi-hole-ip} hajimari.${SECRET_DOMAIN}` it should resolve to your `${INGRESS_NGINX_ADDR}` IP.
|
|
|
|
If having trouble you can ask for help in [this](https://github.com/onedr0p/flux-cluster-template/discussions/719) Github discussion.
|
|
|
|
If nothing is working, that is expected. This is DNS after all!
|
|
|
|
### 🤖 Renovatebot
|
|
|
|
[Renovatebot](https://www.mend.io/free-developer-tools/renovate/) will scan your repository and offer PRs when it finds dependencies out of date. Common dependencies it will discover and update are Flux, Ansible Galaxy Roles, Terraform Providers, Kubernetes Helm Charts, Kubernetes Container Images, and more!
|
|
|
|
The base Renovate configuration provided in your repository can be view at [.github/renovate.json5](https://github.com/onedr0p/flux-cluster-template/blob/main/.github/renovate.json5). If you notice this only runs on weekends and you can [change the schedule to anything you want](https://docs.renovatebot.com/presets-schedule/) or simply remove it.
|
|
|
|
To enable Renovate on your repository, click the 'Configure' button over at their [Github app page](https://github.com/apps/renovate) and choose your repository. Over time Renovate will create PRs for out-of-date dependencies it finds. Any merged PRs that are in the kubernetes directory Flux will deploy.
|
|
|
|
### 🪝 Github Webhook
|
|
|
|
Flux is pull-based by design meaning it will periodically check your git repository for changes, using a webhook you can enable Flux to update your cluster on `git push`. In order to configure Github to send `push` events from your repository to the Flux webhook receiver you will need two things:
|
|
|
|
1. Webhook URL - Your webhook receiver will be deployed on `https://flux-webhook.${bootstrap_cloudflare_domain}/hook/:hookId`. In order to find out your hook id you can run the following command:
|
|
|
|
```sh
|
|
kubectl -n flux-system get receiver/github-receiver
|
|
# NAME AGE READY STATUS
|
|
# github-receiver 6h8m True Receiver initialized with URL: /hook/12ebd1e363c641dc3c2e430ecf3cee2b3c7a5ac9e1234506f6f5f3ce1230e123
|
|
```
|
|
|
|
So if my domain was `onedr0p.com` the full url would look like this:
|
|
|
|
```text
|
|
https://flux-webhook.onedr0p.com/hook/12ebd1e363c641dc3c2e430ecf3cee2b3c7a5ac9e1234506f6f5f3ce1230e123
|
|
```
|
|
|
|
2. Webhook secret - Your webhook secret can be found by decrypting the `secret.sops.yaml` using the following command:
|
|
|
|
```sh
|
|
sops -d ./kubernetes/apps/flux-system/addons/webhooks/github/secret.sops.yaml | yq .stringData.token
|
|
```
|
|
|
|
**Note:** Don't forget to update the `bootstrap_flux_github_webhook_token` variable in the `config.yaml` file so it matches the generated secret if applicable
|
|
|
|
Now that you have the webhook url and secret, it's time to set everything up on the Github repository side. Navigate to the settings of your repository on Github, under "Settings/Webhooks" press the "Add webhook" button. Fill in the webhook url and your secret.
|
|
|
|
### 💾 Storage
|
|
|
|
Rancher's `local-path-provisioner` is a great start for storage but soon you might find you need more features like replicated block storage, or to connect to a NFS/SMB/iSCSI server. Check out the projects below to read up more on some storage solutions that might work for you.
|
|
|
|
- [rook-ceph](https://github.com/rook/rook)
|
|
- [longhorn](https://github.com/longhorn/longhorn)
|
|
- [openebs](https://github.com/openebs/openebs)
|
|
- [nfs-subdir-external-provisioner](https://github.com/kubernetes-sigs/nfs-subdir-external-provisioner)
|
|
- [democratic-csi](https://github.com/democratic-csi/democratic-csi)
|
|
- [csi-driver-nfs](https://github.com/kubernetes-csi/csi-driver-nfs)
|
|
- [synology-csi](https://github.com/SynologyOpenSource/synology-csi)
|
|
|
|
### 🔏 Authenticate Flux over SSH
|
|
|
|
Authenticating Flux to your git repository has a couple benefits like using a private git repository and/or using the Flux [Image Automation Controllers](https://fluxcd.io/docs/components/image/).
|
|
|
|
By default this template only works on a public GitHub repository, it is advised to keep your repository public.
|
|
|
|
The benefits of a public repository include:
|
|
|
|
- Debugging or asking for help, you can provide a link to a resource you are having issues with.
|
|
- Adding a topic to your repository of `k8s-at-home` to be included in the [k8s-at-home-search](https://whazor.github.io/k8s-at-home-search/). This search helps people discover different configurations of Helm charts across others Flux based repositories.
|
|
|
|
<details>
|
|
<summary>Expand to read guide on adding Flux SSH authentication</summary>
|
|
|
|
1. Generate new SSH key:
|
|
|
|
```sh
|
|
ssh-keygen -t ecdsa -b 521 -C "github-deploy-key" -f ./kubernetes/bootstrap/github-deploy.key -q -P ""
|
|
```
|
|
|
|
2. Paste public key in the deploy keys section of your repository settings
|
|
3. Create sops secret in `./kubernetes/bootstrap/github-deploy-key.sops.yaml` with the contents of:
|
|
|
|
```yaml
|
|
apiVersion: v1
|
|
kind: Secret
|
|
metadata:
|
|
name: github-deploy-key
|
|
namespace: flux-system
|
|
stringData:
|
|
# 3a. Contents of github-deploy-key
|
|
identity: |
|
|
-----BEGIN OPENSSH PRIVATE KEY-----
|
|
...
|
|
-----END OPENSSH PRIVATE KEY-----
|
|
# 3b. Output of curl --silent https://api.github.com/meta | jq --raw-output '"github.com "+.ssh_keys[]'
|
|
known_hosts: |
|
|
github.com ssh-ed25519 ...
|
|
github.com ecdsa-sha2-nistp256 ...
|
|
github.com ssh-rsa ...
|
|
```
|
|
|
|
4. Encrypt secret:
|
|
|
|
```sh
|
|
sops --encrypt --in-place ./kubernetes/bootstrap/github-deploy-key.sops.yaml
|
|
```
|
|
|
|
5. Apply secret to cluster:
|
|
|
|
```sh
|
|
sops --decrypt ./kubernetes/bootstrap/github-deploy-key.sops.yaml | kubectl apply -f -
|
|
```
|
|
|
|
6. Update `./kubernetes/flux/config/cluster.yaml`:
|
|
|
|
```yaml
|
|
apiVersion: source.toolkit.fluxcd.io/v1beta2
|
|
kind: GitRepository
|
|
metadata:
|
|
name: home-kubernetes
|
|
namespace: flux-system
|
|
spec:
|
|
interval: 10m
|
|
# 6a: Change this to your user and repo names
|
|
url: ssh://git@github.com/$user/$repo
|
|
ref:
|
|
branch: main
|
|
secretRef:
|
|
name: github-deploy-key
|
|
```
|
|
|
|
7. Commit and push changes
|
|
8. Force flux to reconcile your changes
|
|
|
|
```sh
|
|
task cluster:reconcile
|
|
```
|
|
|
|
9. Verify git repository is now using SSH:
|
|
|
|
```sh
|
|
task cluster:gitrepositories
|
|
```
|
|
|
|
10. Optionally set your repository to Private in your repository settings.
|
|
|
|
</details>
|
|
|
|
### 💨 Kubernetes Dashboard
|
|
|
|
Included in your cluster is the [Kubernetes Dashboard](https://kubernetes.io/docs/tasks/access-application-cluster/web-ui-dashboard/). Inorder to log into this you will have to get the secret token from the cluster using the command below.
|
|
|
|
```sh
|
|
kubectl -n monitoring get secret kubernetes-dashboard -o jsonpath='{.data.token}' | base64 -d
|
|
```
|
|
|
|
You should be able to access the dashboard at `https://kubernetes.${SECRET_DOMAIN}`
|
|
|
|
## 🐛 Debugging
|
|
|
|
Below is a general guide on trying to debug an issue with an resource or application. For example, if a workload/resource is not showing up or a pod has started but in a `CrashLoopBackOff` or `Pending` state.
|
|
|
|
1. Start by checking all Flux Kustomizations & Git Repository & OCI Repository and verify they are healthy.
|
|
|
|
- `flux get sources oci -A`
|
|
- `flux get sources git -A`
|
|
- `flux get ks -A`
|
|
|
|
2. Then check all the Flux Helm Releases and verify they are healthy.
|
|
|
|
- `flux get hr -A`
|
|
|
|
3. Then check the if the pod is present.
|
|
|
|
- `kubectl -n <namespace> get pods`
|
|
|
|
4. Then check the logs of the pod if its there.
|
|
|
|
- `kubectl -n <namespace> logs <pod-name> -f`
|
|
|
|
Note: If a resource exists, running `kubectl -n <namespace> describe <resource> <name>` might give you insight into what the problem(s) could be.
|
|
|
|
Resolving problems that you have could take some tweaking of your YAML manifests in order to get things working, other times it could be a external factor like permissions on NFS. If you are unable to figure out your problem see the help section below.
|
|
|
|
## 👉 Help
|
|
|
|
- Make a post in this repository's GitHub [Discussions](https://github.com/onedr0p/flux-cluster-template/discussions).
|
|
- Start a thread in the `support` or `flux-cluster-template` channel in the [k8s@home](https://discord.gg/k8s-at-home) Discord server.
|
|
|
|
## ❔ What's next
|
|
|
|
The world is your cluster, have at it!
|
|
|
|
## 🤝 Thanks
|
|
|
|
Big shout out to all the authors and contributors to the projects that we are using in this repository.
|
|
|
|
[@whazor](https://github.com/whazor) created [this website](https://nanne.dev/k8s-at-home-search/) as a creative way to search Helm Releases across GitHub. You may use it as a means to get ideas on how to configure an applications' Helm values.
|