Revision as of 15:42, 3 May 2024

Multiple Versioned CRI-O and CRI-Tools Packages

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

The installed versions of Cri-o and cri-tools are supposed to match the version of Kubernetes that they are deployed with. FESCo recently approved multiple, versioned packages for Kubernetes (https://fedoraproject.org/wiki/Changes/VersionedKubernetesPackages). This Change Request, if approved, will allow Fedora to also provide matchin versions of cri-o and cri-tools for Kubernetes administrators that use Fedora as the base machine OS.

Owner

Name: Peter Hunt
Email: pehunt@redhat.com

Name: Brad Smith
Email: bradley.g.smith@gmail.com

Current status

Targeted release: Fedora Linux 41
Last updated: 2024-05-03
[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

Both cri-o (https://src.fedoraproject.org/rpms/cri-o, upstream: https://github.com/cri-o/cri-o) and cri-tools (https://src.fedoraproject.org/rpms/cri-tools, upstream: https://github.com/kubernetes-sigs/cri-tools) are designed to version match the version of Kubernetes they are deployed with. Version matching is a guarantee to Kubernetes administrators that these components use the same API version of the target Kubernetes installation.

Starting in Fedora 41, users will be able to install any supported version of Kubernetes (typically 3 concurrent, supported versions) using, for example, "dnf install kubernetes1.30". This Change, if approved would allow the user to also install cri-o and/or cri-tools with the same version, i.e. "dnf install cri-o1.30 kubernetes1.30" or "dnf install cri-tools1.30" to work with any version 1.30 CRI (Container Runtime Interface) implementation.

Cri-o is a well-regarded CRI implementation. Each Kubernetes cluster requires a CRI implementation such as cri-o to function. Alternatives include containerd or Docker Engine among others.

Cri-tools contains the crictl command line interface tool that provides a CLI for CRI-compatible container runtimes. This allows the CRI runtime developers to debug their runtime without needing to set up Kubernetes components.

Feedback

TBD

Benefit to Fedora

Enthusiasts and kubernetes administrators and developers will have access to the full stack of properly versioned components to install and manage a Kubernetes cluster directly from Fedora repositories. All supported versions of Kubernetes and related components such as cri-o and cri-tools will be available in each of the supported releases of Fedora, starting with Fedora 41.

The past practice of tying a specific version of Kubernetes to a release of Fedora created an unnecessary tight coupling between Fedora and Kubernetes for cluster administrators and developers. In order to change the version of either Kubernetes or Fedora, the version of the other component also needed to change. This proposal completes the changes needed to uncouple Fedora releases and Kubernetes versions.

Scope

Proposal owners: Request appropriate src.fedoraproject.org repositories from Fedora engineering and maintain those repositories.

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

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

Alignment with the Fedora Strategy: This proposal enhances Fedora's strengths in Technology and Innovation as it allows Fedora to function as the machine OS for any supported version of Kubernetes and as the administrator's workstation for all supported Kubernetes clusters regardless of where the cluster is deployed.

Upgrade/compatibility impact

The shift from the existing model to the versioned model could create friction for current users of cri-o or cri-tools on Fedora. Proper use of Provides and Obsoletes in the spec files as well as a supporting communication plan will help to reduce those complications.

Early Testing (Optional)

Do you require 'QA Blueprint' support? N

How To Test

1. Install a versioned cri-o or cri-tools package on a fresh instance of Fedora. Install should be error free.
2. On an existing Fedora machine, replace a non-versioned cri-o or cri-tools package with a versioned package. There should not be any errors.

User Experience

The user experience should remain unchanged except for the need to select a specific version of cri-o or cri-tools.

Dependencies

No direct dependencies. If Kubernetes is installed and used then cri-o and kubernetes should have the same major:minor version. As a command line tool, the version of cri-tools will be selected by the user based on their specific requirements and needs.

Contingency Plan

Contingency mechanism: (What to do? Who will do it?) N/A (not a System Wide Change)
Contingency deadline: N/A (not a System Wide Change)
Blocks release? N/A (not a System Wide Change), Yes/No

Documentation

The Kubernetes section of Fedora Quick Docs (https://docs.fedoraproject.org/en-US/quick-docs/using-kubernetes/) can be expanded as needed.

N/A (not a System Wide Change)

Release Notes

@@ 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 -->
@@ Line 12: / Line 6: @@
 == Summary ==
-Cri-o and cri-tools versions are intended to match the version of Kubernetes that they are deployed with. FESCo recently approved multiple, version packages for Kubernetes (https://fedoraproject.org/wiki/Changes/VersionedKubernetesPackages). This Change Request, if approved, will allow Fedora to also provide correct versions of cri-o and cri-tools for Kubernetes administrators that use Fedora as the base machine OS.
+The installed versions of Cri-o and cri-tools are supposed to match the version of Kubernetes that they are deployed with. FESCo recently approved multiple, versioned packages for Kubernetes (https://fedoraproject.org/wiki/Changes/VersionedKubernetesPackages). This Change Request, if approved, will allow Fedora to also provide matchin versions of cri-o and cri-tools for Kubernetes administrators that use Fedora as the base machine OS.
 == Owner ==
@@ Line 48: / Line 42: @@
 Both cri-o (https://src.fedoraproject.org/rpms/cri-o, upstream: https://github.com/cri-o/cri-o) and cri-tools (https://src.fedoraproject.org/rpms/cri-tools, upstream: https://github.com/kubernetes-sigs/cri-tools) are designed to version match the version of Kubernetes they are deployed with. Version matching is a guarantee to Kubernetes administrators that these components use the same API version of the target Kubernetes installation.
-Starting in Fedora 41, users will be able to install any supported version of Kubernetes (typically 3 concurrent, supported versions) using, for example, "dnf install kubernetes1.30". This Change, if approved would allow the user to also install cri-o and/or cri-tools with the same version, i.e. "dnf install cri-o1.30 kubernetes1.30".
+Starting in Fedora 41, users will be able to install any supported version of Kubernetes (typically 3 concurrent, supported versions) using, for example, "dnf install kubernetes1.30". This Change, if approved would allow the user to also install cri-o and/or cri-tools with the same version, i.e. "dnf install cri-o1.30 kubernetes1.30" or "dnf install cri-tools1.30" to work with any version 1.30 CRI (Container Runtime Interface) implementation.
-Cri-o is a well-regarded implementation of the container runtime interface (CRI). Each Kubernetes cluster requires a CRI implementation to function. Alternatives include containerd or Docker Engine among others.
+Cri-o is a well-regarded CRI implementation. Each Kubernetes cluster requires a CRI implementation such as cri-o to function. Alternatives include containerd or Docker Engine among others.
 Cri-tools contains the crictl command line interface tool that provides a CLI for CRI-compatible container runtimes. This allows the CRI runtime developers to debug their runtime without needing to set up Kubernetes components.
@@ Line 58: / Line 52: @@
 == 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.
+Enthusiasts and kubernetes administrators and developers will have access to the full stack of properly versioned components to install and manage a Kubernetes cluster directly from Fedora repositories. All supported versions of Kubernetes and related components such as cri-o and cri-tools will be available in each of the supported releases of Fedora, starting with Fedora 41.
-     Consider these Change pages from previous editions as inspiration:
+The past practice of tying a specific version of Kubernetes to a release of Fedora created an unnecessary tight coupling between Fedora and Kubernetes for cluster administrators and developers. In order to change the version of either Kubernetes or Fedora, the version of the other component also needed to change. This proposal completes the changes needed to uncouple Fedora releases and Kubernetes versions.
-     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:
+* Proposal owners: Request appropriate src.fedoraproject.org repositories from Fedora engineering and maintain those repositories.
-<!-- 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?-->
-* Other developers: <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+* Policies and guidelines: N/A (not needed for this Change)
-<!-- 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?-->
-* 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. -->
 * 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 the Fedora Strategy:
+* Alignment with the Fedora Strategy: This proposal enhances Fedora's strengths in Technology and Innovation as it allows Fedora to function as the machine OS for any supported version of Kubernetes and as the administrator's workstation for all supported Kubernetes clusters regardless of where the cluster is deployed.
-<!-- Does your proposal align with the current Fedora Strategy: https://discussion.fedoraproject.org/t/fedora-strategy-2028-february-march-planning-work-and-roadmap-til-flock/43618 ? 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? -->
+The shift from the existing model to the versioned model could create friction for current users of cri-o or cri-tools on Fedora. Proper use of Provides and Obsoletes in the spec files as well as a supporting communication plan will help to reduce those complications.
 <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
@@ Line 114: / Line 74: @@
 <!-- This is an optional step for system-wide changes to avail of. If you would like to build an initial proof of concept of your change and have a member of Fedora QA help you write and/or run some initial basic tests on your code, please email tests@fedoraproject.org and include the link to your change proposal. This step is *optional*. -->
-Do you require 'QA Blueprint' support? Y/N <!-- Optional Step for System-Wide Changes only -->
+Do you require 'QA Blueprint' support? N <!-- Optional Step for System-Wide Changes only -->
 == 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.  This can be based off of the above section if early testing has been completed. 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.
+# 1. Install a versioned cri-o or cri-tools package on a fresh instance of Fedora. Install should be error free.
+# 2. On an existing Fedora machine, replace a non-versioned cri-o or cri-tools package with a versioned package. There should not be any errors.
-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?
+The user experience should remain unchanged except for the need to select a specific version of cri-o or cri-tools.
- 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)? -->
+No direct dependencies. If Kubernetes is installed and used then cri-o and kubernetes should have the same major:minor version. As a command line tool,  the version of cri-tools will be selected by the user based on their specific requirements and needs.
 <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
@@ Line 162: / Line 105: @@
 == 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. -->
+The Kubernetes section of Fedora Quick Docs (https://docs.fedoraproject.org/en-US/quick-docs/using-kubernetes/) can be expanded as needed.
 <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->

Search

Changes/VersionedCRI-OandCRI-ToolsPackages: Difference between revisions