Revision as of 16:58, 4 January 2022

New requirements for akmods binary kernel modules for Silverblue / Kinoite support

Summary

In order to improve the current support for akmods based binary kernel modules in Silverblue/Kinoite, this change introduces a new dependency in akmods to a meta package that strongly links the version of a kernel package with its -devel sub-package.

Owner

Name: Timothée Ravier
Email: siosm@fedoraproject.org

Name: Nicolas Chauvet
Email: kwizart@fedoraproject.org

Name: Tomáš Popela
Email: tpopela@fedoraproject.org

Current status

Targeted release: Fedora Linux 36
Last updated: 2022-01-04
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

Silverblue & Kinoite currently include the kernel-devel and glibc-devel packages by default in the base image to work around dependency issues when using akmods based binary kernel modules such as the NVIDIA binary driver.

To be able to remove that dependency, a new meta-package has been added as kernel sub-package to strongly link a given kernel with its corresponding -devel sub-package that is needed for building those kernel modules with akmods.

With this change, custom kernel builds outside of the fedora repository will have to provide this new meta-package.

A longer explanation of how akmods based binary kernel modules are supported in Silverblue / Kinoite is available in https://src.fedoraproject.org/rpms/akmods/pull-request/3#comment-90939.

References:

New kernel{,-debug}-devel-matched sub-packages: https://gitlab.com/cki-project/kernel-ark/-/merge_requests/1195
Dependency change in akmods: https://src.fedoraproject.org/rpms/akmods/pull-request/3
Dependency removal in Silverblue/Kinoite: https://pagure.io/workstation-ostree-config/pull-request/214

Feedback

See individual PRs for existing discussions.

Benefit to Fedora

This change will noticeably reduce the size of the Silverblue / Kinoite base image and updates for users that do not use any binary kernel modules.

Scope

Proposal owners:

 * Code changes are ready. Merging is in progress.

Other developers:

 * Custom kernel builds outside of the fedora repository will have to provide this new meta-package.

Release engineering: N/A (not needed for this Change)
Policies and guidelines: N/A (not needed for this Change)
Trademark approval: N/A (not needed for this Change)
Alignment with Objectives: N/A

Upgrade/compatibility impact

This should not impact existing systems on updates. Users already using binary kernel modules will now have those dependencies automatically installed. Other users will have them removed.

How To Test

Install the an akmods based binary kernel module (from RPM Fusion for example) on Silverblue/Kinoite once the changes mentioned above are merged.
This should work just like it does on F35.

User Experience

There should be no change in user experience.

Dependencies

N/A

Contingency Plan

Contingency mechanism: Revert to previous behavior
Contingency deadline: Beta freeze
Blocks release? No

Documentation

N/A (not a System Wide Change)

Release Notes

@@ Line 2: / Line 2: @@
 == Summary ==
-In order to improve the current support for akmods based binary kernel modules in Silverblue/Kinoite, this change introduces a new dependency in akmods to a meta package that strongly links the version of a kernel package with its `-devel` variant.
+In order to improve the current support for akmods based binary kernel modules in Silverblue/Kinoite, this change introduces a new dependency in akmods to a meta package that strongly links the version of a kernel package with its `-devel` sub-package.
 <!-- 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?". -->
 == Owner ==
-<!--
+* Name: [[User:Siosm| Timothée Ravier]]
-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: siosm@fedoraproject.org
-This should link to your home wiki page so we know who you are.
--->
-* Name: [[User:FASAcountName| Your Name]]
-<!-- 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: <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>
--->
+* Name: [[User:Kwizart| Nicolas Chauvet]]
+* Email: kwizart@fedoraproject.org
+* Name: [[User:Tpopela| Tomáš Popela]]
+* Email: tpopela@fedoraproject.org
 == Current status ==
@@ Line 28: / Line 25: @@
 <!-- Select proper category, default is Self Contained Change -->
 [[Category:SelfContainedChange]]
