Installation on AWS

Install Kairos on AWS

This page describes how to install Kairos on AWS after you have created an AMI. Since release v3.3.0, Kairos pipeline is pushing a public AMI image to AWS which you can use. If you want to build a custom image, you can follow the instructions in the Build Kairos appliances page.

Prerequisites

  • An AWS account with permissions to create EC2 instances.
  • An AMI image of Kairos. You can use the public AMI image provided by Kairos or build your own image.

Find the AMI

  1. Login to your AWS account.
  2. Go to the EC2 dashboard -> Images -> AMIs.
  3. If you are looking for the Kairos AMI, make sure you are searching among “Public images”. Then search for “kairos” in the search bar.
  4. If you are looking for an AMI you created, make sure you are searching among “Owned by me”. Then search for your AMI.
  5. Select the AMI you want to use (e.g. kairos-ubuntu-24.04-standard-amd64-generic-v3.3.0-k3sv1.32.0-k3s1.raw).
  6. From the top menu, click on Launch instance from AMI.

Launch the instance

In this page you get to select the instance type, configure the instance, and add storage. Make sure you give the instance enough resources to run Kairos and your desired workloads (e.g. make sure the disk is at least 3 times the size of your image to allow for active, passive and recovery images).

You can also pass a Kairos config using the userdata field (Click on Advanced details -> User data and put your Kairos config in the box).

You should at least specify a user and a password (or SSH key) if you need to SSH to the instance (Check the Getting started page for some examples).

When you click on Launch instance the instance will be created and Kairos will boot into “auto-reset mode” by default. This means, that Kairos will “install” itself on the first boot and then reboot.

Access the instance

Once the instance is running, you can access it via SSH. Make sure reset has completed and the system has rebooted into “active” mode. The following command should report “active_boot”:

kairos-agent state get boot

(It it reports recovery_boot, the system is still in the installation process. Wait a few minutes and try again.)

Last modified January 28, 2025: Add page for AWS installation (#344) (c745538)