docs: rework flavor, cname and related terms after ADR0034 and ADR0035, add links to feature references, dark and light mode images, extend glossary#92
Conversation
✅ Deploy Preview for gardenlinux-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
yeoldegrove
force-pushed
the
docs/flavor_cname
branch
from
24d74aa to
742a8ad
Compare
yeoldegrove
force-pushed
the
docs/flavor_cname
branch
5 times, most recently
from
60db5e6 to
b3cce2b
Compare
nkraetzschmar
left a comment
nkraetzschmar
left a comment
There was a problem hiding this comment.
looks good, just minor nit picks
| ### Versioned Flavor | ||
|
|
||
| The hyphenated string used with the `./build` command that specifies the platform, features, and optionally the architecture for a Garden Linux image. Format: `${platform}-${feature1}-${feature2}-${arch}`. Examples: `kvm-python_dev`, `aws-gardener_prod-amd64`. | ||
| A **versioned flavor** is the flavor qualified with a version — the string passed to the `./build` script to invoke a build: |
There was a problem hiding this comment.
Might make sense here to mention that the build can be given any subset of this. So it could work with either of cname, flavour, or versioned flavour, picking defaults for any component that's not specified. But not sure if that's maybe too much detail for the glossary 🤔 so probably good to leave it as is here and just mention this somewhere else.
There was a problem hiding this comment.
Added a section about partial arguments and linked naming hierarchy.
|
|
||
| ### CNAME (Canonical Name) | ||
|
|
||
| The **cname** is the minimal, canonically-sorted encoding of the feature set — and only the feature set. Architecture, version, and commit are not part of the cname: |
There was a problem hiding this comment.
this should include that it is the minimal representation. so e.g. aws-gardener is a valid cname, while aws-cloud-gardener is not, since aws includes cloud, thus explicitly listing cloud is not minimal.
There was a problem hiding this comment.
Added a section explaining Minimality.
|
|
||
| Automated tests that validate the correct functionality of a Garden Linux image after it's created. Unit tests verify that the image contains expected packages, configurations, and behaviors. See [ADR-0013](./adr/0013-discontinue-packages-musthave-tests.md) for the decision to discontinue certain package must-have tests, and [ADR-0025](./adr/0025-disable-debsums-tests.md) for the decision to disable debsums tests. | ||
|
|
||
| ### USI (Unified System Image) |
There was a problem hiding this comment.
we should probably also define UKI and link https://uapi-group.org/specifications/specs/unified_kernel_image/ there and then derive the USI definition from there
There was a problem hiding this comment.
Added a new UKI entry.
Signed-off-by: Eike Waldt <waldt@b1-systems.de> On-behalf-of: SAP <eike.waldt@sap.com>
Signed-off-by: Eike Waldt <waldt@b1-systems.de> On-behalf-of: SAP <eike.waldt@sap.com>
Signed-off-by: Eike Waldt <waldt@b1-systems.de> On-behalf-of: SAP <eike.waldt@sap.com>
Signed-off-by: Eike Waldt <waldt@b1-systems.de> On-behalf-of: SAP <eike.waldt@sap.com>
Signed-off-by: Eike Waldt <waldt@b1-systems.de> On-behalf-of: SAP <eike.waldt@sap.com>
yeoldegrove
force-pushed
the
docs/flavor_cname
branch
from
1e5f627 to
4e48267
Compare
2 participants
What this PR does / why we need it:
This is an aggregated PR for:
It includes:
Which issue(s) this PR fixes:
Fixes gardenlinux/gardenlinux#4600