I have been using the Flux CD operator for a few month to manage Kubernetes clusters in dev and prod and it is a great tool. When I initially reviewed Flux the first time back then, I liked it because of its simplicity but it was missing some important features such as the possibility to synchronise based on tags instead of a single branch, and configuring the Flux operator through the deployment wasn’t as good and intuitive, and caused some headaches.
A few days ago I stumbled across the new Flux CD GitOps Toolkit and it got my attention when I saw the new Flux v2 operator architecture. They’ve split the operator functions into three controller and using CRDs to configure Source, Kustomize and Helm configuration:
The feature which I was really waiting for was the support for Semantic Versioning semver in your GitRepository source. With this I am able to create platform releases, and can separate non-prod and prod clusters better which makes the deployment of configuration more controlled and flexible than previously with Flux v1.
You can see below the different release versions I’ve created in my cluster management repository:
The following two GitRepository examples; the first one syncs based on a static release tag 0.0.1 and the second syncs within a Semantic version range >=0.0.1 <0.1.0:
---
apiVersion: source.toolkit.fluxcd.io/v1alpha1
kind: GitRepository
metadata:
creationTimestamp: null
name: gitops-system
namespace: gitops-system
spec:
interval: 1m0s
ref:
tag: 0.0.1
secretRef:
name: gitops-system
url: ssh://github.com/berndonline/gitops-toolkit
status: {}
---
apiVersion: source.toolkit.fluxcd.io/v1alpha1
kind: GitRepository
metadata:
creationTimestamp: null
name: gitops-system
namespace: gitops-system
spec:
interval: 1m0s
ref:
semver: '>=0.0.1 <0.1.0'
secretRef:
name: gitops-system
url: ssh://github.com/berndonline/gitops-toolkit
status: {}
There are improvements for the Kustomize configuration to add additional overlays depending on your repository folder structure or combine this with another GitRepository source. In my example repository I have a cluster folder cluster-dev and a folder for common configuration:
.
|____cluster-dev
| |____kustomization.yaml
| |____hello-world_base
| | |____kustomization.yaml
| | |____deploy.yaml
|____common
|____kustomization.yaml
|____nginx-service.yaml
|____nginx_base
|____kustomization.yaml
|____service.yaml
|____nginx.yaml
You can add multiple Kustomize custom resources as you can see in my examples, one for the cluster specific config and a second one for the common configuration with can be applied to multiple clusters:
---
apiVersion: kustomize.toolkit.fluxcd.io/v1alpha1
kind: Kustomization
metadata:
creationTimestamp: null
name: cluster-conf
namespace: gitops-system
spec:
interval: 5m0s
path: ./cluster-dev
prune: true
sourceRef:
kind: GitRepository
name: gitops-system
status: {}
---
apiVersion: kustomize.toolkit.fluxcd.io/v1alpha1
kind: Kustomization
metadata:
creationTimestamp: null
name: common-con
namespace: gitops-system
spec:
interval: 5m0s
path: ./common
prune: true
sourceRef:
kind: GitRepository
name: gitops-system
status: {}
Let’s install the Flux CD GitOps Toolkit. The toolkit comes again with its own command-line utility tk which you use to install and configure the operator . You find available CLI versions on the Github release page.
Set up a new repository to store you k8s configuration:
$ git clone ssh://github.com/berndonline/gitops-toolkit $ cd gitops-toolkit $ mkdir -p ./cluster-dev/gitops-system
Generate the GitOps Toolkit manifests and store under gitops-system folder, afterwards apply the configuration to your k8s cluster:
$ tk install --version=latest \
--export > ./cluster-dev/gitops-system/toolkit-components.yaml
$ kubectl apply -f ./cluster-dev/gitops-system/toolkit-components.yaml
namespace/gitops-system created
customresourcedefinition.apiextensions.k8s.io/alerts.notification.toolkit.fluxcd.io created
customresourcedefinition.apiextensions.k8s.io/gitrepositories.source.toolkit.fluxcd.io created
customresourcedefinition.apiextensions.k8s.io/helmcharts.source.toolkit.fluxcd.io created
customresourcedefinition.apiextensions.k8s.io/helmreleases.helm.toolkit.fluxcd.io created
customresourcedefinition.apiextensions.k8s.io/helmrepositories.source.toolkit.fluxcd.io created
customresourcedefinition.apiextensions.k8s.io/kustomizations.kustomize.toolkit.fluxcd.io created
customresourcedefinition.apiextensions.k8s.io/providers.notification.toolkit.fluxcd.io created
customresourcedefinition.apiextensions.k8s.io/receivers.notification.toolkit.fluxcd.io created
role.rbac.authorization.k8s.io/crd-controller-gitops-system created
rolebinding.rbac.authorization.k8s.io/crd-controller-gitops-system created
clusterrolebinding.rbac.authorization.k8s.io/cluster-reconciler-gitops-system created
service/notification-controller created
service/source-controller created
service/webhook-receiver created
deployment.apps/helm-controller created
deployment.apps/kustomize-controller created
deployment.apps/notification-controller created
deployment.apps/source-controller created
networkpolicy.networking.k8s.io/deny-ingress created
Check if all the pods are running and use the command tk check to see if the toolkit is working correctly:
$ kubectl get pod -n gitops-system NAME READY STATUS RESTARTS AGE helm-controller-64f846df8c-g4mhv 1/1 Running 0 19s kustomize-controller-6d9745c8cd-n8tth 1/1 Running 0 19s notification-controller-587c49f7fc-ldcg2 1/1 Running 0 18s source-controller-689dcd8bd7-rzp55 1/1 Running 0 18s $ tk check ► checking prerequisites ✔ kubectl 1.18.3 >=1.18.0 ✔ Kubernetes 1.18.6 >=1.16.0 ► checking controllers ✔ source-controller is healthy ✔ kustomize-controller is healthy ✔ helm-controller is healthy ✔ notification-controller is healthy ✔ all checks passed
Now you can create a GitRepository custom resource, it will generate a ssh key local and displays the public key which you need to add to your repository deploy keys:
$ tk create source git gitops-system \ --url=ssh://github.com/berndonline/gitops-toolkit \ --ssh-key-algorithm=ecdsa \ --ssh-ecdsa-curve=p521 \ --branch=master \ --interval=1m ► generating deploy key pair ecdsa-sha2-nistp521 xxxxxxxxxxx Have you added the deploy key to your repository: y ► collecting preferred public key from SSH server ✔ collected public key from SSH server: github.com ssh-rsa xxxxxxxxxxx ► applying secret with keys ✔ authentication configured ✚ generating source ► applying source ✔ source created ◎ waiting for git sync ✗ git clone error: remote repository is empty
Continue with adding the Kustomize configuration:
$ tk create kustomization gitops-system \ --source=gitops-system \ --path="./cluster-dev" \ --prune=true \ --interval=5m ✚ generating kustomization ► applying kustomization ✔ kustomization created ◎ waiting for kustomization sync ✗ Source is not ready
Afterwards you can add your Kubernetes manifests to your repository and the operator will start synchronising the repository and apply the configuration which you’ve defined.
You can export the Source and Kustomize configuration:
$ tk export source git gitops-system \ > ./cluster-dev/gitops-system/toolkit-source.yaml $ tk export kustomization gitops-system \ > ./cluster-dev/gitops-system/toolkit-kustomization.yaml
You basically finished installing the GitOps Toolkit and below you have some useful commands to reconcile the configured custom resources:
$ tk reconcile source git gitops-system $ tk reconcile kustomization gitops-system
I was thinking of explaining how to setup a Kubernetes platform repository and do release versioning with the Flux GitOps Toolkit in one of my next articles. Please let me know if you have questions.