kairos-agent upgrade on custom images fails with missing /etc/os-release keys

[venkatnsrinivasan]

We built a custom image for RHEL 8 with the steps outlined here
https://kairos.io/docs/reference/build-from-scratch/

The resulting image has an /etc/os-release as below.

NAME="Red Hat Enterprise Linux"
VERSION="8.7 (Ootpa)"
ID="rhel"
ID_LIKE="fedora"
VERSION_ID="8.7"
PLATFORM_ID="platform:el8"
PRETTY_NAME="Red Hat Enterprise Linux 8.7 (Ootpa)"
ANSI_COLOR="0;31"
CPE_NAME="cpe:/o:redhat:enterprise_linux:8::baseos"
HOME_URL="https://www.redhat.com/"
DOCUMENTATION_URL="https://access.redhat.com/documentation/red_hat_enterprise_linux/8/"
BUG_REPORT_URL="https://bugzilla.redhat.com/"
REDHAT_BUGZILLA_PRODUCT="Red Hat Enterprise Linux 8"
REDHAT_BUGZILLA_PRODUCT_VERSION=8.7
REDHAT_SUPPORT_PRODUCT="Red Hat Enterprise Linux"
REDHAT_SUPPORT_PRODUCT_VERSION="8.7"

This image is able to be deployed successfully but when trying and upgrade via kairos-agent upgrade in Kairos 2.2.0 the upgrade fails with
Cant find IMAGE_REPO key under /etc/os-release

[mauromorales]

I think the problem is that the following step:

kairos/Earthfile

Line 111 in 9b3887a

RUN envsubst >>/etc/os-release </usr/lib/os-release.tmpl

is run when building the base images. So when using BYOI it is missing, or at least I couldn't find it on AuroraBuild/osbuilder

[mauromorales]

I think either osbuilder offer a mechanism how to do this (and then it can be used on the main factory as well), or it should be part of the documentation for BYOI. Having said that, it will be the job of the user doing BYOI to define all or most of the values that go there, e.g. keep their own versioning because at the end of the day, they can decide on the cadence of release and it doesn't fit that they keep the same versioning of our releases. Alternatively we could do something like what we do with the k3s version, and when building the BYOI the final version would be something along the lines of KAIROS_VERSION+OWN_VERSION

[jimmykarily]

Let's do 2 things:

• Document the needed /etc/os-release values (which they are and what they do)
• Make them mandatory only when they are needed. E.g. There is no reason to fail an upgrade, if the full image url is provided by the user. We only need the IMAGE_REPO value if a repository is not given with the upgrade command.

[mauromorales]

@venkatnsrinivasan we added functionality on the osbuilder to update the attributes in the os-release. The docs have been updated to reflect this

# Set the Kairos arguments in os-release file to identify your Kairos image
FROM quay.io/kairos/osbuilder-tools:latest as osbuilder
RUN zypper install -y gettext
RUN mkdir /workspace
COPY --from=base /etc/os-release /workspace/os-release
# You should change the following values according to your own versioning and other details
RUN OS_NAME=kairos-core-fedora \
  OS_VERSION=v9.9.9 \
  OS_ID="kairos" \
  OS_NAME=kairos-core-fedora \
  BUG_REPORT_URL="https://github.com/YOUR_ORG/YOUR_PROJECT/issues" \
  HOME_URL="https://github.com/YOUR_ORG/YOUR_PROJECT" \
  OS_REPO="quay.io/YOUR_ORG/core-fedora" \
  OS_LABEL="latest" \
  GITHUB_REPO="YOUR_ORG/YOUR_PROJECT" \
  VARIANT="core" \
  FLAVOR="fedora" \
  /update-os-release.sh

FROM base
COPY --from=osbuilder /workspace/os-release /etc/os-release

from https://kairos.io/docs/reference/build-from-scratch/

[mudler]

@mauromorales I guess we can close this now?

[mauromorales]

It still needs a bump in the agent to check the two items Dimitris added but it comes together with the yip bump so I'm running some tests in a branch

[mauromorales]

@mudler ⬆️

[mauromorales]

Agent has been bumped on Kairos. It will be available in the next release. Please don't hesitate to re-open if you encounter any issues.