Latest revision as of 12:00, 21 June 2024

Anaconda as native Wayland application

Summary

Currently, Anaconda is still an X11 application, which we would like to fix and make Anaconda Wayland native application to allow us drop of the X11 dependencies from installation ISO images. However, this change is not just a simple switch and we need to do some adjustments during the path which will impact user experience.

Owner

Name: Anaconda team ( Jiří Konečný)
Email: jkonecny@redhat.com

Current status

[[Category:ChangeAcceptedF41]

Targeted release: Fedora Linux 41
Last updated: 2024-06-21
Announced
Discussion thread
FESCo issue: #3219
Tracker bug: #2231339
Release notes tracker: <will be assigned by the Wrangler>

Detailed Description

Anaconda is required to migrate to Wayland native application to drop dependencies from the installation ISO images which are deprecated. Package owners want to drop libXklavier from Fedora (see https://bugzilla.redhat.com/show_bug.cgi?id=1955025 ) but also Xorg server from CentOS Stream and RHEL. However, this change won’t be just simple switching from X11 to Wayland, we also need to change a few things in Anaconda to be able to remove the X11 dependencies. This will have two main visible impacts listed below.

VNC switch to RDP for remote GUI installations

Anaconda has to remove ‘TigerVNC' which is used for VNC connection to be able to install your machine remotely with graphical UI. Reason is that TigerVNC is built from the Xorg server sources, so we would still depend on the Xorg server with this project. As replacement, we follow the recommendation of the Fedora Workstation to switch to Gnome Remote Desktop (grd) with a better protocol Remote Desktop Protocol (RDP) which gives users better performance and security.

This will have an impact on current vnc kickstart commands and kernel boot options of Anaconda. This will impact only the Anaconda installation environment (boot.iso).

Consistent keyboard control

Currently, Anaconda experiences difficulties in handling keyboard layouts in the installation environment, particularly on Wayland. Formerly, libXklavier was utilized by Anaconda to manage keyboard layout configuration, however, it proved unstable on Wayland. As a result, Anaconda has disabled keyboard handling during Wayland Live media installations due to unexpected behavior (refer to https://bugzilla.redhat.com/show_bug.cgi?id=2016613 ). This approach may lead to situations when users encountering issues while unlocking LUKS devices or using user passwords in the installed system because installation was done with a different keyboard layout.

To exacerbate the situation, there is no universally applicable solution for keyboard handling on Wayland systems, as Wayland lacks a unified API for keyboard management. It means that each Fedora Desktop Environment developed their own API. Unfortunately, the Anaconda team is not able to maintain a custom solution for each Fedora spin. Some Desktop environments started to use systemd-localed DBus API to address this issue and similar issues. The systemd-localed API seems to be the best approach currently, so we want to promote it as a shared solution for all Fedora spins.

The plan is:

All Fedora spins and Anaconda listen on org.freedesktop.locale1 and reflect configuration on the currently running system (might be only for Live media if desired)
All Fedora spins and Anaconda reflect their configuration to org.freedesktop.locale1
In case Fedora spin will not support org.freedesktop.locale1, the keyboard configuration of Anaconda won’t be reflected in the current system and the situation will be similar to the current Live Wayland experience

All the spin owners were notified about this request:

Feedback

We have some feedback from the SIG owners for the keyboard handling (see the links above). We don’t have feedback for the VNC to RDP switch yet.

Benefit to Fedora

This change will enable removal of X11 dependencies from the Anaconda which may result in reduction of installed software to the system when installing from Live ISO where ISO content is copied to the installed system (depends on the spin dependencies).
Switching from VNC to RDP allow users to use remote graphical installations which are more secure and have better performance .

Scope

Impact to the environments:
- boot.iso (network installation): This environment will switch from Gnome Kiosk running as X11 to Wayland environment. Work here should be handled by the Anaconda team.
- Live ISO (Fedora Workstation and non-rpmostree spins): Anaconda will run as an application in the Live spins environment in the same way as before. The Anaconda team will not modify the Live environment managed by the spin owners. However, spin owners should support systemd-localed as explained above to enable Anaconda to control system keyboard layouts.
- Installed systems: No impact.

Proposal owners: The Anaconda team will implement changes required in the Anaconda project. More specifically:
- Switch Anaconda code to start Wayland environment on boot.iso instead of X11
- Change keyboard switching logic to use systemd-localed DBus instead of libXklavier
- Switch remote graphical installations from VNC (TigerVNC) to RDP (GRD)

Other developers: Fedora SIG owners needs to add support for their environment to listen and use systemd-localed DBus API to reflect current state of the DE/WM or they won’t have support of keyboard layout switching in Anaconda.

Release engineering: #12138

Policies and guidelines: Yes should be done after the implementation (https://docs.fedoraproject.org/en-US/fedora-server/installation/interactive-remote should switch to RDP)

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

Alignment with the Fedora Strategy:

Upgrade/compatibility impact

This will impact only Fedora installations so no compatibility or upgrade issues.

Early Testing (Optional)

We will reach Fedora QE to coordinate testing approach.

How To Test

Download any installation media
Run the installation
Look for breakages during the installation

Testing should be especially focused on:

Changing resolution with inst.resolution kernel boot option
Test new RDP solution (API will be clarified)
- Password can be set to the RDP
- Username can be set to the RDP
Test keyboard layout switching works correctly
- On Live media, Anaconda should react on keyboard layout change in the DE and set that to the installed system
- On Live media, Anaconda should be able to set the keyboard layout changes to the live environment
- In the network installation (boot.iso) Anaconda should correctly reflect keyboard layouts changes so text in the Anaconda is written by the correct layout
- Check if specific keyboard layouts are configured and installed as expected

User Experience

The only visible change to user should be:

Remote graphical installations will use RDP instead of VNC.
Anaconda will be able to control keyboard layouts in the Wayland environment on Live ISOs. This will improve user experience when installing Fedora Workstation, Fedora KDE, Fedora Sway and other Wayland based environments.

Dependencies

No dependencies of this package related to this change.

Contingency Plan

Contingency mechanism: Postpone this change to next Fedora release. Revert landed changes in Anaconda if required.
Contingency deadline: 100% code completion deadline
Blocks release? No

Documentation

No documentation yet. However, there are a few PRs ready for merge for CentOS Stream 10:

Release Notes

TBD

@@ Line 1: / Line 1: @@
 <!-- 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 -->
-= Wayland native Anaconda <!-- The name of your change proposal --> =
+= Anaconda as native Wayland application <!-- The name of your change proposal --> =
-{{Change_Proposal_Banner}}
 == Summary ==
@@ Line 24: / Line 23: @@
 == Current status ==
-[[Category:ChangePageIncomplete]]
+[[Category:ChangeAcceptedF41]
 <!-- When your change proposal page is completed and ready for review and announcement -->
 <!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
@@ Line 42: / Line 41: @@
 ON_QA -> change is fully code complete
 -->
-* [Announced]
+* [https://lists.fedoraproject.org/archives/list/devel-announce@lists.fedoraproject.org/thread/L3GXMWJXUHAMOJJCJAD3QZSNXIXPR2HP/ Announced]
-* [<will be assigned by the Wrangler> Discussion thread]
+* [https://discussion.fedoraproject.org/t/f41-change-proposal-anaconda-as-native-wayland-application-system-wide/118550 Discussion thread]
-* FESCo issue: <will be assigned by the Wrangler>
+* FESCo issue: [https://pagure.io/fesco/issue/3219 #3219]
-* Tracker bug: <will be assigned by the Wrangler>
+* Tracker bug: [https://bugzilla.redhat.com/show_bug.cgi?id=2231339 #2231339]
 * Release notes tracker: <will be assigned by the Wrangler>
@@ Line 61: / Line 60: @@
 Currently, Anaconda experiences difficulties in handling keyboard layouts in the installation environment, particularly on Wayland. Formerly, libXklavier was utilized by Anaconda to manage keyboard layout configuration, however, it proved unstable on Wayland. As a result, Anaconda has disabled keyboard handling during Wayland Live media installations due to unexpected behavior (refer to https://bugzilla.redhat.com/show_bug.cgi?id=2016613 ). This approach may lead to situations when users encountering issues while unlocking LUKS devices or using user passwords in the installed system because installation was done with a different keyboard layout.
-To exacerbate the situation, there is no universally applicable solution for keyboard handling on Wayland systems, as Wayland lacks a unified API for keyboard management. It means that each Fedora Desktop Environment developed their own solution. Unfortunately, the Anaconda team is not able to maintain a custom solution for each Fedora spin. Some Desktop environments started to use '''systemd-localed''' DBus API to address this issue and similar issues. This seems to be the best approach currently, so we promote it as a shared solution for all Fedora spins.
+To exacerbate the situation, there is no universally applicable solution for keyboard handling on Wayland systems, as Wayland lacks a unified API for keyboard management. It means that each Fedora Desktop Environment developed their own API. Unfortunately, the Anaconda team is not able to maintain a custom solution for each Fedora spin. Some Desktop environments started to use '''systemd-localed''' DBus API to address this issue and similar issues. The systemd-localed API seems to be the best approach currently, so we want to promote it as a shared solution for all Fedora spins.
 The plan is:
-All Fedora spins and Anaconda are required to listen on '''org.freedesktop.locale1''' and reflect configuration on the currently running system (might be only for Live media if desired)
+* All Fedora spins and Anaconda listen on '''org.freedesktop.locale1''' and reflect configuration on the currently running system (might be only for Live media if desired)
-All Fedora spins and Anaconda are required to reflect their configuration to org.freedesktop.locale1
+* All Fedora spins and Anaconda reflect their configuration to org.freedesktop.locale1
-In case Fedora spin will not support '''org.freedesktop.locale1''', the keyboard configuration of Anaconda won’t be reflected in the current system and the situation will be similar to the current Live Wayland experience
+* In case Fedora spin will not support '''org.freedesktop.locale1''', the keyboard configuration of Anaconda won’t be reflected in the current system and the situation will be similar to the current Live Wayland experience
 All the spin owners were notified about this request:
@@ Line 119: / Line 118: @@
 -->
-* This change will enable removal of X11 dependencies from the Anaconda which could result in reduction of installed software to the system when installing from Live ISO where ISO is copied to the installed system.
+* This change will enable removal of X11 dependencies from the Anaconda which may result in reduction of installed software to the system when installing from Live ISO where ISO content is copied to the installed system (depends on the spin dependencies).
-* Switching from VNC to RDP will allow users to use remote graphical installations which have better performance and are more secure.
+* Switching from VNC to RDP allow users to use remote graphical installations which are more secure and have better performance .
 == Scope ==
-* Proposal owners: Anaconda team will implement changes required in the project. More specifically:
+* Impact to the environments:
+** boot.iso (network installation): This environment will switch from Gnome Kiosk running as X11 to Wayland environment. Work here should be handled by the Anaconda team.
+** Live ISO (Fedora Workstation and non-rpmostree spins): Anaconda will run as an application in the Live spins environment in the same way as before. The Anaconda team will not modify the Live environment managed by the spin owners. However, spin owners should support systemd-localed as explained above to enable Anaconda to control system keyboard layouts.
+** Installed systems: No impact.
+* Proposal owners: The Anaconda team will implement changes required in the Anaconda project. More specifically:
 ** Switch Anaconda code to start Wayland environment on boot.iso instead of X11
 ** Change keyboard switching logic to use systemd-localed DBus instead of libXklavier
 ** Switch remote graphical installations from VNC (TigerVNC) to RDP (GRD)
 <!-- 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: Fedora SIG owners needs to add support for their environment to listen and use systemd-localed DBus API to reflect current state of the DE/WM or they won’t have support for keyboard layout switching.
+* Other developers: Fedora SIG owners needs to add support for their environment to listen and use systemd-localed DBus API to reflect current state of the DE/WM or they won’t have support of keyboard layout switching in Anaconda.
 <!-- 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 -->
+* Release engineering: [https://pagure.io/releng/issue/12138 #12138] <!-- 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 -->
@@ Line 157: / Line 159: @@
 <!-- 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*. -->
-The Fedora QE will be involved so we can do correct testing.
+We will reach Fedora QE to coordinate testing approach.
 == How To Test ==
@@ Line 174: / Line 176: @@
 -->
-. Download any installation media
+# Download any installation media
-. Run the installation
+# Run the installation
-. Look for breakages during the installation
+# Look for breakages during the installation
 Testing should be especially focused on:
-* Changing resolution with inst.resolution kernel boot option
+* Changing resolution with ''inst.resolution'' kernel boot option
 * Test new RDP solution (API will be clarified)
 ** Password can be set to the RDP
@@ Line 187: / Line 189: @@
 ** On Live media, Anaconda should be able to set the keyboard layout changes to the live environment
 ** In the network installation (boot.iso) Anaconda should correctly reflect keyboard layouts changes so text in the Anaconda is written by the correct layout
+** Check if specific keyboard layouts are configured and installed as expected
 == User Experience ==

Search

Changes/Anaconda As Native Wayland Application: Difference between revisions