m (→Scope) |
No edit summary |
||
| Line 4: | Line 4: | ||
== Summary == | == Summary == | ||
Fedora distributed as bootable container ships via [https://quay.io/repository/fedora/fedora-bootc?tab=tags OCI registry]. Installation is typically done by conversion into a VM image or ISO installer via [https://osbuild.org/ osbuild] (image builder), however, booting from network is a useful workflow for bare-metal fleet deployments. Required files to perform such installation are not available in the OCI repository. | Fedora distributed as bootable container ships via [https://quay.io/repository/fedora/fedora-bootc?tab=tags OCI registry]. Installation is typically done by conversion into a VM image or ISO installer via [https://osbuild.org/ osbuild] (image builder), however, booting from network is a useful workflow for bare-metal fleet deployments. Required files to perform such installation are not available in the OCI repository that could be fetched from registry in a similar manner as the bootable container. | ||
As of today, files are only available in the Fedora RPM repository and the installation workflow would be cumbersome to find appropriate RPM repo version and extract needed files instead of fetching all the needed assets from the registry only. | |||
== Owner == | == Owner == | ||
| Line 14: | Line 16: | ||
== Current status == | == Current status == | ||
[[Category: | [[Category:ChangeReadyForWrangler]] | ||
<!-- When your change proposal page is completed and ready for review and announcement --> | <!-- When your change proposal page is completed and ready for review and announcement --> | ||
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler --> | <!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler --> | ||
| Line 44: | Line 46: | ||
Some files are distributed unsigned in the `images/` directory, others are signed and need to be extracted from RPM packages. A complete ISO "netboot" image is also available for network installations, the image can be customized using `mkksiso` tool found in Fedora. | Some files are distributed unsigned in the `images/` directory, others are signed and need to be extracted from RPM packages. A complete ISO "netboot" image is also available for network installations, the image can be customized using `mkksiso` tool found in Fedora. | ||
The main goal of this change is to start publishing the mentioned | The main goal of this change is to start publishing the mentioned files as [https://oras.land/docs/concepts/artifact/ OCI artifacts] for each Fedora version and architecture. Buildah/Podman will be used for creating such manifest and [https://gitlab.com/fedora/bootc/netboot/netboot/-/blob/main/push.sh?ref_type=heads pushing it] to OCI registry. | ||
There | There is currently no support for downloading OCI artifacts with podman but the feature is currently being discussed and worked on upstream. However, Fedora contains `golang-oras` tool which understands the OCI artifact format. This tool can be used by Fedora users to consume the content: | ||
<pre> | <pre> | ||
| Line 61: | Line 63: | ||
</pre> | </pre> | ||
There is a [https://github.com/pulp/netboot-oci-specs/blob/main/netboot-oci-artifacts.md manifest specification] | There is a [https://github.com/pulp/netboot-oci-specs/blob/main/netboot-oci-artifacts.md manifest specification] describing kickstart files stored as OCI artifacts. | ||
== Benefit to Fedora == | == Benefit to Fedora == | ||
| Line 70: | Line 71: | ||
Users of regular (RPM) Fedora spin will benefit as well since bare-metal provisioning workflows, scripts or tools can be further simplified. All the content will be also signed by GPG which is not the case for some (executable) files today. | Users of regular (RPM) Fedora spin will benefit as well since bare-metal provisioning workflows, scripts or tools can be further simplified. All the content will be also signed by GPG which is not the case for some (executable) files today. | ||
Using OCI artifacts | Using OCI artifacts enables us to distribute the files through the registry under e.g. `quay.io/fedora/kickstart-artifacts`. | ||
== Scope == | == Scope == | ||
* Proposal owners: prepare CI/CD pipeline for fully automated build and push of artifacts, integrate the published repositories with related open-source project [https://theforeman.org/ Foreman] and [https://pulpproject.org/ Pulp] | * Proposal owners: prepare CI/CD pipeline for fully automated build and push of kickstart artifacts, integrate the published repositories with related open-source project [https://theforeman.org/ Foreman] and [https://pulpproject.org/ Pulp] | ||
* Release engineering: create new repository in fedora namespace [https://pagure.io/fedora-infrastructure/issue/12152 #12152] | * Release engineering: create new repository in fedora namespace [https://pagure.io/fedora-infrastructure/issue/12152 #12152] | ||
| Line 80: | Line 81: | ||
== Documentation == | == Documentation == | ||
The newly created repository will be features in documentation of several projects that will make use of it: | The newly created repository will be features in documentation of several upstream projects that will make use of it: | ||
* osbuild | * osbuild | ||
Revision as of 10:19, 11 September 2024
Distributing Kickstart Files as OCI Artifacts
This document represents a proposed Change. As part of the Changes process, proposals are publicly announced in order to receive community feedback. This proposal will only be implemented if approved by the Fedora Engineering Steering Committee.
Summary
Fedora distributed as bootable container ships via OCI registry. Installation is typically done by conversion into a VM image or ISO installer via osbuild (image builder), however, booting from network is a useful workflow for bare-metal fleet deployments. Required files to perform such installation are not available in the OCI repository that could be fetched from registry in a similar manner as the bootable container.
As of today, files are only available in the Fedora RPM repository and the installation workflow would be cumbersome to find appropriate RPM repo version and extract needed files instead of fetching all the needed assets from the registry only.
Owner
- Name: Ina Panova, Lukáš Zapletal
- Email: <ipanova@redhat.com>, <lzap@redhat.com>
Current status
- Targeted release: Fedora Linux 42
- Last updated: 2024-09-11
- [Announced]
- [<will be assigned by the Wrangler> Discussion thread]
- FESCo issue: <will be assigned by the Wrangler>
- Tracker bug: <will be assigned by the Wrangler>
- Release notes tracker: <will be assigned by the Wrangler>
Detailed Description
Fedora bootable container is shipped via OCI registries without any supplementary files for automated kickstart installations. The files needed for this workflow are typically: bootloader, anaconda kernel, initramdisk and anaconda main image. These files can be found in regular Fedora RPM repository, for example in case of x86_64 architecture:
Some files are distributed unsigned in the images/ directory, others are signed and need to be extracted from RPM packages. A complete ISO "netboot" image is also available for network installations, the image can be customized using mkksiso tool found in Fedora.
The main goal of this change is to start publishing the mentioned files as OCI artifacts for each Fedora version and architecture. Buildah/Podman will be used for creating such manifest and pushing it to OCI registry.
There is currently no support for downloading OCI artifacts with podman but the feature is currently being discussed and worked on upstream. However, Fedora contains golang-oras tool which understands the OCI artifact format. This tool can be used by Fedora users to consume the content:
$ oras pull quay.io/lzapletal/fedora-bootfiles:40-amd64 Downloaded 80c3fe2ae106 boot.iso Downloaded a3b7052d7b2f grubx64.efi Downloaded fff4b2feeef3 pxelinux.0 Downloaded 4773d74d87c2 shimx64.efi Downloaded 09cf5df01619 vmlinuz Downloaded 8ea1dd040e97 initrd.img Restored 80c3fe2ae106 install.img Pulled quay.io/lzapletal/fedora-bootfiles:40-amd64 Digest: sha256:0306e10fd556e12ce8c3674150bceb88c0917b74b63c37eecc17070b3b30003b
There is a manifest specification describing kickstart files stored as OCI artifacts.
Benefit to Fedora
The change solves the situation for Fedora bootable containers users who currently need to find matching Fedora RPM repositories and use various tools like curl or rpm2cpio and cpio to download required files.
Users of regular (RPM) Fedora spin will benefit as well since bare-metal provisioning workflows, scripts or tools can be further simplified. All the content will be also signed by GPG which is not the case for some (executable) files today.
Using OCI artifacts enables us to distribute the files through the registry under e.g. quay.io/fedora/kickstart-artifacts.
Scope
- Proposal owners: prepare CI/CD pipeline for fully automated build and push of kickstart artifacts, integrate the published repositories with related open-source project Foreman and Pulp
- Release engineering: create new repository in fedora namespace #12152
Documentation
The newly created repository will be features in documentation of several upstream projects that will make use of it:
- osbuild
- foreman
- pulp
Release Notes
TBD