kairos-agent list-releases using wrong url

[jasperdekeuk]

Kairos version:

<!-- Provide the output from "cat /etc/os-release" -->
<!-- Provide the output from "cat /etc/kairos-release" -->
KAIROS_ARCH="amd64"
KAIROS_BUG_REPORT_URL="https://github.com/kairos-io/kairos/issues"
KAIROS_FAMILY="debian"
KAIROS_FIPS="false"
KAIROS_FLAVOR="ubuntu"
KAIROS_FLAVOR_RELEASE="24.04"
KAIROS_HOME_URL="https://github.com/kairos-io/kairos"
KAIROS_ID="kairos"
KAIROS_ID_LIKE="kairos-core-ubuntu-24.04"
KAIROS_INIT_VERSION="v0.7.0"
KAIROS_MODEL="generic"
KAIROS_NAME="kairos-core-ubuntu-24.04"
KAIROS_RELEASE="v0.0.1"
KAIROS_TARGETARCH="amd64"
KAIROS_TRUSTED_BOOT="false"
KAIROS_VARIANT="core"
KAIROS_VERSION="v0.0.1"

CPU architecture, OS, and Version:

Azure vm X86

Linux vm-3 6.14.0-36-generic #36~24.04.1-Ubuntu SMP PREEMPT_DYNAMIC Wed Oct 15 15:45:17 UTC 2 x86_64 x86_64 x86_64 GNU/Linux

Describe the bug

Starting with an Azure vm with the default published kairos image. After changing the source and doing an upgrade, the upgrade is done fine and my custom image is running. But if I then do a kairos-agent upgrade list-releases I get a strange result. It uses my tag indeed but not the proper registry url

sudo kairos-agent upgrade list-releases
Using registry: quay.io/kairos
Current image:
quay.io/kairos/ubuntu:24.04-core-amd64-generic-v0.0.1

Available releases with higher version:
quay.io/kairos/ubuntu:24.04-core-amd64-generic-v3.6.0
quay.io/kairos/ubuntu:24.04-core-amd64-generic-v3.5.10
quay.io/kairos/ubuntu:24.04-core-amd64-generic-v3.5.9
quay.io/kairos/ubuntu:24.04-core-amd64-generic-v3.5.8
quay.io/kairos/ubuntu:24.04-core-amd64-generic-v3.5.7
quay.io/kairos/ubuntu:24.04-core-amd64-generic-v3.5.6
quay.io/kairos/ubuntu:24.04-core-amd64-generic-v3.5.5

To Reproduce

1. start with an installed machine
2. change the source in the upgrade of cloud-config to a new (private) registry
3. run an upgrade
4. after upgrade is done check the list-releases

Expected behavior

I would expect the list-releases to always use the source as reference to check for updates (this also helps in testing if private repo is reachable with auth)

Logs

Additional context

Problem seems to be only for the list-releases, when doing an actual upgrade it works as expected

[jimmykarily]

~/workspace/kairos/kairos-agent (main)*$ ./kairos-agent upgrade --help
NAME:
   kairos-agent upgrade

USAGE:
   kairos-agent upgrade [command options]

DESCRIPTION:

   Manually upgrade a kairos node Active image. Does not upgrade the passive image. It upgrades the recovery image when the --recovery flag is passed.

   To specify a version, pass it as argument using the --source flag. Passing just the Kairos version as the first argument is no longer supported. If you speficy a positional argument, it will be treated
   as a value for the --source flag.

   You can also specify the upgrade image by setting "upgrade.system.uri" for the active image or "upgrade.recovery-system.uri" for the recovery image, in the cloud config.

   To retrieve all the available versions, use "kairos upgrade list-releases". Use the --registry flag to specify a custom registry to retrieve the versions from, otherwise it will default to quay.io/kairos.

   $ kairos upgrade list-releases

   See https://kairos.io/docs/upgrade/manual/ for documentation.

kairos-io/kairos-agent#833

It's kind of intentional to keep backwards compatibility.

[jasperdekeuk]

Thanks for pointing out. Should have checked the help -> RTFM 😅
I have created a pr to add it to the docs as well

[jasperdekeuk]

but tbh, I'm not fully sure if I understand why this is the intended use.
If a source is provided in the cloud-config I would expect it uses that source as default to check against.
(but ofc if the source is changed at a point and not the same with the running system, you have the same situation again)

[jimmykarily]

Yes, there is no perfect solutions unfortunately. The list-releases command was meant to be a helper for better UX when we introduced it but in the end it just brought confusion. People can find the image they want through other means easily and more reliably. My opinion is that we should remove it altogether, if we can't make it dead simple to use.

[jasperdekeuk]

what are the other means?
I was mainly interested in it, to use sort of as a dry-run before actually doing an upgrade, checking what image it will pull and update to. (and to easily check that the private registry is accessible etc.)

[jimmykarily]

what are the other means?

E.g. searching for an image using the quay.io search box

The functionality to implicitly upgrade to the latest release has been removed a since a long time (final cleanup here) so there is no other value in running the list-releases command, other than "seeing what's available" for which, the quay.io search is equally useful (and more reliable). For private registries that don't provide search functionality, list-releases might still be useful but not exactly in the scope of what kairos-agent is supposed to do.

[jasperdekeuk]

ah outside of kairos-agent, got it. Makes indeed more sense.
I will close this issue as it is somewhat expected behavior.

Just another note:
Would a dry-run flag make sense for the kairos-agent upgrade?
It would do everything the upgrade does, but not actually upgrade the image.
It just prints out all the meta-data about what image it will pull etc.
So for UX you can see what image will be used in the upgrade, that the private repo is accessible, and potentially other interesting info, before having to really do an upgrade of the system.

[jimmykarily]

Better create a new ticket for the dry-run suggestion so other people notice it and comment (might go unnoticed here). I don't remember all the actions taken during an upgrade, we need to check to decide how useful that would be.