Using Kairos Core Images as an Installer

Kairos is a powerful, open-source meta-distribution that allows you to easily deploy and manage nodes on your Immutable infrastructure.

One key feature of Kairos is the use of its core images, which are released as part of the kairos-io/kairos repository and can be found in the releases section. These core images serve as the foundation for creating downstream images or as an installer for deploying other images during the installation process. In this guide, we’ll take a closer look at using Kairos core images as an installer to deploy other container images.

Getting started

To begin using Kairos core images as an installer, you’ll need to start by using the artifacts from the Kairos core repository. These images do not include the Kubernetes engine, so you’ll need to configure the container image you want to deploy in the install.image field of your cloud config file. A list of available images can be found in our support matrix.

For example, let’s say you want to use a standard image. Your cloud config file might look something like this:

#cloud-config
install:
 # Here we specify the image that we want to deploy
 source: "docker:quay.io/kairos/@flavor:@flavorRelease-standard-amd64-generic-v3.1.3-k3sv1.31.0-k3s1"

Once you’ve chosen your image, you can move on to the installation process by following the steps outlined in our Installation documentation.

For example, a full cloud-config might look like this:

#cloud-config

install:
 device: "auto"
 auto: true
 reboot: true
 # Here we specify the image that we want to deploy
 image: "docker:quay.io/kairos/@flavor:@flavorRelease-standard-amd64-generic-v3.1.3-k3sv1.31.0-k3s1"

hostname: "test"
users:
- name: "kairos"
  passwd: "kairos"
  ssh_authorized_keys:
  - github:mudler

k3s:
  enable: true

Configuring the installation

As you move through the installation process, there are a few key points to keep in mind when configuring your cloud config file:

• We set install.image to the container image that we want to deploy. This can be an image from our support matrix, a custom image or an image from scratch.
• After the installation is complete, the configuration in the k3s block will take effect. This is because after the installation, the system will boot into the image specified in the install.image field, which in the example above is an image with the Kairos K3s provider, as such the configuration in the k3s block will become active.

With these steps, you should now be able to use Kairos core images as an installer to deploy other container images. The process is straightforward and gives you the flexibility to customize your deployments and build custom images as needed.

You can also refer our troubleshooting document if you are facing any issue while following the installation process.