ironic/releasenotes/notes/port-physical-network-a7009dc514353796.yaml
Mark Goddard 02fff930fb Expose ports' physical network attribute in API
In change Ib22753aa6ae0fedce7fb9ecf63f135fda0185c5b the port data model
was updated to include a physical_network field, but this was not
exposed to the user by the REST API. This change exposes the
physical_network field in the REST API.

The port CRUD notification object has been updated to include the
physical_network field.

The API reference and user guide have been updated to include
information about the ports' physical network field.

The API microversion has been bumped to 1.34. During a rolling upgrade
from Ocata when the API service is pinned, the port physical network
field is hidden from API responses, and API requests including the field
are rejected.

Change-Id: I7023a1d6618608c867c31396fa677d3016ca493e
Partial-Bug: #1666009
2017-07-19 17:29:20 +01:00

35 lines
1.6 KiB
YAML

---
features:
- |
Adds a ``physical_network`` field to the port object in REST API version
1.34.
This field specifies the name of the physical network to which the port is
connected, and is empty by default. This field may be set by the operator
to allow the Bare Metal service to incorporate physical network information
when attaching virtual interfaces (VIFs).
The REST API endpoints related to ports provide support for the
``physical_network`` field. The `ironic developer documentation
<https://docs.openstack.org/ironic/latest/admin/multitenancy.html>`_
provides information on how to configure and use physical networks.
upgrade:
- |
Adds a ``physical_network`` field to the port object in REST API version
1.34.
This field specifies the name of the physical network to which the port is
connected, and is empty by default. This field may be set by the operator
to allow the Bare Metal service to incorporate physical network information
when attaching virtual interfaces (VIFs).
The REST API endpoints related to ports provide support for the
``physical_network`` field. The `ironic developer documentation
<https://docs.openstack.org/ironic/latest/admin/multitenancy.html>`_
provides information on how to configure and use physical networks.
Following an upgrade to this release, all ports will have an empty
``physical_network`` field. Attachment of Virtual Interfaces (VIFs) will
continue to function as in the previous release until any ports have their
physical network field set.