Add os_purpose field. by garloff · Pull Request #970 · SovereignCloudStack/standards

garloff · 2025-07-24T09:39:27Z

Also add a link to OpenStack specs for os_distro and explain why we need it.

This is patch 1 from several. It adds this os_purpose field as recommended. As it does not break certification, this can be done in the existing v1 of the scs-0102 standard. I suggest we discuss this one first until we are aligned. In parallel, I'd like to prepare a blog article that serves as user guide how to select images in a portable way without relying on the name. We can reference it in the implementation notes. We should also enhance the image-manager input to carry this field soon and create test cases.

In a future patch, we create a v2 of scs-0102 which requires the os_purpose field. The naming in scs-0102 is already a recommendation only, so that can remain. scs-0104 will need a new version then, as it does use the recommended names as mandatory for the mandatory images.

Standards/scs-0102-v1-image-metadata.md

garloff · 2025-09-02T13:28:42Z

I suggest to wait on the outcome of the discussion in PR OSISM/openstack-image-manager #952 to see whether or not we want to have an os_purpose=network in the list or maybe change capinode to k8snode.

mbuechse · 2025-09-03T19:53:44Z

Converted to draft because the tests have to be adapted (preferably after #970 has been merged).

garloff · 2025-09-04T20:38:29Z

This looks ready to me now.
@mbueche: Do you want to insist on tests prior to merging?
We need tests before this becomes mandatory, obviously (which will be a v2), for a recommended property, I'd think it's a nice-to-have.

mbuechse · 2025-09-05T10:41:56Z

@garloff Fine, we can add tests later. Have had a chance to look at the last remaining conversation?

garloff · 2025-09-05T22:13:16Z

Help me: Anything open?

garloff · 2025-09-06T06:50:48Z

Thanks for the pointer!
You were right:

The history here was redundant
At this place, the context was clear
I merged your suggested change, thanks!

mbuechse

Great!

Minor suggestion: add another line break.

Standards/scs-0102-v1-image-metadata.md

garloff · 2025-09-07T15:50:32Z

OK, so we have a test now.
Required a bit more changes than I would have liked ... thus I tested quite a bit.
As collateral damage, we got rid of a warning (cirros 32MB) and report missing mandatory images correctly with ERROR prefix now and have a few more comments in the code.
A re-review by the members of the higher league of Python wizardry may seem appropriate.

mbuechse · 2025-09-07T18:29:12Z

@garloff The main problem is that we have concurrent change of the file in #899 as I expressly told everyone in the SIG meetings, so now I have to sort that out, and I guess I will, but please don't merge yet.

mbuechse · 2025-09-07T18:30:20Z

Converted back to draft to be extra sure that no accidental merge happens. I have to sort out the potential conflicts with #899 first.

garloff · 2025-09-08T10:02:26Z

Oh well, I thought that the refactoring has landed meanwhile.
Apparently not.
Well, the changes to the test can be redone, so we could drop them from #970 as intended before.

mbuechse · 2025-09-08T10:08:24Z

In all likelihood, the changes will be landing today, and then, I can rebase this.

Also add a link to OpenStack specs for os_distro and explain why we need it. This is patch 1 from several. It adds this os_purpose field as *recommended*. As it does not break certification, this can be done in the existing v1 of the scs-0102 standard. I suggest we discuss this one first until we are aligned. In parallel, I'd like to prepare a blog article that serves as user guide how to select images in a portable way without relying on the name. We can reference it in tne implementation notes. We should also enhance the image-manager input to carry this field soon. In a future patch, we create a v2 of scs-0102 which *requires* the os_purpose field. The naming in scs-0102 is already a recommendation only, so that can remain. scs-0104 will need a new version then, as it does use the recommended names as mandatory for the mandatory images. Signed-off-by: Kurt Garloff <kurt@garloff.de>

Signed-off-by: Kurt Garloff <kurt@garloff.de>

From today's SIG Std/Cert: Only the tuple (os_distro, os_version, architecture) should be unique for os_purpose=generic. Signed-off-by: Kurt Garloff <kurt@garloff.de>

As per today's SIG Std/Cert discussion, these terms may be too generic to be useful. So let's instruct providers to use `custom` for now and hope they will talk to use to request new purposes. Signed-off-by: Kurt Garloff <kurt@garloff.de>

Signed-off-by: Kurt Garloff <kurt@garloff.de>

Co-authored-by: Matthias Büchse <matthias.buechse@alasca.cloud> Signed-off-by: Kurt Garloff <kurt@garloff.de>

Signed-off-by: Marvin Frommhold <depressiveRobot@users.noreply.github.com>

As discussed in today's SIG std/cert meeting: * More generic type to cover other k8s image types (beyond capi) Also express expectation to have CRI runtime and kubelet preinstalled. * network type for opnsense, vyos (and amphorae) images Signed-off-by: Kurt Garloff <kurt@garloff.de>

Co-authored-by: Matthias Büchse <matthias.buechse@alasca.cloud> Signed-off-by: Kurt Garloff <kurt@garloff.de>

Signed-off-by: Kurt Garloff <kurt@garloff.de> Co-authored-by: Matthias Büchse <matthias.buechse@alasca.cloud>

Signed-off-by: Matthias Büchse <matthias.buechse@alasca.cloud>

garloff requested review from horazont and mbuechse July 24, 2025 09:39

garloff self-assigned this Jul 24, 2025

garloff added the work in progress Pull requests that are work in progress, do not merge them label Jul 24, 2025

garloff added this to Sovereign Cloud Stack Jul 24, 2025

garloff added the standards Issues / ADR / pull requests relevant for standardization & certification label Jul 24, 2025

github-project-automation bot moved this to Backlog in Sovereign Cloud Stack Jul 24, 2025

horazont approved these changes Jul 31, 2025

View reviewed changes