From Fedora Project Wiki
(Created page with "= Enable Consistent Device Naming in Cloud Images = {{Change_Proposal_Banner}} == Summary == <!-- 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 == <!-- For change proposals to qualify as self-cont...")
 
(adding tracker bug)
(20 intermediate revisions by 2 users not shown)
Line 1: Line 1:
= Enable Consistent Device Naming in Cloud Images =
= Enable Consistent Device Naming in Cloud Images =


{{Change_Proposal_Banner}}
 


== Summary ==
== Summary ==
<!-- 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?". -->
 
This proposal aims to remove the `net.ifnames=0` kernel command line entry from the Fedora cloud kickstarts so that consistent device naming is enabled for cloud instances. This change brings Fedora Cloud in line with Fedora Server, Workstation, and CoreOS.


== Owner ==
== Owner ==
Line 11: Line 12:
This should link to your home wiki page so we know who you are.  
This should link to your home wiki page so we know who you are.  
-->
-->
* Name: [[User:FASAcountName| Your Name]]
* Name: [[User:mhayden|Major Hayden]]
<!-- 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. -->
<!-- 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>
* Email: major@redhat.com
<!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo)
<!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo)
* FESCo shepherd: [[User:FASAccountName| Shehperd name]] <email address>
* FESCo shepherd: [[User:FASAccountName| Shehperd name]] <email address>
-->
-->


== Current status ==
== Current status ==
[[Category:ChangePageIncomplete]]
[[Category:ChangeAcceptedF41]]
<!-- When your change proposal page is completed and ready for review and announcement -->
<!-- When your change proposal page is completed and ready for review and announcement -->
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
Line 30: Line 30:
<!-- [[Category:SystemWideChange]] -->
<!-- [[Category:SystemWideChange]] -->


