Description

ClusterOps is a Kubernetes installer+operator designed to streamline the initial configuration and ongoing maintenance of your local kubernetes install. The focus of this project is primarily on personal or local installations (one node, one master). However, the goal is to expand its use to encompass all installations of Kubernetes for local development purposes. It simplifies cluster management by automating tasks and providing one user-friendly YAML-based configuration (config.yaml).

Features

• Simplified Configuration: Define your desired cluster state in a simple YAML file, and ClusterOps will handle the rest.
• Automated Setup: Automates initial k3s cluster configuration, including network settings, storage provisioning, special requirements (for example GPUs) and essential component installation.
• Ongoing Maintenance: Performs routine maintenance tasks such as upgrades, security updates, and resource monitoring.
• Extensibility: Easily extend functionality with custom plugins and configurations.
• Self-Healing: Detects and recovers from common cluster issues, ensuring stability, idempotence and reliability. An operation can be performed multiple times without changing the result.
• Discreet: It works only on what it knows, if you are manually configuring parts of your cluster and this configuration does not interfere with it you can happily continue to work on several parts and use this tool only for what is needed.

Goals

• Linux distribution independent, Kubernetes engine independent. Install your favorite kubernetes engine with your package manager, execute one script and you have a complete working environment in your desktop at your disposal.
  As a PoC this configuration is the base for the Hack Week: Arch Linux+K3S. Once all goals will be reached other platforms and engines will be added. Currently planned: Tumbleweed, OpenSUSE, SUSE SLES, Fedora, Debian. Kubernetes Engines: minicube, kind.
• Zero config approach. One single config.yaml file with installation requirements (add/remove features): human readable, plain and simple. All fancy configs managed automatically (ingress, balancers, services, proxy, ...).
• Kubernetes official dashboard installed, others planned too (k9s for example), builtin support for forklift container utility.
• Kubevirt plugin installed and properly configured. Unleash the power of classic virtualization (KVM+QEMU) on top of Kubernetes and manage your entire system from there, libvirtd and virsh libs required.
• Simple Network Config. Simple configuration for a simple setup. Everything you need to have your local cluster ready at your disposal to start developing your applications on the top of it (Traefik management setup included too).
• One operator to rule them all. The installation script configures your machine automatically during installation and adds one kubernetes operator to manage your local cluster. From there the operator takes care of the cluster on your behalf.
• One Install Command, One Remove Command. Take it for a spin, once done just uninstall everything without leaving traces (or pods) behind
• Automated, the k8s operator takes care of self healing the cluster, manages stateful sets, reconfigure your favorite plugins (dashboard, kubevirt, storage, ...)

Planned

• Adding installation scripts plugins for other distributions: OpenSuse, Tumbleweed, SLES, Fedora, Debian. Adding other personal/local kubernetes engines
• Local/Builtin container image hub. Just create your images and store them locally so your cluster can generate pods from there
• Source2Image utility. You provide your program (python, go, bash script, ...) the utility generates a Container Image for you. Easily create pods from your own personal projects
• Storage. Add your LAN local storage to the cluster easily for your persistent volumes slices. I'm also planning to add: CEPH, S3 buckets and other object storages
• GPU enabled containers. If you have an NVidia card the cluster can take advantage from it by adding and configuring CUDA support when needed. You can use NVidia Containerfile(s) directly from NVidia container hub and execute them locally

Project Resources

• github project repository: clusterops
• @andreabenini @SUSE
• feel free to reach me on slack, email, submit issues, MR, ...