Kairos Community Bundles

---

Welcome to the community-bundles repository! This repository builds and pushes Kairos community bundles that can be consumed by Kairos core or derivative images (such as provider-kairos ) to extend Kairos configurations and settings, and to add cloud-config keywords.

Please note that these community bundles are not officially supported and are provided on a best-effort basis by the community.

Table of Contents

• Table of Contents
• Usage
• Bundles
• Development

Usage

To use a community bundle, you can load it with the bundles block in the Kairos configuration file, like this:

bundles:
  - targets:
      - run://quay.io/kairos/community-bundles:<bundle-name>

Here is an example of how you might use a community bundle in a Kairos core image:

#cloud-config
install:
  device: "auto"
  auto: true
  reboot: true
  image: "docker:quay.io/kairos/kairos-opensuse:v1.4.0-k3sv1.26.0-k3s1"

users:
  - name: "kairos"
    passwd: "kairos"
    ssh_authorized_keys:
      - ...

bundles:
  - targets:
      - run://quay.io/kairos/community-bundles:kubevirt

k3s:
  enabled: true

Bundles

The following community bundles are available. Each bundle has its own README with detailed configuration options:

• ArgoCD - Deploys ArgoCD
• Calico - Deploys Project Calico
• Cert-manager - Deploys cert-manager
• EdgeVPN - Deploys EdgeVPN for mesh VPN networks
• Flux - Installs FluxCD with automatic bootstrapping
• K9s - Installs K9s, a terminal-based UI for managing Kubernetes clusters
• Kairos - Deploys the Kairos helm-charts
• Kairos Operator - Deploys the Kairos Operator to k0s or k3s clusters
• Kyverno - Deploys Kyverno
• Kubevirt - Deploys Kubevirt and optionally kubevirt-manager
• Longhorn - Deploys Longhorn
• MetalLB - Deploys MetalLB
• Multus - Deploys Multus CNI with CNI plugins
• Nginx - Deploys Ingress-Nginx-Controller
• SpinKube - Deploys SpinKube to k3s clusters
• System upgrade controller - Deploys System upgrade controller

Development

If you want to build and test a bundle, you can use earthly by running the following commands:

# build
./earthly.sh +build --BUNDLE=<bundle-name>
# test
./earthly.sh +test --BUNDLE=<bundle-name>

We also provide a version of the earthly.sh script for Windows (earthly.ps1).