Skip to content

rszamszur/home-ops

Repository files navigation

Home Lab Repository

... managed with ArgoCD, Renovate and GitHub Actions 🤖

t630

📖 Overview

This is a mono repository for my home infrastructure and Kubernetes cluster. I try to adhere to Infrastructure as Code (IaC) and GitOps practices using the tools like Terraform, Kubernetes, ArgoCD, Renovate and GitHub Actions.


🔧 Hardware

Click to see the insides

t630_inside

⛵ Kubernetes

Structure

Below is an explanation on how this repo is laid out. You'll notice that I use Kustomize heavily. I do this since I follow the DRY principal when it comes to YAML files.

cluster-home/ # 1
├── bootstrap # 2
│   ├── base
│   │   ├── argocd-ns.yaml
│   │   └── kustomization.yaml
│   └── overlays
│       └── default
│           └── kustomization.yaml
├── components # 3
│   ├── applicationsets
│   │   ├── core-components-appset.yaml
│   │   ├── kustomization.yaml
│   │   └── tenants-appset.yaml
│   └── argocdproj
│       ├── kustomization.yaml
│       └── test-project.yaml
├── core # 4
│   ├── gitops-controller
│   │   └── kustomization.yaml
│   └── sample-admin-config
│       ├── kustomization.yaml
│       └── sample-admin-config.yaml
└── tenants # 5
    └── foobar-app
        ├── kustomization.yaml
        ├── foobar-app-deployment.yaml
        ├── foobar-app-ns.yaml
        └── foobar-app-service.yaml
# Directory Name Description
1. cluster-home This is the cluster name. This name should be unique to the specific cluster you're targeting. If you're using CAPI, this should be the name of your cluster, the output of kubectl get cluster
2. bootstrap This is where bootstrapping specifc configurations are stored. These are items that get the cluster/automation started. They are usually install manifests.

base is where are the "common" YAML would live and overlays are configurations specific to the cluster.

The kustomization.yaml file in default has cluster-home/components/applicationsets/ and cluster-home/components/argocdproj/ as a part of it's bases config.
3. components This is where specific components for the GitOps Controller lives (in this case Argo CD).

applicationsets is where all the ApplicationSets YAMLs live and argocdproj is where the ArgoAppProject YAMLs live.

Other things that can live here are RBAC, Git repo, and other Argo CD specific configurations (each in their repsective directories).
4. core This is where YAML for the core functionality of the cluster live. Here is where the Kubernetes administrator will put things that is necissary for the functionality of the cluster (like cluster configs or cluster workloads).

Under gitops-controller is where you are using Argo CD to manage itself. The kustomization.yaml file uses cluster-home/bootstrap/overlays/default in it's bases configuration. This core directory gets deployed as an applicationset which can be found under cluster-home/components/applicationsets/core-components-appset.yaml.

To add a new "core functionality" workoad, one needs to add a directory with some yaml in the core directory. See the sample-admin-config directory as an example.
5. tenants This is where the workloads for this cluster live.

Similar to core, the tenants directory gets loaded as part of an ApplicationSet that is under cluster-home/components/applicationsets/tenants-appset.yaml.

This is where Devlopers/Release Engineers do the work. They just need to commit a directory with some YAML and the applicationset takes care of creating the workload.

Bootstrapping

To see this in action, first get yourself a cluster (using minikube as an example)

minikube start --driver=docker

Then, just apply this repo:

until kubectl apply -k https://github.com/rszamszur/home-k8s/cluster-home/bootstrap/overlays/default; do sleep 3; done

This should give you 4 applications:

$ kubectl get applications -n argocd
NAME                    SYNC STATUS   HEALTH STATUS
fastapi-mvc-example     Synced        Healthy
foobar-app              Synced        Healthy
gitops-controller       Synced        Healthy
sample-admin-workload   Synced        Healthy

Backed by 2 applicationsets:

$ kubectl get appsets -n argocd
NAME      AGE
cluster   19m
tenants   19m

To see the Argo CD UI, you'll first need the password:

kubectl get secret/argocd-initial-admin-secret -n argocd -o jsonpath='{.data.password}' | base64 -d ; echo

Then port-forward to see it in your browser (using admin as the username):

kubectl -n argocd port-forward service/argocd-server 8080:443

Resources

About

A mono repository for my home infrastructure and Kubernetes cluster which adheres to Infrastructure as Code (IaC) and GitOps practices where possible

Topics

Resources

Stars

Watchers

Forks