openstack/neutron
Code Issues Proposed changes

[ovn]: port forwarding -- move documentation to better place

Browse Source 
Move port_forwarding.rst to doc/source/contributor/internals/ovn
Also, keep lines from the document no longer than 80 chars.

Change-Id: I2887eb022b268763193f93a68a32a4a0deaad42b
This commit is contained in:
Flavio Fernandes 2020-09-03 19:05:36 -04:00
parent 5dccd1f12d
commit 0c6ea20ba5
3 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/contributor/internals/ovn/index.rst
View File

@ -15,3 +15,4 @@ OVN Design Notes
loadbalancer loadbalancer
distributed_ovsdb_events distributed_ovsdb_events
l3_ha_rescheduling l3_ha_rescheduling
port_forwarding

23
doc/source/ovn/port_forwarding.rst → doc/source/contributor/internals/ovn/port_forwarding.rst
View File

@ -67,22 +67,23 @@ LB entry. See the diagram below for an example of how that looks like:
| +-----------------+ | | BB TCP | | +-----------------+ | | BB TCP |
+---------------------+ +-------------------+ +---------------------+ +-------------------+
The OVN LB entries have names that include the id of the FIP and a protocol suffix. The OVN LB entries have names that include the id of the FIP and a protocol
That protocol portion is needed because a single FIP can have multiple UDP and TCP port suffix. That protocol portion is needed because a single FIP can have multiple
forwarding entries while a given LB entry can either be one or the other protocol (not both). UDP and TCP port forwarding entries while a given LB entry can either be one
Based on that, the format used to specify an LB entry is: or the other protocol (not both). Based on that, the format used to specify an
LB entry is:
.. code-block:: ini .. code-block:: ini
pf-floatingip-<NEUTRON_FIP_ID>-<PROTOCOL> pf-floatingip-<NEUTRON_FIP_ID>-<PROTOCOL>
A revision value is present in external_ids of each OVN load balancer entry. A revision value is present in external_ids of each OVN load balancer entry.
That number is synchronized with floating IP entries (NOT the port forwarding!) of the Neutron That number is synchronized with floating IP entries (NOT the port
database. forwarding!) of the Neutron database.
In order to differentiate a load balancer entry that was created by port forwarding In order to differentiate a load balancer entry that was created by port
vs load balancer entries maintained by ovn-octavia-provider, the external_ids field also forwarding vs load balancer entries maintained by ovn-octavia-provider, the
has an owner value: external_ids field also has an owner value:
.. code-block:: python .. code-block:: python
@ -93,8 +94,8 @@ has an owner value:
neutron:revision_number: fip_obj.revision_number, neutron:revision_number: fip_obj.revision_number,
} }
The following registry (API) neutron events trigger the OVN backend to map port forwarding The following registry (API) neutron events trigger the OVN backend to map port
into LB: forwarding into LB:
.. code-block:: python .. code-block:: python

1
doc/source/ovn/index.rst
View File

@ -9,7 +9,6 @@ OVN Driver
:maxdepth: 1 :maxdepth: 1
migration.rst migration.rst
port_forwarding.rst
gaps.rst gaps.rst
dhcp_opts.rst dhcp_opts.rst
faq/index.rst faq/index.rst