RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.
Bug 2074020 - Add help file to /etc/sysconfig/network-scripts/ to mention /etc/NetworkManager/system-connections/
Summary: Add help file to /etc/sysconfig/network-scripts/ to mention /etc/NetworkManag...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Linux 9
Classification: Red Hat
Component: NetworkManager
Version: 9.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: rc
: ---
Assignee: Ana Cabral
QA Contact: David Jaša
Marc Muehlfeld
URL:
Whiteboard:
: 2074742 (view as bug list)
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2022-04-11 11:52 UTC by Till Maas
Modified: 2022-11-15 12:07 UTC (History)
11 users (show)

Fixed In Version: NetworkManager-1.39.6-1.el9
Doc Type: No Doc Update
Doc Text:
Clone Of:
Environment:
Last Closed: 2022-11-15 10:49:31 UTC
Type: Bug
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Gitlab redhat/centos-stream/rpms NetworkManager merge_requests 38 0 None merged rpm: include an informational file in ifcfg files directory 2022-05-30 11:26:15 UTC
Red Hat Issue Tracker RHELPLAN-118528 0 None None None 2022-04-11 12:06:22 UTC
Red Hat Product Errata RHBA-2022:8265 0 None None None 2022-11-15 10:49:51 UTC
freedesktop.org Gitlab NetworkManager NetworkManager merge_requests 1236 0 None merged rpm: ifcfg change on directory, ifcfg warning message 2022-05-27 18:28:38 UTC

Description Till Maas 2022-04-11 11:52:35 UTC
Description of problem:
In RHEL 9, NM defaults to storing profiles as keyfiles. To reduce confusion for users looking into /etc/sysconfig/network-scripts/ add a README or similar there to mention that profiles might now be stored at /etc/NetworkManager/system-connections/

Acceptance Criteria

Given a RHEL 9+ or Fedora 36+ system
When listing the content of /etc/sysconfig/network-scripts/
Then there will be a hint that network configuration is now in /etc/NetworkManager/system-connections/


TBD:
This could be a README.txt with a text like:


Please check /etc/NetworkManager/system-connections/ for network configuration files. More information is available at https://...  [Do we have a URL that we can use here?]

The file name could also be more explicit, such as

"Note: Network configuration moved other directory.txt"

Comment 1 Fernando F. Mancera 2022-04-11 12:10:02 UTC
(In reply to Till Maas from comment #0)
> Description of problem:
> In RHEL 9, NM defaults to storing profiles as keyfiles. To reduce confusion
> for users looking into /etc/sysconfig/network-scripts/ add a README or
> similar there to mention that profiles might now be stored at
> /etc/NetworkManager/system-connections/
> 
> Acceptance Criteria
> 
> Given a RHEL 9+ or Fedora 36+ system
> When listing the content of /etc/sysconfig/network-scripts/
> Then there will be a hint that network configuration is now in
> /etc/NetworkManager/system-connections/
> 
> 
> TBD:
> This could be a README.txt with a text like:
> 
> 
> Please check /etc/NetworkManager/system-connections/ for network
> configuration files. More information is available at https://...  [Do we
> have a URL that we can use here?]
> 

I think we could add the link for the NetworkManager migration tool blog post.. I assume this blog post will have an explanation about where are the configuration files now.

> The file name could also be more explicit, such as
> 
> "Note: Network configuration moved other directory.txt"

Comment 2 Till Maas 2022-04-13 05:29:11 UTC
*** Bug 2074742 has been marked as a duplicate of this bug. ***

Comment 3 Marc Muehlfeld 2022-05-03 07:45:01 UTC
What do you think about the following text for the README file:

--------------------------------------------------
NetworkManager stores new network profiles in keyfile format in the
/etc/NetworkManager/system-connections/ directory.

Previously, NetworkManager stored network profiles in ifcfg format
in this directory (/etc/sysconfig/network-scripts/). However, the ifcfg
format is deprecated. By default, NetworkManager no longer creates
new profiles in this format.

