Implement changes defined in ADR034 and 035 by NotTheEvilOne · Pull Request #393 · gardenlinux/python-gardenlinux-lib

NotTheEvilOne · 2026-09-17T07:38:35Z

What this PR does / why we need it:
This PR implements changes required to suit ADR034 and 035.

Main changes

Implementation of ADR 034 and 035. This requires renaming and introducing inherited classes for Flavor, VersionedFlavor and ArtifactBaseName in gardenlinux.features`.
Fixing sorting of feature lists for flavors.yaml parser in gardenlinux.flavors.Parser
Changes to various classes utilizing gardenlinux.features
Implement changed naming to gl-features-parse and remove shortcut command line tool gl-cname.
The gardenlinux.oci.Container class was (and is still) derived from oras.container.Container but the name is misleading from an OCI naming perspective. Therefore it has been renamed to gardenlinux.oci.Registry and some methods and gl-oci command line parameters have been changed.

Which issue(s) this PR fixes:
Fixes #376
Fixes #377
Requires #390
Related gardenlinux/gardenlinux#5533

codecov · 2026-09-18T12:36:42Z

Codecov Report

❌ Patch coverage is 89.83516% with 74 lines in your changes missing coverage. Please review.
✅ Project coverage is 91.60%. Comparing base (acc50b5) to head (8529dc4).
⚠️ Report is 18 commits behind head on main.

Files with missing lines	Patch %	Lines
src/gardenlinux/features/artifact_base_name.py	86.39%	20 Missing ⚠️
src/gardenlinux/oci/__main__.py	90.27%	18 Missing ⚠️
src/gardenlinux/features/__main__.py	82.55%	15 Missing ⚠️
src/gardenlinux/features/c_name.py	94.18%	5 Missing ⚠️
src/gardenlinux/oci/repository.py	89.36%	5 Missing ⚠️
src/gardenlinux/oci/podman.py	77.77%	4 Missing ⚠️
src/gardenlinux/s3/__main__.py	50.00%	4 Missing ⚠️
src/gardenlinux/features/parser.py	88.88%	2 Missing ⚠️
src/gardenlinux/oci/image_manifest.py	90.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #393      +/-   ##
==========================================
+ Coverage   91.28%   91.60%   +0.32%     
==========================================
  Files          49       51       +2     
  Lines        2971     3050      +79     
==========================================
+ Hits         2712     2794      +82     
+ Misses        259      256       -3

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Signed-off-by: Tobias Wolf <wolf@b1-systems.de> On-behalf-of: SAP <tobias.wolf@sap.com>

gardenlinux-docs-bot · 2026-09-29T10:39:07Z

📚 Documentation Preview PR: gardenlinux/docs#184
😎 Deploy Preview: https://deploy-preview-184--gardenlinux-docs.netlify.app

A PR has been created/updated to preview the documentation changes from this PR.

yeoldegrove

Added some comments in the code.

Also please justify in the PR description or fix:

GL_ALLOW_FRANKENSTEIN and GL_ALLOW_MULTIPLE_PLATFORMS env vars are still evaluated and GARDENLINUX_PLATFORM from /etc/os-release (created by builder) is not taken into account. This is different as outlined in #376.
CName.platform still exists (related to 1.) but should be reworked as outlined in #377.

yeoldegrove · 2026-09-30T08:37:20Z

+        cname, arch = value.rsplit("-", 1)
+        self["annotations"][ImageManifest.ANNOTATION_ARCH_KEY] = arch
+        self["annotations"][ImageManifest.ANNOTATION_CNAME_KEY] = cname


Would it make sense to validate cname and arch?

Validation could be implemented but would only contain basic formatting validation as we can not hard code a list of architectures or validate the content of the feature list of a CName.

We have an ARCH constant already that can be used.
The CName class does not include something that throws a RuntimeError or ValueError if an invalid cname is passed to a function, maybe it is worth adding something and also using it here. This is up to you.

While we do have the ARCH constant I'm not a fan of hard coding these kind of things. Generic ASCII validation could be implemented. I'll need to check if annotations require specific restrictions as the gardenlinux.oci.ImageManifest (and Manifest) classes can be used in ways currently not foreseen and we would require to change it again later.

Proceed as you see it necessary.

Validation is now implemented through the implicit generation of an artifact base name validating all components including the CName and image architecture.

yeoldegrove · 2026-09-30T08:41:11Z

+            else:
+                features.append(feature)
+
        return reduce(


Does it make sense to use sort_graph_nodes here?

Unfortunately we would need a graph for using sort_graph_nodes. get_cname_from_feature_set() and get_cname_as_feature_set() accept input from e.g. the os_release file fields without evaluating if the given feature set is plausible. Therefore this sorting can only work with data available.

Ok, totally did not see that it needs the graph passed to it, forget this, then...
#377 point out to use the same lexicographical topological sort as the builder. Is this taken care of here?

The lexicographical topological sorting needs a feature graph to work. As CName generation from a feature set based on an cached *.release should work without a features directory only part of the sorting can be implemented in the named methods. They are sort by platform (first element of the feature set), features and flags, each sorted alphabetically.

NotTheEvilOne · 2026-09-30T09:38:02Z

Added some comments in the code.

Also please justify in the PR description or fix:

1. `GL_ALLOW_FRANKENSTEIN` and `GL_ALLOW_MULTIPLE_PLATFORMS` env vars are still evaluated and `GARDENLINUX_PLATFORM` from `/etc/os-release` (created by builder) is not taken into account. This is different as outlined in #376.

2. `CName.platform` still exists (related to 1.) but should be reworked as outlined in #377.

Thanks for taking your time reviewing. Regarding platform this field is intended in addition to platform_variant to be visible first class citizens of the CName class. Beside the availability of the property feature_set_platform it reflects the os_release key GARDENLINUX_PLATFORM instead of GARDENLINUX_FEATURES_PLATFORMS. As we accept input from os_release without parsing the features tree if cached both properties exist.

As the alternative to the enviromment variables an command line argument --allow-frakenstein would be needed that needs to be reevaluated in different code paths (like within gardenlinux.features.CName and __main__.py) this implementation specific behaviour has not been changed. python-gardenlinux-lib can be extended and reused in other Python projects while the builder is a standalone application. This causes implementation details to be adjusted based on intended usage.

yeoldegrove · 2026-09-30T12:41:25Z

Added some comments in the code.
Also please justify in the PR description or fix:
1. `GL_ALLOW_FRANKENSTEIN` and `GL_ALLOW_MULTIPLE_PLATFORMS` env vars are still evaluated and `GARDENLINUX_PLATFORM` from `/etc/os-release` (created by builder) is not taken into account. This is different as outlined in #376.

2. `CName.platform` still exists (related to 1.) but should be reworked as outlined in #377.
Thanks for taking your time reviewing. Regarding platform this field is intended in addition to platform_variant to be visible first class citizens of the CName class. Beside the availability of the property feature_set_platform it reflects the os_release key GARDENLINUX_PLATFORM instead of GARDENLINUX_FEATURES_PLATFORMS. As we accept input from os_release without parsing the features tree if cached both properties exist.

Sounds fine for me to stay this way, then.

As the alternative to the enviromment variables an command line argument --allow-frakenstein would be needed that needs to be reevaluated in different code paths (like within gardenlinux.features.CName and __main__.py) this implementation specific behaviour has not been changed. python-gardenlinux-lib can be extended and reused in other Python projects while the builder is a standalone application. This causes implementation details to be adjusted based on intended usage.

Ok, so to not pull in the builder as a dependency, these stay for now. Fine with me.

NotTheEvilOne · 2026-10-08T07:29:49Z

Reviewers note: The gardenlinux.oci.Container class was (and is still) derived from oras.container.Container but the name is misleading from an OCI naming perspective. Therefore it has now been renamed to gardenlinux.oci.Registry and some methods and gl-oci command line parameters have been changed.

Signed-off-by: Tobias Wolf <wolf@b1-systems.de> On-behalf-of: <tobias.wolf@sap.com>

nkraetzschmar · 2026-10-28T16:34:29Z

+
+        cname, arch = value.rsplit("-", 1)
+        self["annotations"][ImageManifest.ANNOTATION_ARCH_KEY] = arch
+        self["annotations"][ImageManifest.ANNOTATION_CNAME_KEY] = cname


We probably can NOT change the content of this annotation. This annotation is load bearing for the gardenlinux-update tool¹.

So while this change would correctly bring the annotation in line with cname as defined in ADR035, it would break compatibility with existing versions of the update tooling. While we can update the tooling and in the future read this annotation correctly or use a different annotation, we can not do that retroactively for existing released images.

The existing images will need to continue to be able to fetch updates of new versions from the OCI, so the check:

strings.HasPrefix(entry.Annotations.Cname, cname)

will need to continue to return true => we MUST maintain the incorrect value in the cname field of the OCI manifest or we brake the ability of existing versions to update to future versions.

Footnotes

https://github.com/gardenlinux/package-gardenlinux-update/blob/bf86a4e56204bae69df7c6edc9bce9dcbff2906b/src/main.go#L167 ↩

NotTheEvilOne force-pushed the feature/adr34 branch 4 times, most recently from 82428ae to 0efc342 Compare September 18, 2026 12:06

NotTheEvilOne force-pushed the feature/adr34 branch 16 times, most recently from 62064c1 to bfd41fc Compare September 29, 2026 08:24

NotTheEvilOne requested a review from a team September 29, 2026 08:46

NotTheEvilOne self-assigned this Sep 29, 2026

NotTheEvilOne marked this pull request as ready for review September 29, 2026 08:46

This was referenced Sep 29, 2026

Align platform resolution with ADR 0034 #376

Open

Align cname and flavor handling with ADR 0035 #377

Open

Remove no longer used GitHub actions

b4d51db

Signed-off-by: Tobias Wolf <wolf@b1-systems.de> On-behalf-of: SAP <tobias.wolf@sap.com>

NotTheEvilOne force-pushed the feature/adr34 branch 3 times, most recently from d8d08bd to 3871196 Compare September 29, 2026 10:36

gardenlinux-docs-bot Bot mentioned this pull request Sep 29, 2026

docs(python-gardenlinux-lib): Update commit lock from PR #393 gardenlinux/docs#184

Draft

NotTheEvilOne force-pushed the feature/adr34 branch from 3871196 to b1d55ca Compare September 29, 2026 10:40

yeoldegrove requested changes Sep 30, 2026

View reviewed changes

NotTheEvilOne force-pushed the feature/adr34 branch 10 times, most recently from ac711f0 to 9687c9a Compare October 8, 2026 07:16

NotTheEvilOne force-pushed the feature/adr34 branch from 9687c9a to 4ac5692 Compare October 28, 2026 08:53

NotTheEvilOne requested a review from yeoldegrove October 28, 2026 11:53

Implement changes for ADR034 and 035.

8529dc4

Signed-off-by: Tobias Wolf <wolf@b1-systems.de> On-behalf-of: <tobias.wolf@sap.com>

NotTheEvilOne force-pushed the feature/adr34 branch from 4ac5692 to 8529dc4 Compare October 28, 2026 14:47

nkraetzschmar requested changes Oct 28, 2026

View reviewed changes

nkraetzschmar mentioned this pull request Oct 28, 2026

staged implementation of ADR 0035 in OCI manifest gardenlinux/gardenlinux#5534

Open

Conversation

NotTheEvilOne commented Sep 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Sep 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

gardenlinux-docs-bot Bot commented Sep 29, 2026

Uh oh!

yeoldegrove left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yeoldegrove Sep 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NotTheEvilOne commented Sep 30, 2026

Uh oh!

yeoldegrove commented Sep 30, 2026

Uh oh!

NotTheEvilOne commented Oct 8, 2026

Uh oh!

Choose a reason for hiding this comment

Footnotes

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

NotTheEvilOne commented Sep 17, 2026 •

edited

Loading

codecov Bot commented Sep 18, 2026 •

edited

Loading

yeoldegrove Sep 30, 2026 •

edited

Loading