* Targeted release: [https://docs.fedoraproject.org/en-US/releases/f<VERSION>/ Fedora Linux <VERSION>]
* Targeted release: [https://docs.fedoraproject.org/en-US/releases/f41/ Fedora Linux 41]
* Last updated: <!-- this is an automatic macro — you don't need to change this line -->  {{REVISIONYEAR}}-{{REVISIONMONTH}}-{{REVISIONDAY2}}  
* Last updated: <!-- this is an automatic macro — you don't need to change this line -->  {{REVISIONYEAR}}-{{REVISIONMONTH}}-{{REVISIONDAY2}}  
<!-- After the change proposal is accepted by FESCo, tracking bug is created in Bugzilla and linked to this page  
<!-- After the change proposal is accepted by FESCo, tracking bug is created in Bugzilla and linked to this page  
Line 38: Line 38:
ON_QA -> change is fully code complete
ON_QA -> change is fully code complete
-->
-->
* [<will be assigned by the Wrangler> devel thread]
* [https://lists.fedoraproject.org/archives/list/devel-announce@lists.fedoraproject.org/thread/O7LYRLS6XDQ7FSACTJE4F56PYHQ43S7W/ Announced]
* FESCo issue: <will be assigned by the Wrangler>
* [https://discussion.fedoraproject.org/t/f41-change-proposal-enable-consistent-device-naming-in-cloud-images-self-contained/108894 Discussion Thread]
* Tracker bug: <will be assigned by the Wrangler>
* FESCo issue: [https://pagure.io/fesco/issue/3190 #3190]
* Tracker bug: [https://bugzilla.redhat.com/show_bug.cgi?id=2274818 #2274818]
* Release notes tracker: <will be assigned by the Wrangler>
* Release notes tracker: <will be assigned by the Wrangler>


== Detailed Description ==
== 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. -->
 
Fedora cloud images currently set `net.ifnames=0` on the kernel command line during the [https://pagure.io/fedora-kickstarts/blob/main/f/fedora-cloud-base.ks#_35 kickstart] process. This disables consistent device naming and ensures that ethernet devices retain the old-style names of `eth0`, `eth1`, `eth2`, and so on.
 
Removing the `net.ifnames=0` configuration allows Fedora cloud instances to use consistent device names for network devices. This brings Cloud images in line with Fedora Server, Workstation, and CoreOS.


== Feedback ==
== 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. -->
<!-- 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. -->
One of the proposed alternatives is to leave `net.ifnames=0` in the kernel command line to remain consistent between releases. Although RHEL allows for `net.ifnames=0` for KVM instances, it is [https://access.redhat.com/solutions/2435891|strongly recommended not to use it] with OpenStack or RHV environments. Fedora Cloud images are used for multiple types of clouds, including public clouds and private clouds.
This approach is less disruptive, but it pushes off the consistent device naming change until a later date and causes cloud images to operate differently than other Fedora deployments.
Other distributions have taken different turns with this configuration. [https://lists.ubuntu.com/archives/ubuntu-devel/2016-April/039325.html| Ubuntu] removed it in 2016, Debian [https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=863385| added it back in 2017], and [https://documentation.suse.com/sles/15-SP4/pdf/article-minimal-vm_en.pdf| SUSE has had it] for some time. There were issues with cloud-init during the early days of network device naming in 2016/2017, but [https://github.com/canonical/cloud-init/blob/d8e3a4b4d4ca443227bf06bdaa5d9b47bd84e326/cloudinit/net/__init__.py#L480-L491| cloud-init supports consistent network names] since 2017. RHEL currently uses `net.ifnames=0`, but there is a debate about whether it should be removed in a future major release.


== Benefit to Fedora ==
== 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.
The main benefit comes from bringing cloud instances inline with other deployment types in how they name network devices. It also helps with cloud providers that offer up different types of network interfaces to an instance. For example, an emulated network device would present itself differently than one offered via SRIOV and it would allow an instance administrator to easily tell which network interface corresponds to each network device. This is especially important for certain clouds, such as OpenStack clouds.
 
    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 ==
== Scope ==
Line 99: Line 84:


== Upgrade/compatibility impact ==
== 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? -->


<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
'''Upgrades:''' Users who are upgrading to the next Fedora release will not notice a change in their instances since the `net.ifnames=0` change is only applied during the kickstart process. Their instances will continue using the old network names.


'''New deployments:''' If a user has older Fedora deployments and they deploy a new Fedora release with this change applied, their network devices will use consistent network names instead of the old `eth0` and `eth1` style names. Although this won't impact software like cloud-init, it will impact users who have deployment scripts (Terraform or Ansible, for example) that need to set network configuration based on the network adapter's name. They will need to adjust the name of the network device in their deployment scripts.


== How To Test ==
== 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.
Use an image built without `net.ifnames=0` or take an existing cloud instance and remove `net.ifnames=0` from the kernel command line:


A good "how to test" should answer these four questions:
    grubby --update-kernel=current_kernel --remove-args="kernel_args"


0. What special hardware / data / etc. is needed (if any)?
After a reboot, the device names should change from `eth0` to reflect the consistent device names based on the hardware:
1. How do I prepare my system to test this change? What packages
need to be installed, config files edited, etc.?
2. What specific actions do I perform to check that the change is
working like it's supposed to?
3. What are the expected results of those actions?
-->


<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
    $ ip link | grep ^[0-9]
    1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN mode DEFAULT group default qlen 1000
    2: enp2s0f0: <NO-CARRIER,BROADCAST,MULTICAST,UP> mtu 1500 qdisc mq state DOWN mode DEFAULT group default qlen 1000
    3: eno1: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc fq_codel state UP mode DEFAULT group default qlen 1000
    4: enp2s0f1: <NO-CARRIER,BROADCAST,MULTICAST,UP> mtu 1500 qdisc mq state DOWN mode DEFAULT group default qlen 1000


== User Experience ==


== User Experience ==
Users who don't need to apply any specialized network configuration will likely not notice a change. All of the cloud-init functionality will work the same as it did previously.
<!-- If this change proposal is noticeable by users, how will their experiences change as a result?
 
For users who need to apply specific network configuration on specific instances will need to change the name they use to refer to those network interfaces. For example, the main network device may shift from `eth0` to `ens3` on some KVM platforms. Other cloud instances might show a network device that specifies a PCI bus entry, such as `enp2s0f0`. Although this might be confusing at first glance, it will be familiar to users of Fedora Workstation, Server, and CoreOS.


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.
Users could opt out by adding `net.ifnames=0` back to their kernel command line:


Describe what Users will see or notice, for example:
    grubby --update-kernel=ALL --args="net.ifnames=0"
  - 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 ==
== 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 -->
This change does not depend on any other changes and it has no impact on cloud-specific dependencies, such as cloud-init.


If users have custom setup scripts that apply network configuration, or if they use Terraform/Ansible to perform these steps, they may need to adjust their scripts to account for the new network names.


== Contingency Plan ==
== Contingency Plan ==

Revision as of 23:42, 12 April 2024

Enable Consistent Device Naming in Cloud Images

Summary

This proposal aims to remove the net.ifnames=0 kernel command line entry from the Fedora cloud kickstarts so that consistent device naming is enabled for cloud instances. This change brings Fedora Cloud in line with Fedora Server, Workstation, and CoreOS.

Owner

Current status

Detailed Description

Fedora cloud images currently set net.ifnames=0 on the kernel command line during the kickstart process. This disables consistent device naming and ensures that ethernet devices retain the old-style names of eth0, eth1, eth2, and so on.

Removing the net.ifnames=0 configuration allows Fedora cloud instances to use consistent device names for network devices. This brings Cloud images in line with Fedora Server, Workstation, and CoreOS.

Feedback

One of the proposed alternatives is to leave net.ifnames=0 in the kernel command line to remain consistent between releases. Although RHEL allows for net.ifnames=0 for KVM instances, it is recommended not to use it with OpenStack or RHV environments. Fedora Cloud images are used for multiple types of clouds, including public clouds and private clouds.

This approach is less disruptive, but it pushes off the consistent device naming change until a later date and causes cloud images to operate differently than other Fedora deployments.

Other distributions have taken different turns with this configuration. Ubuntu removed it in 2016, Debian added it back in 2017, and SUSE has had it for some time. There were issues with cloud-init during the early days of network device naming in 2016/2017, but cloud-init supports consistent network names since 2017. RHEL currently uses net.ifnames=0, but there is a debate about whether it should be removed in a future major release.

Benefit to Fedora

The main benefit comes from bringing cloud instances inline with other deployment types in how they name network devices. It also helps with cloud providers that offer up different types of network interfaces to an instance. For example, an emulated network device would present itself differently than one offered via SRIOV and it would allow an instance administrator to easily tell which network interface corresponds to each network device. This is especially important for certain clouds, such as OpenStack clouds.

Scope

  • Proposal owners:
  • Other developers:
  • Policies and guidelines: N/A (not needed for this Change)
  • Trademark approval: N/A (not needed for this Change)
  • Alignment with Community Initiatives:

Upgrade/compatibility impact

Upgrades: Users who are upgrading to the next Fedora release will not notice a change in their instances since the net.ifnames=0 change is only applied during the kickstart process. Their instances will continue using the old network names.

New deployments: If a user has older Fedora deployments and they deploy a new Fedora release with this change applied, their network devices will use consistent network names instead of the old eth0 and eth1 style names. Although this won't impact software like cloud-init, it will impact users who have deployment scripts (Terraform or Ansible, for example) that need to set network configuration based on the network adapter's name. They will need to adjust the name of the network device in their deployment scripts.

How To Test

Use an image built without net.ifnames=0 or take an existing cloud instance and remove net.ifnames=0 from the kernel command line:

   grubby --update-kernel=current_kernel --remove-args="kernel_args"

After a reboot, the device names should change from eth0 to reflect the consistent device names based on the hardware:

   $ ip link | grep ^[0-9]
   1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN mode DEFAULT group default qlen 1000
   2: enp2s0f0: <NO-CARRIER,BROADCAST,MULTICAST,UP> mtu 1500 qdisc mq state DOWN mode DEFAULT group default qlen 1000
   3: eno1: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc fq_codel state UP mode DEFAULT group default qlen 1000
   4: enp2s0f1: <NO-CARRIER,BROADCAST,MULTICAST,UP> mtu 1500 qdisc mq state DOWN mode DEFAULT group default qlen 1000

User Experience

Users who don't need to apply any specialized network configuration will likely not notice a change. All of the cloud-init functionality will work the same as it did previously.

For users who need to apply specific network configuration on specific instances will need to change the name they use to refer to those network interfaces. For example, the main network device may shift from eth0 to ens3 on some KVM platforms. Other cloud instances might show a network device that specifies a PCI bus entry, such as enp2s0f0. Although this might be confusing at first glance, it will be familiar to users of Fedora Workstation, Server, and CoreOS.

Users could opt out by adding net.ifnames=0 back to their kernel command line:

   grubby --update-kernel=ALL --args="net.ifnames=0"

Dependencies

This change does not depend on any other changes and it has no impact on cloud-specific dependencies, such as cloud-init.

If users have custom setup scripts that apply network configuration, or if they use Terraform/Ansible to perform these steps, they may need to adjust their scripts to account for the new network names.

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