Connection profiles in keyfile format have many benefits. For example,
this format is INI file-based and can easily be parsed and generated.

Each section in NetworkManager keyfiles corresponds to a NetworkManager
setting name as described in the nm-settings(5) and nm-settings-keyfile(5)
man pages. Each key-value-pair in a section is one of the properties
listed in the settings specification of the man page.

If you still use network profiles in ifcfg format, consider migrating
them to keyfile format. To migrate all profiles at once, enter: 

# nmcli connection migrate

This command migrates all profiles from ifcfg format to keyfile
format and stores them in /etc/NetworkManager/system-connections/.

Alternatively, to migrate only a specific profile, enter:

# nmcli connection migrate <profile_name|UUID|D-Bus_path>

For further details, see:
* nm-settings-keyfile(5)
* nmcli(1)
--------------------------------------------------

This text provides some background information, lists benefits, and mentions the relevant man pages.

If you add the README in 9.0, skip the paragraphs about migration and append them in 9.1.




> The file name could also be more explicit, such as
> "Note: Network configuration moved other directory.txt"

I would not use such a file name. It's too long and it contains spaces, which requires to use quotes or escape the spaces to display the file.
Let's call it simply README - same as the file systemd devels put into /var/log/ to inform about Journal.
(just my opinion)

Comment 4 Ana Cabral 2022-05-27 18:27:11 UTC
(In reply to Marc Muehlfeld from comment #3)
> What do you think about the following text for the README file:
> 
> --------------------------------------------------
> NetworkManager stores new network profiles in keyfile format in the
> /etc/NetworkManager/system-connections/ directory.
> 
> Previously, NetworkManager stored network profiles in ifcfg format
> in this directory (/etc/sysconfig/network-scripts/). However, the ifcfg
> format is deprecated. By default, NetworkManager no longer creates
> new profiles in this format.
> 
> Connection profiles in keyfile format have many benefits. For example,
> this format is INI file-based and can easily be parsed and generated.
> 
> Each section in NetworkManager keyfiles corresponds to a NetworkManager
> setting name as described in the nm-settings(5) and nm-settings-keyfile(5)
> man pages. Each key-value-pair in a section is one of the properties
> listed in the settings specification of the man page.
> 
> If you still use network profiles in ifcfg format, consider migrating
> them to keyfile format. To migrate all profiles at once, enter: 
> 
> # nmcli connection migrate
> 
> This command migrates all profiles from ifcfg format to keyfile
> format and stores them in /etc/NetworkManager/system-connections/.
> 
> Alternatively, to migrate only a specific profile, enter:
> 
> # nmcli connection migrate <profile_name|UUID|D-Bus_path>
> 
> For further details, see:
> * nm-settings-keyfile(5)
> * nmcli(1)
> --------------------------------------------------
> 
> This text provides some background information, lists benefits, and mentions
> the relevant man pages.
> 
> If you add the README in 9.0, skip the paragraphs about migration and append
> them in 9.1.
> 
> 
> 
> 
> > The file name could also be more explicit, such as
> > "Note: Network configuration moved other directory.txt"
> 
> I would not use such a file name. It's too long and it contains spaces,
> which requires to use quotes or escape the spaces to display the file.
> Let's call it simply README - same as the file systemd devels put into
> /var/log/ to inform about Journal.
> (just my opinion)

Thank you very much Marc, I included this text.

Comment 5 Ana Cabral 2022-05-27 18:28:05 UTC
Fedora MR link: https://src.fedoraproject.org/rpms/NetworkManager/pull-request/11

Comment 8 David Jaša 2022-06-20 13:06:24 UTC
The /etc/sysconfig/network-scripts/readme-ifcfg-rh.txt file is present on system with NetworkManager-1.39.6-1.el9 → VERIFIED.

Comment 12 errata-xmlrpc 2022-11-15 10:49:31 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (NetworkManager bug fix and enhancement update), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHBA-2022:8265


Note You need to log in before you can comment on or make changes to this bug.