smol_k8s_lab 0.9.0

bootstrap simple projects on kubernetes with kind and k3s

☁️ smol k8s lab 🧸

This is aimed at getting up and running quickly with mostly smaller k8s distros in one small command line script.

Docs

Quickstart guide for you to jump right in!

There's also full tutorials to manually set up different distros in the docs we maintain as well as BASH scripts for basic automation of each k8s distro in:

./distro/[NAME OF K8S DISTRO]/bash_full_quickstart.sh

Under the hood

Currently supported k8s distros

•   k3s
•  KinD

We tend to test first on k3s and then kind.

We're working on cluster api next :)

Stack We Install on K8s

Application	What is it?
🐄  Local Path Provisioner	Default simple local file storage for persistent data
metallb	loadbalancer for metal, since we're mostly selfhosting
nginx-ingress	The ingress controller allows access to the cluster remotely, needed for web traffic
cert-manager	For SSL/TLS certificates
k9s	Terminal based dashboard for kubernetes

Optionally installed

Application/Tool	What is it?
ESO	external-secrets-operator integrates external secret management systems like GitLab
Argo CD	Gitops - Continuous Deployment
Kyverno	Kubernetes native policy management to enforce policies on k8s resources

If you install argocd, and you use bitwarden, we'll generate an admin password and automatically place it in your vault if you pass in the -p option. Curently only works with Bitwarden.

Want to get started with argocd? If you've installed it via smol_k8s_lab, then you can jump here. Otherwise, if you want to start from scratch, start here

Tooling Used for the script itself and interface

• rich (this is what makes all the pretty formatted text)
• PyYAML (to handle the k8s yamls and configs)
• bcrypt (to pass a password to argocd and automatically update your bitwarden)
• click (handles arguments for the script)

Troubleshooting

If you're stuck, checkout the Notes to see if we also got stuck on the same thing at some point :) Under each app or tool, we'll have notes on how to learn more about it, as well as any errors we've already battled.

Other Notes

Check out the optional directory for quick examples on apps this script does not default install.

e.g. for postgres, go to ./optional/postgres

Status

This is still in beta, as we figure out all the distros we want to support, and pin all the versions, but if you'd like to contribute or just found a :bug:, feel free to open an issue (or pull request), and we'll take a look! We'll try to get back to you asap!

Collaborators

TODO

• Configure base policies for Kyverno
• bitwarden: check local env vars for password or api key
• look into https://kubesec.io/