openstack/ironic
Code Issues Proposed changes

docs: Clarify physical_network should be a name

Browse Source 
Clarify physical_network should be a name matching Neutron configuration

Change-Id: I4ed4e9bd02b8ea103dc3602ece590f50f4e829f6
This commit is contained in:
cid 2025-03-26 12:30:48 +01:00
parent 5f911ad688
commit b939c24faa
1 changed files with 5 additions and 1 deletions

6
doc/source/admin/networking.rst

@ -204,9 +204,13 @@ Physical networks
An Ironic port may be associated with a physical network using its
``physical_network`` field. Ironic uses this information when
mapping between virtual ports in Neutron and physical ports and
port groups. A port's physical network field is optional, and if not
port groups. A port's physical network field is optional, and if not
set then any VIF may be mapped to that port, provided that no free
Ironic port with a suitable physical network assignment exists.
When set, its value must be a name that corresponds to a physical network
in Neutron for the networking-baremetal integration to properly reconcile
the port. This has to be a name (not a UUID) since physical networks are
configured in Neutron by name.
The physical network of a port group is defined by the physical network of its
constituent ports. The Ironic service ensures that all ports in a port