How I Manage My Kubernetes Manifests Using Flux
GitOps is currently the most popular way to manage your services. It’s sort of what DevOps is but with Git. To put it in a simple way, it is a practice where you manage everything through git. Whatever you have in your git repository is what your cluster current state is. Because GitOps is so popular there are a lot of new tools focusing on GitOps right now, and Flux is one of them. In this post I will give you a glance on how I manage my Kubernetes manifests using Flux.
These are basically all you need to get started:
- A Kubernetes cluster already running
- A git repository that your Kubernetes cluster can access, I use Github
- Access to your Kubernetes cluster using kubectl
Installing Flux CLI
You will need to install Flux CLI In the machine that you can do kubectl commands into your Kubernetes cluster. Depending on your OS, you can get it from Homebrew, Chocolatey, AUR, GoFish, or you can get it from their Github repository using this one liner:
curl -s https://fluxcd.io/install.sh | sudo bash
Bootstrapping to Github
To connect Flux with your Github repository, create a personal access token and check all the permissions under “repo”. Export the generated token in a environment variable named GITHUB_TOKEN and run flux bootstrap command:
export GITHUB_TOKEN=<your token> flux bootstrap github --owner your-github-username --repository repository-name --path path-to-flux --personal
Running the above command will create a Github repository if it doesn’t exist or push a commit if it already exists. You can use anything you want for the “–path” flag. Flux will create a directory called flux-system inside that path and it will contain all yaml files to get you started. Now, you can start putting kubernetes manifest files inside the directory where you specify the “–path” at.
Let’s clone the github repository into your machine now.
git clone https://github.com/your-github-username/repository-name
Creating Flux Kustomization
Now, whatever you put inside the directory inside the repository will be deployed into your Kubernetes cluster.
In my repository, I use
./cluster/base as the path where I tell Flux where to look for manifests.
There are two ways to deploy services with Flux, using kustomize or helm.
You don’t need to have kustomize or helm installed in your machine, Flux have both helm and kustomize controllers running in your cluster already.
I don’t use Helm, so I will show you how I do this using kustomize.
I do mine using Flux CLI like this:
cd home-cluster flux create kustomization apps --interval 1m --path ./cluster/apps --prune true --source GitRepository/flux-system --export > ./cluster/base/apps-kustomization.yaml git add . && git commit "create apps kustomization" && git push
Please note that you don’t have to do the exact same thing as I put above, understanding about what the commands do is more important. These are what the above commands do:
- I change directory into home-cluster, which is my repository name. Replace it with the repository name you created in the bootstrap process.
- I create a app-kustomization.yaml file using
flux createCLI command:
- the name of my kustomization is
- –interval 1m tells Flux to to synchronizing every 1 minute
- –path ./cluster/apps tells Flux the directory to look for manifest files
- –prune true tells Flux to delete resources in the directory if I delete them from Github
- –source GitRepository/flux-system tells Flux to use this repository, flux-system GitRepository kind is automatically created by Flux when we do bootstrap command. This means you can create another source from another repository if you want to. You can use
flux create sourcecommand to do this (not covered here)
- –export tells Flux to export the output of this command which is basically a Kubernetes manifest
- > ./cluster/base/apps-kustomization.yaml pipe the output into a file
- the name of my kustomization is
- I commit and push the changes into Github, so that Flux will see it.
There are a lot more available flags that you can use in flux create kustomization command that I don’t show here. You can read them all here.
Deploying Your Services Using Flux
After creating Flux kustomization CRD using the step before, Flux will watch for the directory where you define with
Mine is in
So let’s create an example service, let’s say I want to deploy adminer.
mkdir -p ./cluster/apps/adminer cat ./cluster/apps/adminer/deployment.yaml << EOF apiVersion: apps/v1 kind: Deployment metadata: name: adminer labels: app.kubernetes.io/name: adminer spec: selector: matchLabels: app.kubernetes.io/name: adminer template: metadata: labels: app.kubernetes.io/name: adminer spec: containers: - name: adminer image: adminer:4.8.1 imagePullPolicy: IfNotPresent ports: - name: http protocol: TCP containerPort: 8080 EOF cat ./cluster/apps/adminer/kustomization.yaml << EOF apiVersion: kustomize.config.k8s.io/v1beta1 kind: Kustomization namespace: default resources: - deployment.yaml EOF git add . && git commit -m "deploy adminer" && git push
Again, you don’t have to follow whatever I do here. This post is more about explaining how it works rather than a tutorial, hence the title is how I manage my kubernetes manifests using Flux. What I did with the commands above are:
- Make a directory in
- Create a deployment.yaml file which contains the Deployment kind of Kubernetes manifest inside the directory created above.
- Create a kustomization.yaml file which contains Kustomization kind of Kubernetes manifest to tell Flux kustomization controller what file to sync with my Github repository.
- I commit and push the changes into Github, so Flux will see it.
Now, wait for 1m (depending on your –interval flag of your flux kustomization) and adminer will be deployed in your cluster. If you are impatient like me, you can use this command to force Flux to reconcile without waiting:
flux reconcile kustomization apps
Thank you for reading my post, I hope you can learn something from this. Of course, there are a lot more that you can do with Flux. It has source, kuztomize, helm, notification, image controllers that you can make use of.
This is how I manage my Kubernetes manifests using Flux GitOps, tell me more about yours in the comment section.