Kubernetes Scripts & Templates library

This repository contains my personal Kubernetes (k8s) scripts & Kustomize templates for easing the installation and maintenance of self-hosted services. It also demonstrates some (hopefully) good practices for maintaining a k8s cluster's configuration management repository.

Overall features:

• Kustomize-based templates for various self-hosted services (for a personal cloud setting);
• GNU Make scripts for easily installing / updating k8s-hosted applications;
• Utility scripts for checking & downloading the versions of containerized applications (e.g., from Github);
• Overall, a (opinionated) system for better organizing one's Kubernetes resources.
• Everything is well documented and designed to be fully customizable / extendable (via Makefile inheritance + kustomize overlays)!

List of example services: cert-manager, ingress-nginx.

Requirements

• make, bash, various core utilities;
• kubectl tool, of course!
• jq (used for automated version updates from repositories);
• helm (optional, only if you plan to use it with kustomize);
• Docker (optional, for building any custom images ofc :P)

This project assumes intermediate Kubernetes experience (+ make & bash).

Basic Usage

To get started, try out some of the bundled make scripts (though: please use a staging kubernetes setup!):

# test kustomization config generation
make services/cert-manager show
# clone the default config file before editing
cp config.defaults.mk config.local.mk
# recommended: edit the KUBECONFIG path in config.local.mk:
vim config.local.mk
# looking good? apply it!
make services/cert-manager apply

Check available services:

ls -l services/
ls -l services/cert-manager/

As expected, all services reside inside this directory. Each service contains at least the rules.mk and kustomization.yaml files.

The makefile will download / copy / generate the configuration descriptors (usually, .yaml files) inside the specific service's generated/ directory:

ls -l services/cert-manager/generated/

Check out the source code (rules.mk and files) of your preferred services for more information about the scripts' operation and customization options.

Development flow

Note that the scripts contained inside this repository are templates, aka: something to base your actual Kubernetes services configuration on!

There are several ways in which you could integrate those scripts into your workflow:

1. Forking / modifying in-place (faster but NOT recommended)

   If you wish to simply manage Kubernetes services with minimal configuration differences from the defaults, choose this options.

   Hint: only add configuration lines to the Makefile scripts for straightforward conflict merging!

   git clone https://github.com/niflostancu/k8s-service-templates.git
   # recommended: create your own branch
   git checkout -b personal
   # don't forget to rebase periodically (& solve conflicts)
   git rebase master
   # if you get bored of doing this, check variant #2 below ;)

   After cloning, simply edit the desired files (don't forget to create config.local.mk) and install your desired services.

2. Using as library / submodule (also check out the samples)

   If you want to have better configurability / flexibility for your cluster services and you wish to also remain in sync with [this] base repository, using it as submodule in a new project is your best choice:

   # create your new project's repo
   mkdir my-k8s-services/ && cd my-k8s-services/
   git init
   git submodule add https://github.com/niflostancu/k8s-service-templates.git base/
   # disregard sample & prefer inclusion against symlinks, more portable / syncable ;)
   echo 'include base/Makefile' > Makefile
   cp -f base/config.defaults.mk config.local.mk
   git commit -m 'first commit: start of k8s configuration'

   Initialize / configure your services:

   # check the base dir for the available services:
   ls -l base/services/
   # for each service you wish to include in your repo:
   mkdir -p "services/<service-name>"
   echo 'include $(base_rules)' > "services/<service-name>/rules.mk"

   The $(base_rules) makefile variable will resolve to the base rules.mk file automatically.