-<!-- [[Category:SystemWideChange]] -->
-* Targeted release: [[Releases/<number> | Fedora Linux <number> ]]
+* Targeted release: [[Releases/36 | Fedora Linux 36 ]]
-* Last updated: <!-- this is an automatic macro — you don't need to change this line -->  {{REVISIONYEAR}}-{{REVISIONMONTH}}-{{REVISIONDAY2}}
+* Last updated: {{REVISIONYEAR}}-{{REVISIONMONTH}}-{{REVISIONDAY2}}
-<!-- After the change proposal is accepted by FESCo, tracking bug is created in Bugzilla and linked to this page
-Bugzilla state meanings:
-ASSIGNED -> accepted by FESCo with ongoing development
-MODIFIED -> change is substantially done and testable
-ON_QA -> change is fully code complete
--->
 * FESCo issue: <will be assigned by the Wrangler>
 * Tracker bug: <will be assigned by the Wrangler>
@@ Line 43: / Line 33: @@
 == 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. -->
+Silverblue & Kinoite currently include the `kernel-devel` and `glibc-devel` packages by default in the base image to work around dependency issues when using akmods based binary kernel modules such as the NVIDIA binary driver.
+To be able to remove that dependency, a new meta-package has been added as kernel sub-package to strongly link a given kernel with its corresponding `-devel` sub-package that is needed for building those kernel modules with akmods.
 With this change, custom kernel builds outside of the fedora repository will have to provide this new meta-package.
+A longer explanation of how akmods based binary kernel modules are supported in Silverblue / Kinoite is available in https://src.fedoraproject.org/rpms/akmods/pull-request/3#comment-90939.
+References:
+* New `kernel{,-debug}-devel-matched` sub-packages: https://gitlab.com/cki-project/kernel-ark/-/merge_requests/1195
+* Dependency change in akmods: https://src.fedoraproject.org/rpms/akmods/pull-request/3
+* Dependency removal in Silverblue/Kinoite: https://pagure.io/workstation-ostree-config/pull-request/214
 == Feedback ==
-<!-- Summarize the feedback from the community and address why you chose not to accept proposed alternatives. This section is optional for all change proposals but is strongly suggested. Incorporating feedback here as it is raised gives FESCo a clearer view of your proposal and leaves a good record for the future. If you get no feedback, that is useful to note in this section as well. For innovative or possibly controversial ideas, consider collecting feedback before you file the change proposal. -->
+See individual PRs for existing discussions.
 == 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?
-      Be sure to include the following areas if relevant:
-      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.
+This change will noticeably reduce the size of the Silverblue / Kinoite base image and updates for users that do not use any binary kernel modules.
-     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?-->
+  * Code changes are ready. Merging is in progress.
-* 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?-->
+  * Custom kernel builds outside of the fedora repository will have to provide this new meta-package.
-* 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.
-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 -->
-* 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. -->
+* Release engineering: N/A (not needed for this Change)
+* Policies and guidelines: N/A (not needed for this Change)
 * Trademark approval: N/A (not needed for this Change)
-<!-- If your Change may require trademark approval (for example, if it is a new Spin), file a ticket ( https://pagure.io/Fedora-Council/tickets/issues ) requesting trademark approval from the Fedora Council. This approval will be done via the Council's consensus-based process. -->
+* Alignment with Objectives: N/A
-* Alignment with Objectives:
-<!-- Does your proposal align with the current Fedora Objectives: https://docs.fedoraproject.org/en-US/project/objectives/ ? It's okay if it doesn't, but it's something to consider -->
 == 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? -->
+This should not impact existing systems on updates. Users already using binary kernel modules will now have those dependencies automatically installed. Other users will have them removed.
-<!-- 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.
-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 -->
+* Install the an akmods based binary kernel module (from RPM Fusion for example) on Silverblue/Kinoite once the changes mentioned above are merged.
+* This should work just like it does on F35.
 == User Experience ==
-<!-- If this change proposal is noticeable by users, how will their experiences change as a result?
- 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:
+There should be no change in user experience.
-  - 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)? -->
-<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+N/A
 == 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: Revert to previous behavior
-* Contingency mechanism: (What to do?  Who will do it?) N/A (not a System Wide Change)  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+* Contingency deadline: Beta freeze
-<!-- When is the last time the contingency mechanism can be put in place?  This will typically be the beta freeze. -->
+* Blocks release? No
-* Contingency deadline: N/A (not a System Wide Change)  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
-<!-- 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 -->
 == 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. -->
-<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+N/A (not a System Wide Change)
-N/A (not a System Wide Change)
 == Release Notes ==

Search

Changes/Binary Kernel Modules rpm-ostree: Difference between revisions