Trusted Boot Upgrades
Warning
This section is still a work in progress and only available in Kairos v3.x releases and alphas.This section covers how to upgrade a Kairos node with Trusted Boot enabled.
See the Trusted Boot Installation and Trusted Boot Architecture pages for more references.
Upgrades
In order to upgrade a node to a new version of the OS, you need to generate again the installable medium with the same keys used in the steps before.
Note
The resulting container image can be used for upgrades withkairos-agent.
The process will generate an EFI file which we will pack into a container image that will be used to upgrade the node.
First we need to extract the EFI file from the ISO file generated with what explained in the Trusted Boot Installation documentation:
Warning
This step is required until #2171 is implemented.Generate the upgrade image
- Build the container image used to generate the upgrade image
# Build the container image that will be used to generate the keys and installable medium
git clone https://github.com/kairos-io/enki.git
cd enki
docker build -t enki --target tools-image .
- Build the Container image used for upgrades
CONTAINER_IMAGE=quay.io/kairos/@flavor:@flavorRelease-core-amd64-generic-v3.2.2
docker run --rm -v $PWD/keys:/keys -v $PWD:/work -ti enki build-uki $CONTAINER_IMAGE -t uki -d /work/upgrade-image -k /keys
# Generate container-image for upgrades
docker run --rm -v $PWD/keys:/keys -v $PWD:/work -ti enki build-uki $CONTAINER_IMAGE -t container -d /work/upgrade-image -k /keys
- Push the upgrade image to a registry
# Now you can load upgrade_image.tar to a registry and use it with kairos-agent
docker load -i *.tar
#401b8e83daf6: Loading layer [==================================================>] 1.263GB/1.263GB
# Loaded image: kairos_uki:v3.0.0-alpha2
docker push <IMAGE_NAME>
Upgrade with kairos-agent
Warning
For upgrading use the image that has been loaded withdocker load in the step earlier. That contains the EFI files for the upgrade process. Do not use the container image used ($CONTAINER_IMAGE in the example above) used as input!
Let’s assume an upgrade image named acme.com/acme/kairos has been built and pushed
as described in the section above. From a shell inside a running Kairos OS,
the following command will upgrade to the new version:
kairos-agent upgrade --source oci:acme.com/acme/kairos
Upgrades with Kubernetes
To upgrade Kairos with Kubernetes, system-upgrade-controller needs to be deployed on the target cluster. Read the instructions here.
A “Plan” resource needs to be created which will use the image generated in the step above. Since that image only contains the EFI files for the upgrade and in order to be able use any ImagePullSecrets defined on the cluster, we will create and image that can be used to start a Pod and also contains the efi and conf files for the upgrade.
Assuming an upgrade image named acme.com/acme/kairosUpgradeImage was built using a Kairos
image named acme.com/acme/baseImage, the following
dockerfile will create an image that can be used to start a Plan for upgrade:
FROM acme.com/acme/kairos as upgradeImage
FROM acme.com/acme/baseImage
COPY --from=upgradeImage / /trusted-boot
(Let’s call the image built with this dockerfile planImage:vx.y.z)
The following plan can now be deployed on the cluster:
---
apiVersion: v1
kind: Secret
metadata:
name: upgrade
namespace: system-upgrade
type: Opaque
stringData:
upgrade.sh: |
#!/bin/sh
rm -rf /host/usr/local/trusted-boot
mkdir -p /host/usr/local/trusted-boot
mount --rbind /trusted-boot /host/usr/local/trusted-boot
chroot /host kairos-agent --debug upgrade --source dir:/usr/local/trusted-boot
---
apiVersion: upgrade.cattle.io/v1
kind: Plan
metadata:
name: os-upgrade
namespace: system-upgrade
labels:
k3s-upgrade: server
spec:
concurrency: 1
version: "vx.y.z" # The tag of the "upgrade.image" below
nodeSelector:
matchExpressions:
- {key: kubernetes.io/hostname, operator: Exists}
serviceAccountName: system-upgrade
secrets:
- name: upgrade
path: /host/run/system-upgrade/secrets/upgrade
cordon: false
drain:
force: false
disableEviction: true
upgrade:
image: "planImage"
command: ["sh"]
args: ["/run/system-upgrade/secrets/upgrade/upgrade.sh"]
Note
To understand more on how this works, see the example here regarding the system upgrade controller and thesuc-upgrade.sh script
which is used for regular (non trusted boot) upgrades.
Reference
Generate the upgrade image manually
You can also manually generate the container image:
CONF=$(basename $(ls -1 $PWD/upgrade-image/loader/entries/*.conf))
# Replace with the version of the OS you are upgrading to (next boot auto selection)
cat <<EOF > upgrade-image/loader/loader.conf
default $CONF
timeout 5
console-mode max
editor no
EOF
## Generate the container image
docker run --rm -v $PWD:/work --entrypoint /bin/tar -ti enki -C /work/upgrade-image -cf /work/src.tar .
CONTAINER_IMAGE_NAME="ttl.sh/kairos-uki/tests:my-upgrade-image"
docker run -ti -v $PWD:/work quay.io/luet/base:latest util pack $CONTAINER_IMAGE_NAME /work/src.tar /work/upgrade_image.tar