From Fedora Project Wiki
(add expected image boot behavior requirements for coreos images)
(except non-anaconda-based images from the installer requirements)
Line 91: Line 91:


{{anchor|installer-requirements}}
{{anchor|installer-requirements}}
=== <span style="text-decoration:underline">Installer requirements</span> ===
=== <span style="text-decoration:underline">Anaconda installer requirements</span> ===
Except where otherwise specified, each of these requirements applies to all supported configurations described [[#initialization-requirements|above]]. These requirements do not apply to images which do not use the installer.
Except where otherwise specified, each of these requirements applies to all supported configurations described [[#initialization-requirements|above]]. These requirements do not apply to images which do not use the "anaconda" installer.


{{anchor|installer-must-run}}
{{anchor|installer-must-run}}
Line 100: Line 100:
{{hidden|header=References|content=
{{hidden|header=References|content=
* Test cases: see test cases for [[#release-blocking-images-must-boot|"Release-blocking images must boot"]]
* Test cases: see test cases for [[#release-blocking-images-must-boot|"Release-blocking images must boot"]]
|headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}
|headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}


Revision as of 23:17, 9 September 2022

Basic Objectives

The objectives for all Branched and Rawhide nightly composes, as well as Beta and Final releases, are to:

  1. Publicly release installable media versions of a test release
  2. Test accepted Changes for future releases
  3. Identify as many Beta blocker bugs as possible
  4. Identify as many Final blocker bugs as possible

Basic Release Requirements

In order to be released to the general public, a compose must meet all of the following criteria. This is intended to make the decision process as clear and straightforward as possible. Mostly met items are incomplete until they are met. Optional and nice to have items should not be included in this list.

There may be times where a requirement is unmet only in a particular configuration, such as with some keyboard layouts but not others, or if a particular character is used in a username, password or passphrase. In such cases, the release team should use their judgement and refer to precedent to determine whether or not the issue should be considered to block the release. They should consider the number of users likely to be affected by the issue, the severity of the case when the issue is encountered, and the ease or otherwise with which the issue can be avoided by both informed and uninformed users.

The term release-blocking desktops means all the desktop environments in which bugs are currently considered capable of blocking a Fedora release. The current set of release-blocking desktops for x86_64 is GNOME and KDE, and for aarch64 is GNOME. Note that bugs in desktops that are not part of this set which would infringe these criteria automatically qualify for freeze exception status, according to the freeze exception bug process.

The term release-blocking images means all the images in which bugs are currently considered capable of blocking a Fedora release. The current set of release-blocking images includes the images defined by the three Editions - Server, Workstation and IoT - in their product requirement documents and/or technical specifications, the Everything network install image, key Cloud images, and the KDE live image. The canonical list of release-blocking images for Fedora 42 is on this page.

Correct checksums

A correct checksum must be published for each official release image.

Automatic blockers

Violations of this criterion for release-blocking images are considered "automatic blockers", they do not have to go through the review process. See QA:SOP_blocker_bug_process#Automatic_blockers for more details on the automatic blocker procedure.

References

Initialization requirements

Release-blocking images must boot

All release-blocking images must boot in their supported configurations.

Supported architectures

Supported architectures are the Fedora primary architectures. All images are not necessarily expected to be available for all primary architectures.

Supported firmware types

Release-blocking images must boot from all system firmware types that are commonly found on the primary architectures. For the x86_64 architecture, UEFI with Secure Boot configured in accordance with Microsoft's Windows certification requirements is considered a 'commonly found' firmware type.

Supported ARM platforms

Supported ARM platforms are those listed by the ARM team at Architectures/ARM/Supported_Platforms.

Supported IoT devices

Supported IoT platforms are those listed by the IoT team here.

Supported cloud environments

Release-blocking cloud images must boot in the Fedora OpenStack Cloud and in Amazon EC2.

Supported media types

Release-blocking live and dedicated installer images must boot when written to a USB stick with at least one of the officially supported methods. Release-blocking ARM disk images must boot when written to a medium bootable by the platform under test, according to the instructions for the platform under test.

System-specific bugs

System-specific bugs don't necessarily constitute an infringement of this criterion - for instance, if the image fails to boot because of a bug in some specific system's firmware, that is unlikely to constitute a violation unless the system is an extremely popular one. See Blocker_Bug_FAQ for more discussion of this.

References

Test cases:

Expected image boot behavior

  • Release-blocking dedicated installer images must boot to the expected boot menu, and then after a reasonable timeout to the installer.
  • Release-blocking live images must boot to the expected boot menu, and then to a desktop or to a login prompt where it is clear how to log in to a desktop.
  • Release-blocking ARM disk images must boot to the initial-setup utility.
  • Release-blocking cloud images (including CoreOS cloud images) must allow login with the user authentication configuration requested during instance creation.
  • Release blocking IoT images must boot and be configurable by the Zezere utility.
  • Release-blocking CoreOS "live ISO" images must boot to a command prompt from which storage can be configured and coreos-installer can be run.
Boot menu contents

The boot menu for all supported installer and live images should include an entry which causes both installation and the installed system to attempt to use a generic, highly compatible video driver (such as 'vesa').

System-specific bugs

System-specific bugs don't necessarily constitute an infringement of this criterion - for instance, if the installer or desktop fails to start because of a bug in support for some specific graphics card, that is unlikely to constitute a violation. See Blocker_Bug_FAQ for more discussion of this.

References

Network requirements

Each of these requirements apply to both installer and installed system environments. For any given installer environment, the 'default network configuration tools' are considered to be those the installer documents as supported ways to configure networking (e.g. for anaconda-based environments, configuration via kernel command line options, a kickstart, or interactively in anaconda itself are included).

Basic networking

It must be possible to establish both IPv4 and IPv6 network connections using both typical router-provided addressing systems (e.g. DHCP on IPv4 or SLAAC or IPv6) and static addressing. The default network configuration tools for the console, for release-blocking desktops and for installer environments must work well enough to allow typical network connection configuration operations without major workarounds. Standard network functions such as address resolution and connections with common protocols such as ping, HTTP and ssh must work as expected.

Supported hardware

Supported network hardware is hardware for which the Fedora kernel includes drivers and, where necessary, for which a firmware package is available. If support for a commonly-used piece or type of network hardware that would usually be present is omitted, that may constitute a violation of this criterion, after consideration of the hardware-dependent-issues|normal factors for hardware-dependent issues. Similarly, violations of this criteria that are hardware or configuration dependent are, as usual, subject to consideration of those factors when determining whether they are release-blocking.

Wireless networks

Common wireless network configurations using supported hardware as defined above are covered by this criterion. This includes access to home and enterprise wireless networks using 802.11 series connection protocols and WPA2 and WPA3 personal and enterprise security protocols. Bugs that are specific to particular hardware or configurations will be assessed according to hardware-dependent-issues|the normal considerations for such issues.

References
  • Proposed 2020-08-21.
  • Revised 2022-06-03.
  • Implemented 2022-07-18.
  • Test cases: casually covered by multiple test cases that require networking, but specific test cases are missing

VPN connections

Using the default network configuration tools for the console and for release-blocking desktops, it must be possible to establish a working connection to common OpenVPN, openconnect-supported and vpnc-supported VPN servers with typical configurations.

Supported servers and configurations

As there are many different VPN server applications and configurations, blocker reviewers must use their best judgment in determining whether violations of this criterion are likely to be encountered commonly enough to block a release, and if so, at which milestone. As a general principle, the more people are likely to use affected servers and the less complicated the configuration required to hit the bug, the more likely it is to be a blocker.

References
  • Proposed 2020-08-21.
  • Revised 2022-06-03.
  • Implemented 2022-07-18.
  • Test cases: casually covered by multiple test cases that require networking, but specific test cases are missing

Anaconda installer requirements

Except where otherwise specified, each of these requirements applies to all supported configurations described above. These requirements do not apply to images which do not use the "anaconda" installer.

Installer must run

The installer must run when launched normally from the release-blocking images.

Launched normally?

'Launched normally' means from the boot menu on a dedicated installer image, and from the desktop on a live image.

References

Remote package sources

When using a release-blocking dedicated installer image, the installer must be able to use HTTP and HTTPS repositories as package sources. Release-blocking network install images must default to a valid publicly-accessible package source.

Covered repository types

This criterion only covers direct repository URLs ("baseurl"), and doesn't cover mirrorlist or metalink URLs.

References

Test cases:

Media package source

When using a dedicated installer image that contains packages, the installer must be able to use the install medium as a package source.

References

Test case: QA:Testcase_Boot_default_install

Installation interfaces

When using a dedicated installer image, the installer must be able to complete an installation using the text, graphical and VNC installation interfaces.

Showstoppers

This criterion covers showstopper bugs in the installer for which there isn't any other specific criterion: obviously, it can't 'complete an installation' if there's a showstopper. However, it does not mean that any failed installation test at all constitutes a release blocking issue: an installer which works fine in most cases but crashes when you attach it to a Hitachi hard disk on a wet Thursday is still 'able to complete an installation'.

References

Test cases:

Package sets

When installing with a release-blocking dedicated installer image, the installer must be able to install the default package set.

References
  • Modification from 'default package set' proposed 2012-09-06.
  • Idea to cover the release blocking desktops and minimal package set proposed 2012-09-06, implemented 2012-09-26.
  • Reversion back to covering only default package set (due to deliverable changes as part of Fedora.next): proposed 2014-12-23, implemented 2015-01-30.
  • Test case: QA:Testcase_Boot_default_install (for each covered image)

Disk selection

The user must be able to select which of the disks connected to the system will be affected by the installation process.

Other disks not touched

Disks not selected as installation targets must not be affected by the installation process in any way.

References

Storage interfaces

The installer must be able to complete an installation using any supported locally connected storage interface.

What are they?

'Locally connected storage interfaces' include PATA, SATA, NVMe, SAS, and SCSI.

References

Test cases:

Disk layouts

The installer must be able to complete an installation to a single disk using automatic partitioning.

Details!

...well, so long as the disk is big enough, of course. It must work whether the disk is formatted or not and whether or not it contains any existing data - but before Beta, it's OK if it can only install to a disk with existing data by overwriting it.

References

Scripted user creation

The scripted installation mechanism must provide a working function for creating local user accounts, including the ability to specify a hashed password, and for specifying a hashed password for the root account.

References

Update image

The installer must be able to download and use an installer update image from an HTTP and HTTPS server.

References

Failure reporting

The installer must be able to report failures to Bugzilla, with appropriate information included.

You mean, ANY failures?

No, silly - we mean crashes, really. This is about the crash reporting capabilities: when the installer crashes, it should pop up some dialogs that let you send a report containing data on the crash.

References

Test case: QA:Testcase_Anaconda_save_traceback_to_bugzilla

Virtualization requirements

Guest on current stable release

The release must install and boot successfully as a virtual guest in a situation where the virtual host is running the current stable Fedora release.

Recommended virtualization technology

This criterion applies only to the recommended Fedora virtualization tools - the qemu/kvm - libvirt - virt-manager stack.

References

Post-install requirements

Except where otherwise specified, each of these requirements applies to all supported configurations described above. These requirements are not applicable to Cloud images.

Expected installed system boot behavior

  • A working mechanism to create a user account must be clearly presented during installation and/or first boot of the installed system.
  • A system installed with a release-blocking desktop must boot to a log in screen where it is possible to log in to a working desktop using a user account created during installation or a 'first boot' utility.
  • A system installed without a graphical package set must boot to a state where it is possible to log in through at least one of the default virtual consoles.
  • If a utility for creating user accounts and other configuration is configured to launch, it must be visible within 10 seconds of the first boot reaching the launch point.
Encrypted partitions

In all of the above cases, if any system partitions were encrypted as part of the installation, the boot process must prompt for the passphrase(s) and correctly unlock the partition(s) when provided with the correct passphrase(s).

User intervention

In all of the above cases, the boot should proceed without any unexpected user intervention being required. On a graphical install, if the user explicitly intervenes to prevent graphical boot by passing a bootloader parameter, the non-graphical requirement comes into effect.

System-specific bugs

System-specific bugs don't necessarily constitute an infringement of this criterion - for instance, if the system fails to boot because of a bug in the support some specific system's hardware, that is unlikely to constitute a violation unless the system is an extremely popular one. See Blocker_Bug_FAQ for more discussion of this.

Use for severe issues in applying updates

These criteria can be used to cover known severe issues in applying post-release updates. For instance, if there was a bug that meant the system would install and boot fine but would break as soon as the user ran 'yum update', that may well be covered by these criteria.

First boot utilities

On the first boot after installation, a utility for creating user accounts and other configuration may (may, not must) run prior to a log in screen appearing.

References

System service manipulation

The default system init daemon (e.g. systemd) must be capable of starting, stopping, enabling and disabling correctly-defined services.

"Correctly-defined services"

This criterion is not intended to require there are no broken services in the distribution, but that the init daemon itself works. The criterion is not violated by a buggy service script, only if the init daemon itself is broken. A sufficiently-important service being broken might constitute a violation of another criterion - for instance, a service for a logging daemon being broken might violate the requirement that logging works - but not this one.

References

Installing, removing and updating software

The installed system must be able appropriately to install, remove, and update software with the default console tool for the relevant software type (e.g. default console package manager). This includes downloading of packages to be installed/updated.

Software types

This includes - but is not necessarily limited to - non-module packages, official module streams that are enabled (including any enabled by default in a release-blocking deployment), and rpm-ostree updates and rollbacks for any release-blocking rpm-ostree-based deployment. The criterion should also be reasonably interpreted to cover any other form of software distribution that we invent in future and include in an otherwise release-blocking deployment of Fedora, but have not yet updated this text to specifically refer to.

'Appropriately'?

Appropriately means that the relevant software mechanism(s) for any given deployment must choose the software to be installed, updated or removed in ways that are broadly in line with the user's intent and typical expectations, and the project's intent as to which software should be provided from which repositories etc. To give a specific example of why this wording is included, there was previously a case where newer package versions from modules were being installed as 'updates' to systems which did not have those modules installed, only the package with the same name from the non-modular system repositories. This would be an example of 'inappropriate' updating that violated this criterion. Other examples might include installing packages from the wrong module stream, or failing to include available updates from an enabled official repository.

Bugs in particular packages (etc.)

A bug in some particular package will not usually constitute a violation of this criterion. It's really about the mechanism functioning correctly. So if the default console package manager is working fine, but the update transaction fails because there happen to be two conflicting packages in the repositories, that's not a release blocking problem.

New kernels not default (and similar cases)

On the other hand, it is established by precedent - e.g. RHBZ #1261569 - that a bug which prevents newly-installed kernels from becoming the default boot choice is considered to violate this criterion, especially if that bug itself cannot be satisfactorily fixed with an update. Similar cases - where a media/installer bug prevents a package update from behaving as intended, and the consequences are significant - may well also constitute violations.

Scope

This criterion applies only to Fedora-provided and controlled update mechanisms for Fedora-provided content. It should not be interpreted to cover any other 'mechanisms' which may be included in the distribution (e.g. if an application includes a plugin system and an install/remove/update mechanism for those plugins, that mechanism is not covered here).

References

System logging

A system logging infrastructure must be available, enabled by default, and working.

What do you mean, 'working'?

Well, it must provide at least basic local file-based logging of kernel messages, and allow other components to write log messages. This must be done in accordance with relevant standards accepted by the Fedora Project.

References

SELinux configuration

Unless explicitly specified otherwise, after system installation SELinux must be enabled and in enforcing mode.

References

Shutdown

It must be possible to trigger a clean system shutdown using standard console commands.

What do you mean, 'clean'?

The system must shut down in such a way that storage volumes (e.g. simple partitions, LVs and PVs, RAID arrays) are taken offline safely and the system's BIOS or EFI is correctly requested to power down the system.

References

Self-identification

Any component which prominently identifies a Fedora release version number, code name, milestone (Beta, Final), or Edition (Workstation, Server, Atomic) must do so correctly.

References

Required applications

It must be possible to run the default web browser and a terminal application from all release-blocking desktop environments.

Web browser requirements

The web browser must be able to download files, load extensions (if applicable), and log into FAS.

References

Desktop background

The default desktop background must be different from that of the last two stable releases.

References

Server Edition requirements

These requirements apply only to the Server edition.

FreeIPA server requirements

It must be possible to configure a Fedora Server system installed according to the above criteria as a FreeIPA domain controller, using the official deployment tools provided in the distribution FreeIPA packages. Once deployed, the system must handle multiple client enrolments and unenrolments, and client authentication via Kerberos. The web UI must be available and allow at least basic configuration of user accounts and permissions. Prior to Beta, it is acceptable if moderate workarounds are necessary to allow the above.

Moderate workarounds?

For instance, if a service needs to be manually enabled or a configuration file minimally tweaked, this is acceptable.

References

PostgreSQL server requirements

It must be possible to configure a Fedora Server system installed according to the above criteria as a postgresql database server, using the official deployment tools provided in the distribution postgresql packages. Once deployed, the system must serve requests from the local system on port 5432. The core command line utilities for PostgreSQL must be available and correctly handle basic configuration of the PostgreSQL instance itself, and basic SQL interactions, including creation, modification, deletion, and simple querying of users, tables, columns, and rows. Multiple clients must be able to connect simultaneously to the PostgreSQL instance. Prior to Beta, it is acceptable if moderate workarounds are necessary to allow the above.

Moderate workarounds?

For instance, if a service needs to be manually enabled or a configuration file minimally tweaked, this is acceptable.

References

Remote authentication

It must be possible to join the system to a FreeIPA or Active Directory domain at install time and post-install, and the system must respect the identity, authentication and access control configuration provided by the domain.

Non-interactive only OK

The install-time capability is not required to be interactive (i.e. it is acceptable for it to be possible by kickstart only).

No local account requirement

This criterion is understood to mandate that there must be no requirement for a local user account to be created during install or first boot of a Server system.

References

Firewall configuration

After system installation without explicit firewall configuration, the system firewall must be active on all non-loopback interfaces. The only ports which may be open to incoming traffic are port 22 (ssh) and port 9090 (Cockpit web interface). Supported install-time firewall configuration options must work correctly.

Install time configuration

To explain the last part of this criterion - it is possible to include firewall configuration options in a kickstart-driven installation, and the criterion requires that those options work as expected. The options considered to be 'supported' are those documented at Anaconda/Kickstart#firewall.

References

Cockpit management interface

Unless explicitly specified otherwise, after system installation the Cockpit web management interface must be running and accessible on its default port (9090).

References

IoT Edition requirements

These requirements apply only to the IoT Edition.

Zezere user provisioning

The zezere-ignition service must run on all IoT images and allow users to provision a user key for a privileged user (administrator) account.

References

rpm-ostree requirements

  • When a new ostree is composed and made available, it must be possible to upgrade an existing host using the rpm-ostree upgrade command.
  • After upgrading to the latest ostree, it must be possible to rollback to an older version using the rpm-ostree rollback command.
  • It must be possible to rebase to a different IoT release by using the rpm-ostree rebase command.
  • It must be possible to install additional software with the rpm-ostree install command. Software installation must also include dependencies where necessary and installed software should provide the intended functionality.
References

Confirming Basic Requirements

For nightly composes, compliance with these criteria is enforced via automated testing: composes which fail the automated test suite are not released to mirrors. For milestone candidate composes, QA has the responsibility of determining whether the criteria for the release has been met (as outlined above) through discussion with Development and Release Engineering. QA's findings will be reviewed and discussed at the Go/No-Go Meeting.

Related Pages

Retrieved from "https://fedoraproject.org/w/index.php?title=User:Adamwill/Draft_CoreOS_Basic_Release_Criteria&oldid=655235"