Document bootc customizations (RHEL-238209) - #213
Conversation
achilleas-k
left a comment
achilleas-k
left a comment
There was a problem hiding this comment.
Nice work, thank you! Couple of notes below but nothing to block on.
LGTM!
|
|
||
| | Path | Source | | ||
| |------|--------| | ||
| | Classic distros | [`ghcr.io/osbuild/image-builder-cli:latest`](https://github.com/osbuild/image-builder/pkgs/container/image-builder-cli) via `list-images` + `describe` (`CONTAINER_IMAGE` in `scripts/pull_image_descriptions.py`). Pull the image before regenerating or docs lag. | |
There was a problem hiding this comment.
"Classic" distros isn't a term we've used before to refer to the package/distro-based images. I don't mind it. I think we've used "traditional" before, but some people take issue with that. I don't like "package mode" or "package-based" either. Adding this note in case anyone has a better idea, but I'm fine with keeping "classic".
There was a problem hiding this comment.
We shouldn't pass anything that can be seen as value judgement e.g. we don't want to say that package based distros are the 'old way'. I'd go with package mode and image mode just to be sure even if we don't particularly like the terms.
There was a problem hiding this comment.
I changed to image mode and package mode. Being consistent and without judgement makes sense. Please check
There was a problem hiding this comment.
Can we add a special case to mention that the "raw" and "ami" image types are identical?
There was a problem hiding this comment.
thanks for this hint! please check
4753b1e to
d63f570
Compare
Teach pull_image_descriptions to generate a bootc 09 family from bootc-generic/imagetypes.yaml (--bootc-only / full pull), invert support lists into a JSON matrix helper, and document that freshness depends on image-builder-cli / osbuild/image-builder. make generate already runs pull-image-descriptions; that target now includes bootc + blueprint-option-support.json. CI pull.yml calls the same target, so daily updates pick up bootc implicitly.
Add the 00-bootc family under 09-image-descriptions (per-type supported_options, container-input note) and link Bootc from the main image-descriptions index.
Point the bootc index and per-type allowlist prose at the browsable github.com/.../blob/main/.../imagetypes.yaml page instead of raw.githubusercontent.com.
e9c0238 to
ec973b3
Compare
3 participants
bootc-generic/imagetypes.yaml(disk vs ISO allowlists; container = input).make pull-image-descriptions/make generate(and thus the daily pull workflow); document container / YAML freshness in the README.Related to HMS-10586
To see the results locally, you can checkout the PR and run
make serve