From Fedora Project Wiki

Line 167: Line 167:


== Release Notes ==
== Release Notes ==
TBD
<!-- 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 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.  
<!-- 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.  

Revision as of 20:04, 17 August 2023

Kubernetes Package Name Changes

Summary

New or revised (sub)package names are proposed for the Kubernetes packages. The new names will better align Kubernetes with current usage as documented upstream and improve alignment of package content with current Fedora practices and standards.

Owner

Current status

  • Targeted release: Fedora Linux 40
  • Last updated: 2023-08-17
  • [<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

Kubernetes provides "Open Source Production-Grade Container Scheduling And Management".

The existing Kubernetes package and sub-packages are outlined in the table below. All packages include relevant configuration files and documentation (man pages).

Current package and sub-packages in the Kubernetes package
Name Status (Sub )Package Notes
Kubernetes Main Package Empty. Requires the Client sub-package.
Client Sub-package Kubectl - Command line client. Used to manage a cluster from any computer connected to network.
Kubeadm Sub-package Kubeadm - Administrative client. Used to join or remove a node to/from a cluster.
Master Sub-package Kubernetes services packaged as obsolete systemd services. Modern installations of Kubernetes install these services as static pods.
Node Subpackage Kubelet - Kubernetes runtime.

Proposed sub package names and associate content are in the table below.

Proposed package and sub-packages in the Kubernetes package
Name Status (Sub )Package Notes
Kubernetes Main Package Provides kubelet (runtime) and kuberadm (node administation) binaries and configuration files. Requires the Client sub-package.
Kubernetes-doc Sub-package Documentation (man pages) for kubectl and kubeadm.
Client Sub-package Kubectl - Command line client. Used to manage a cluster from any computer connected to network.
Client-doc Sub-package Documentation for kubectl, command line client.

With the proposed sub packages a user that wants to install Kubernetes on a Fedora machine will only need to install the kubernetes rpm and optionally the kubernetes.doc rpm. This action installs all 3 needed Kubernetes binaries and configuration files and aligns with guidance from upstream (i.e. install kubectl, kubeadm, and kubelet on each machine in a cluster).

Kubernetes cluster managers will install, as before, the kubernetes-client rpm on any machine used by the manager to manage a cluster. The kubernetes-client-doc rpm will be optional.

Feedback

Benefit to Fedora

The primary beneficiary will be Fedora users that want to install Kubernetes on a Fedora machine and use that machine as a node in a cluster or as a management console to manage one or more local or remote clusters. It will also segregate out documentation (man files) so that a minimal install can be done with just the needed executables and supporting configuration files. Installation of the kubernetes rpm is all that is needed to prepare a Fedora machine to participate as a node in a cluster. The current package structure requires the user to install either the kubernetes, kubernetes-kubeadm, and kubernetes-node rpms or install the kubernetes-client, kubernetes-kubeadm, and kubernetes-node rpms to obtain the same level of functionality.

Scope

  • Proposal owners:

Modify the kubernetes.spec file to reflect the new package organization and new package content. Build and test new installs and updates across multiple Fedora flavors including server, workstation, and CoreOS.

  • Other developers:

N/A

N/A

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

N/A

  • Trademark approval: N/A (not needed for this Change)
  • Alignment with Community Initiatives:

Upgrade/compatibility impact

The primary effect will be changes to some of the kubernetes-related rpms, but there will not be any effects to existing functionality or configuration. Any scripts or system provisioning tools such as Ansible should continue to function.

How To Test

Two test scenarios are needed.

1. Upgrade Test. Install Kubernetes or the Kubernetes client on a Fedora machine using legacy rpms. Optionally configure a cluster or the client. Upgrade the system using the new packages. No change in functionality or configuration should be detected.

2. New Install Test. Install kubernetes or the client on a Fedora machine using the new rpms. Compare functionality to another machine that has Kubernetes or the client installed using the legacy rpms. No change in functionality should be detected.


User Experience

Users doing a new installation of Kubernetes on a Fedora machine will have a simplified experience. Installing the kubernetes rpm will actually install all needed components of Kubernetes and not just the client as the current rpms do. Similarly, updating a Fedora node in a Kubernetes cluster will only need updating one (1) rpm and not 3 as before.


Dependencies

N/A


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

N/A (not a System Wide Change)

Release Notes

TBD