Skip to content

Commit c8af0f1

Browse files
committed
[doc] Document the L3 QoS support in Neutron
The L3 QoS support documentation, in particular the ML2/OVN one, was outdated. This patch documents: * The ML2/OVN L3 QoS support for DSCP marking. * The ML2/OVN rule enforcement and precedence. Closes-Bug: #2116317 Signed-off-by: Rodolfo Alonso Hernandez <[email protected]> Change-Id: I52219523cf958e787fae4d3104fb2638698a28d8 (cherry picked from commit 1ba9f7f)
1 parent c8076da commit c8af0f1

File tree

1 file changed

+66
-7
lines changed

1 file changed

+66
-7
lines changed

doc/source/admin/config-qos.rst

Lines changed: 66 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -137,19 +137,63 @@ Valid DSCP mark values are even numbers between 0 and 56, except 2-6, 42, and
137137
L3 QoS support
138138
~~~~~~~~~~~~~~
139139

140-
The Neutron L3 services have implemented their own QoS extensions. Currently
141-
only bandwidth limit QoS is provided. This is the L3 QoS extension list:
140+
The Neutron L3 services have implemented their own QoS extensions. It is
141+
possible to apply QoS policies to the floating IPs and to the routers; in the
142+
last one (routers), the QoS policy will be applied on the gateway port.
142143

143-
* Floating IP bandwidth limit: the rate limit is applied per floating IP
144-
address independently.
144+
The rule support depends on the ML2 backend used.
145+
146+
147+
ML2/OVS
148+
-------
149+
150+
The ML2/OVS L3 QoS supports only rate limit rules:
151+
152+
* Floating IP bandwidth limit: rate limit is applied per floating IP address
153+
independently.
145154

146155
* Gateway IP bandwidth limit: the rate limit is applied in the router namespace
147156
gateway port (or in the SNAT namespace in case of DVR edge router). The rate
148157
limit applies to the gateway IP; that means all traffic using this gateway IP
149158
will be limited. This rate limit does not apply to the floating IP traffic.
150159

151160

152-
L3 services that provide QoS extensions:
161+
ML2/OVN
162+
-------
163+
164+
The ML2/OVN L3 QoS supports both rate limit and DSCP rules. Both floating IP
165+
and gateway port QoS policies are applied using the QoS metering rules.
166+
167+
* Floating IP: the traffic should match the gateway port and the floating IP
168+
address. The port can be centralized or distributed.
169+
170+
* Gateway port: the traffic should match the gateway chassis port.
171+
172+
173+
Because both floating IP and router can have QoS policies and both QoS policies
174+
will match the same traffic, the floating IP policy has a higher priority and
175+
will match this one only. In case of having port policies, that will apply to
176+
the virtual machine private port, the private port rule will be applied first.
177+
This is the QoS rules precedence and result:
178+
179+
* Rate limit rules: if both private port QoS and router/floating IP rules are
180+
applied, because both will be executed, the minimum rate limit value will
181+
apply.
182+
183+
* DSCP rules: if both private port QoS and router/floating IP rules are
184+
applied, the router/floating IP DSCP mark will be applied on the egress
185+
packet.
186+
187+
188+
.. note::
189+
190+
In case of having both router and floating IP QoS policies, the floating IP
191+
QoS policy has precedence always over the router QoS one. See `[OVN] Change
192+
the OVN QoS rule priority for floating IPs <https://review.opendev.org/q/If01a8783ac998b2a1f1249ab6f555dd1a5148ea8>`_.
193+
194+
195+
L3 services that provide QoS extensions
196+
---------------------------------------
153197

154198
* L3 router: implements the rate limit using `Linux TC
155199
<https://man7.org/linux/man-pages/man8/tc.8.html>`_.
@@ -161,16 +205,31 @@ L3 services that provide QoS extensions:
161205
The following table shows the L3 service, the QoS supported extension, and
162206
traffic directions (from the VM point of view) for **bandwidth limiting**.
163207

164-
.. table:: **L3 service, supported extension, and traffic direction**
208+
.. table:: **L3 service, supported extension and traffic direction for
209+
bandwidth limiting**
165210

166211
==================== =================== ===================
167-
Rule \\ L3 service L3 router OVN L3
212+
L3 service L3 router OVN L3
168213
==================== =================== ===================
169214
Floating IP Egress \\ Ingress Egress \\ Ingress
170215
Gateway IP Egress \\ Ingress Egress \\ Ingress
171216
==================== =================== ===================
172217

173218

219+
The following table shows the L3 service, the QoS supported extension, and
220+
traffic directions (from the VM point of view) for **DSCP marking**.
221+
222+
.. table:: **L3 service, supported extension and traffic direction for
223+
DSCP marking**
224+
225+
==================== =========== ========
226+
L3 service L3 router OVN L3
227+
==================== =========== ========
228+
Floating IP - Egress
229+
Gateway IP - Egress
230+
==================== =========== ========
231+
232+
174233
Configuration
175234
~~~~~~~~~~~~~
176235

0 commit comments

Comments
 (0)