Revision as of 20:15, 23 June 2023

Build Fedora Workstation live ISO with image builder

This is a proposed Change for Fedora Linux.
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

Image builder is a set of modern tools for building operating system images. Its goal is to make the builds reliable and reproducible. Moreover, it's designed to give the end users a simple workflow to build their own custom images. The aim of this change is to switch the build tool for Fedora Workstation live ISO from livemedia-creator to image builder.

Owner

Name: Ondřej Budai
Email: obudai@redhat.com
Name: Jiří Konečný
Email: jkonecny@redhat.com
Name: Simon de Vlieger
Email: supakeen@redhat.com

Current status

Targeted release: Fedora Linux 39
Last updated: 2023-06-23
[<will be assigned by the Wrangler> devel 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

Image builder is currently getting support for building live ISOs. Once the PR implementing the new image type is merged, the pungi-fedora configuration needs to be updated. This change will ensure that pungi creates an osbuildImage task in koji instead of the currently used livemedia one.

Pungi and Koji already support image builder, so no additional work is required there (refer to the pungi and koji documentation). The only missing part in terms of infrastructure is provisioning ppc64le worker machines for image builder, see the relevant fedora-infra ticket.

Note that image builder is already used for building ISOs and raw disks of Fedora IoT. Therefore, this proposal does not introduce a new tool to the Fedora build pipeline.

Feedback

Benefit to Fedora

The maintainer team of image builder believes that the project undergoes more comprehensive testing compared to lorax/livemedia-creator. Thus, by switching to image builder, Fedora should experience fewer issues with the image building pipeline.

Another advantage is the project's emphasis on making image builder more user-friendly. End users can easily build their own customized version of the live ISO using a simple TOML blueprint file and a CLI interface. This approach, utilizing well-known file formats, is a positive step compared to livemedia-creator's kickstart files. More information about building customized images can found on Major Hayden's blog or in a conference talk given by Ondřej Budai, one of the proposal owners. Moreover, image builder provides a graphical interface for visually defining blueprints, further simplifying the workflow.

We believe that image builder can also be beneficial to the Respins SIG as it nicely aligns with their objective of providing a simple method for building up-to-date, customizable images.

Scope

Proposal owners:

Finishing implementing support for the live ISO upstream and collaborate with release engineering to switch the pungi config to use image builder.

Other developers:

Our focus for this change is specifically on Fedora Workstation. Nevertheless, we are open to collaborating with all spins/SIG to transition their build pipelines to image builder. However, for the initial switch, we aim to minimize the impact by focusing on a single artifact. We anticipate that more artifacts will be transitioned in subsequent releases of Fedora Linux.

Release engineering: #Releng issue number

Provide ppc64le machines to image builder. Switch the pungi config to use image builder.

TODO!!!

Policies and guidelines: N/A (not needed for this Change)

Trademark approval: N/A (not needed for this Change)

Alignment with Community Initiatives:

Upgrade/compatibility impact

There shouldn't be any. The goal of this proposal is to build the same images as livemedia-creator does, just using a different tooling.

How To Test

Once the pungi config is changed, grab the ISO built by image builder and test if there are any unexpected changes.

User Experience

No change is expected.

Dependencies

The Workstation SIG and the installer team are working on a change to use the new installer web UI for the Workstation live ISO. We are fully aware of this change and have the capability to build ISOs with and without the new UI. As a result, these changes should be independent of each other. Furthermore, the installer and image builder teams are closely collaborating, ensuring that any issues that may arise can be addressed with high priority.

Contingency Plan

Contingency mechanism: (What to do? Who will do it?) Release engineering to revert the change in pungi, so that the old tooling is used instead.
Contingency deadline: Final freeze (the change is trivially revertable)
Blocks release? No

Documentation

N/A

Release Notes

TODO!

@@ Line 1: / Line 1: @@
-{{admon/important | Comments and Explanations | The page source contains comments providing guidance to fill out each section. They are invisible when viewing this page. To read it, choose the "view source" link.<br/> '''Copy the source to a ''new page'' before making changes!  DO NOT EDIT THIS TEMPLATE FOR YOUR CHANGE PROPOSAL.'''}}
-{{admon/tip | Guidance | For details on how to fill out this form, see the [https://docs.fedoraproject.org/en-US/program_management/changes_guide/ documentation].}}
-{{admon/tip | Report issues | To report an issue with this template, file an issue in the [https://pagure.io/fedora-pgm/pgm_docs pgm_docs repo].}}
-<!-- The actual name of your proposed change page should look something like: Changes/Your_Change_Proposal_Name.  This keeps all change proposals in the same namespace -->
 = Build Fedora Workstation live ISO with image builder =
@@ Line 12: / Line 4: @@
 == Summary ==
-<!-- A sentence or two summarizing what this change is and what it will do. This information is used for the overall changeset summary page for each release. Note that motivation for the change should be in the Benefit to Fedora section below, and this part should answer the question "What?" rather than "Why?". -->
+Image builder is a set of modern tools for building operating system images. Its goal is to make the builds reliable and reproducible. Moreover, it's designed to give the end users a simple workflow to build their own custom images. The aim of this change is to switch the build tool for Fedora Workstation live ISO from livemedia-creator to image builder.
 == Owner ==
-<!--
+* Name: [[User:obudai|Ondřej Budai]]
-For change proposals to qualify as self-contained, owners of all affected packages need to be included here. Alternatively, a SIG can be listed as an owner if it owns all affected packages.
+* Email: obudai@redhat.com
-This should link to your home wiki page so we know who you are.
+* Name: [[User:jkonecny|Jiří Konečný]]
--->
+* Email: jkonecny@redhat.com
-* Name: [[User:FASAcountName| Your Name]]
+* Name: [[User:Supakeen|Simon de Vlieger]]
-<!-- Include you email address that you can be reached should people want to contact you about helping with your change, status is requested, or technical issues need to be resolved. If the change proposal is owned by a SIG, please also add a primary contact person. -->
+* Email: supakeen@redhat.com
-* Email: <your email address so we can contact you, invite you to meetings, etc. Please provide your Bugzilla email address if it is different from your email in FAS>
-<!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo)
-* FESCo shepherd: [[User:FASAccountName| Shehperd name]] <email address>
--->
@@ Line 34: / Line 22: @@
 <!-- After review, the Wrangler will move your page to Category:ChangeReadyForFesco... if it still needs more work it will move back to Category:ChangePageIncomplete-->
-<!-- Select proper category, default is Self Contained Change -->
+[[Category:SystemWideChange]]
-[[Category:SelfContainedChange]]
-<!-- [[Category:SystemWideChange]] -->
-* Targeted release: [https://docs.fedoraproject.org/en-US/releases/f<VERSION>/ Fedora Linux <VERSION>]
+* Targeted release: [https://docs.fedoraproject.org/en-US/releases/f39/ Fedora Linux 39]
 * Last updated: <!-- this is an automatic macro — you don't need to change this line -->  {{REVISIONYEAR}}-{{REVISIONMONTH}}-{{REVISIONDAY2}}
 <!-- After the change proposal is accepted by FESCo, tracking bug is created in Bugzilla and linked to this page
@@ Line 52: / Line 38: @@
 == Detailed Description ==
-<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
+Image builder is currently getting support for building [https://github.com/osbuild/osbuild-composer/pull/3440 live ISOs]. Once the PR implementing the new image type is merged, [https://pagure.io/pungi-fedora/blob/8b2c85799cce5c096484cdebe1dbe521eaf7fe92/f/fedora.conf#_530 the pungi-fedora configuration] needs to be updated. This change will ensure that pungi creates an osbuildImage task in koji instead of the currently used livemedia one.
+Pungi and Koji already support image builder, so no additional work is required there (refer to the [https://docs.pagure.org/pungi/configuration.html#osbuild-composer-for-building-images pungi] and [https://github.com/osbuild/koji-osbuild/ koji] documentation). The only missing part in terms of infrastructure is provisioning ppc64le worker machines for image builder, see the relevant [https://pagure.io/fedora-infrastructure/issue/11243 fedora-infra ticket].
+Note that image builder is already used for [https://fedoraproject.org/wiki/Changes/IoTArtifactsWithOSBuild building ISOs and raw disks of Fedora IoT]. Therefore, this proposal does not introduce a new tool to the Fedora build pipeline.
 == Feedback ==
@@ Line 58: / Line 48: @@
 == Benefit to Fedora ==
-<!-- What is the benefit to the distribution?  Will the software we generate be improved? How will the process of creating Fedora releases be improved?
+The maintainer team of image builder believes that the project undergoes more comprehensive testing compared to lorax/livemedia-creator. Thus, by switching to image builder, Fedora should experience fewer issues with the image building pipeline.
-      Be sure to include the following areas if relevant:
+Another advantage is the project's emphasis on making image builder more user-friendly. End users can easily build their own customized version of the live ISO using a simple [https://www.osbuild.org/guides/image-builder-on-premises/blueprint-reference.html TOML blueprint file] and a [https://www.osbuild.org/guides/image-builder-on-premises/building-an-image-from-cli.html CLI interface]. This approach, utilizing well-known file formats, is a positive step compared to livemedia-creator's kickstart files. More information about building customized images can found on [https://major.io/2022/05/06/build-a-custom-centos-stream-9-cloud-image/ Major Hayden's blog] or in [https://www.youtube.com/watch?v=PsQySAEOeFs&t=17001s a conference talk] given by Ondřej Budai, one of the proposal owners. Moreover, image builder provides [https://github.com/osbuild/cockpit-composer/ a graphical interface] for visually defining blueprints, further simplifying the workflow.
-      If this is a major capability update, what has changed?
-           For example: This change introduces Python 5 that runs without the Global Interpreter Lock and is fully multithreaded.
-      If this is a new functionality, what capabilities does it bring?
-           For example: This change allows package upgrades to be performed automatically and rolled-back at will.
-      Does this improve some specific package or set of packages?
-           For example: This change modifies a package to use a different language stack that reduces install size by removing dependencies.
-      Does this improve specific Spins or Editions?
-           For example: This change modifies the default install of Fedora Workstation to be more in line with the base install of Fedora Server.
-      Does this make the distribution more efficient?
-           For example: This change replaces thousands of individual %post scriptlets in packages with one script that runs at the end.
-      Is this an improvement to maintainer processes?
-           For example: Gating Fedora packages on automatic QA tests will make rawhide more stable and allow changes to be implemented more smoothly.
-      Is this an improvement targeted as specific contributors?
-           For example: Ensuring that a minimal set of tools required for contribution to Fedora are installed by default eases the onboarding of new contributors.
-     When a Change has multiple benefits, it's better to list them all.
+We believe that image builder can also be beneficial to the [https://fedoraproject.org/wiki/Respins-SIG Respins SIG] as it nicely aligns with their objective of providing a simple method for building up-to-date, customizable images.
-     Consider these Change pages from previous editions as inspiration:
-     https://fedoraproject.org/wiki/Changes/Annobin (low-level and technical, invisible to users)
-     https://fedoraproject.org/wiki/Changes/ParallelInstallableDebuginfo (low-level, but visible to advanced users)
-     https://fedoraproject.org/wiki/Changes/VirtualBox_Guest_Integration (primarily a UX change)
-     https://fedoraproject.org/wiki/Changes/NoMoreAlpha (an improvement to distro processes)
-     https://fedoraproject.org/wiki/Changes/perl5.26 (major upgrade to a popular software stack, visible to users of that stack)
--->
 == Scope ==
 * Proposal owners:
-<!-- What work do the feature owners have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
+Finishing implementing support for the live ISO upstream and collaborate with release engineering to switch the pungi config to use image builder.
-* Other developers: <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+* Other developers:
-<!-- What work do other developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
+Our focus for this change is specifically on Fedora Workstation. Nevertheless, we are open to collaborating with all spins/SIG to transition their build pipelines to image builder. However, for the initial switch, we aim to minimize the impact by focusing on a single artifact. We anticipate that more artifacts will be transitioned in subsequent releases of Fedora Linux.
 * Release engineering: [https://pagure.io/releng/issues #Releng issue number] <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
-<!-- Does this feature require coordination with release engineering (e.g. changes to installer image generation or update package delivery)?  Is a mass rebuild required?  include a link to the releng issue.
+Provide ppc64le machines to image builder. Switch the pungi config to use image builder.
-The issue is required to be filed prior to feature submission, to ensure that someone is on board to do any process development work and testing and that all changes make it into the pipeline; a bullet point in a change is not sufficient communication -->
+TODO!!!
 * Policies and guidelines: N/A (not needed for this Change) <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
-<!-- Do the packaging guidelines or other documents need to be updated for this feature?  If so, does it need to happen before or after the implementation is done?  If a FPC ticket exists, add a link here. Please submit a pull request with the proposed changes before submitting your Change proposal. -->
 * Trademark approval: N/A (not needed for this Change)
@@ Line 107: / Line 76: @@
 == Upgrade/compatibility impact ==
-<!-- What happens to systems that have had a previous versions of Fedora installed and are updated to the version containing this change? Will anything require manual configuration or data migration? Will any existing functionality be no longer supported? -->
+There shouldn't be any. The goal of this proposal is to build the same images as livemedia-creator does, just using a different tooling.
-<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 == How To Test ==
-<!-- This does not need to be a full-fledged document. Describe the dimensions of tests that this change implementation is expected to pass when it is done.  If it needs to be tested with different hardware or software configurations, indicate them.  The more specific you can be, the better the community testing can be.
+Once the pungi config is changed, grab the ISO built by image builder and test if there are any unexpected changes.
-Remember that you are writing this how to for interested testers to use to check out your change implementation - documenting what you do for testing is OK, but it's much better to document what *I* can do to test your change.
-A good "how to test" should answer these four questions:
-. What special hardware / data / etc. is needed (if any)?
-. How do I prepare my system to test this change? What packages
-need to be installed, config files edited, etc.?
-. What specific actions do I perform to check that the change is
-working like it's supposed to?
-. What are the expected results of those actions?
--->
-<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 == User Experience ==
-<!-- If this change proposal is noticeable by users, how will their experiences change as a result?
+No change is expected.
- This section partially overlaps with the Benefit to Fedora section above. This section should be primarily about the User Experience, written in a way that does not assume deep technical knowledge. More detailed technical description should be left for the Benefit to Fedora section.
- Describe what Users will see or notice, for example:
-  - Packages are compressed more efficiently, making downloads and upgrades faster by 10%.
-  - Kerberos tickets can be renewed automatically. Users will now have to authenticate less and become more productive. Credential management improvements mean a user can start their work day with a single sign on and not have to pause for reauthentication during their entire day.
- - Libreoffice is one of the most commonly installed applications on Fedora and it is now available by default to help users "hit the ground running".
- - Green has been scientifically proven to be the most relaxing color. The move to a default background color of green with green text will result in Fedora users being the most relaxed users of any operating system.
--->
 == Dependencies ==
-<!-- What other packages (RPMs) depend on this package?  Are there changes outside the developers' control on which completion of this change depends?  In other words, completion of another change owned by someone else and might cause you to not be able to finish on time or that you would need to coordinate?  Other upstream projects like the kernel (if this is not a kernel change)? -->
+The Workstation SIG and the installer team are working on a change to use the new installer web UI for the Workstation live ISO. We are fully aware of this change and have the capability to build ISOs with and without the new UI. As a result, these changes should be independent of each other. Furthermore, the installer and image builder teams are closely collaborating, ensuring that any issues that may arise can be addressed with high priority.
-<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 == Contingency Plan ==
 <!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "Revert the shipped configuration".  Or it might not (e.g. rebuilding a number of dependent packages).  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
-* Contingency mechanism: (What to do?  Who will do it?) N/A (not a System Wide Change)  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+* Contingency mechanism: (What to do?  Who will do it?) Release engineering to revert the change in pungi, so that the old tooling is used instead.
 <!-- When is the last time the contingency mechanism can be put in place?  This will typically be the beta freeze. -->
-* Contingency deadline: N/A (not a System Wide Change)  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+* Contingency deadline: Final freeze (the change is trivially revertable)
 <!-- Does finishing this feature block the release, or can we ship with the feature in incomplete state? -->
-* Blocks release? N/A (not a System Wide Change), Yes/No <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+* Blocks release? No
 == Documentation ==
-<!-- Is there upstream documentation on this change, or notes you have written yourself?  Link to that material here so other interested developers can get involved. -->
+N/A
-<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
-N/A (not a System Wide Change)
 == Release Notes ==
+TODO!
 <!-- The Fedora Release Notes inform end-users about what is new in the release.  Examples of past release notes are at https://docs.fedoraproject.org/en-US/fedora/latest/release-notes/ -->
 <!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this change, indicate them here.  A link to upstream documentation will often satisfy this need.  This information forms the basis of the release notes edited by the documentation team and shipped with the release.

Search

Changes/FedoraWorkstationImageBuilder: Difference between revisions