Bug 1377872 - [DOCS] Fix Bond Options Documentation
Summary: [DOCS] Fix Bond Options Documentation
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat OpenStack
Classification: Red Hat
Component: documentation
Version: 10.0 (Newton)
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: 10.0 (Newton)
Assignee: Martin Lopes
QA Contact: Dan Macpherson
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-09-20 20:59 UTC by Dan Sneddon
Modified: 2020-08-13 08:36 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-11-08 04:37:31 UTC
Target Upstream Version:


Attachments (Terms of Use)

Description Dan Sneddon 2016-09-20 20:59:27 UTC
Description of problem:
The OSP 9 Installation and Usage guide has an appendix for OVS Bonding Options, but it includes an example of "balance-tcp", which should never be used, and lacks Linux bonding mode options.

Version-Release number of selected component (if applicable):
OSP 9 GA


Actual results:
The bonding recommendations should not mention "balance-tcp" mode (except to say never to use it), because LACP is broken in the version of OVS included in OSP 9.

Expected results:
The bonding instructions should be general (not specifically for OVS), and should be correct.

Additional info:
Here is a good summary of the OVS bonding options:

 "bond_mode=balance-slb lacp=off"

This enables balance-slb, which uses standard switch port configuration (no special switch support is required, only multiple ports with the same VLAN configuration), and LACP is not supported in this mode. LACP should not be used with OVS in OSP 9.

Here are some other configuration options for OVS:

# Set the link detection to use miimon heartbeats or monitor carrier (default)
  "other_config:bond-detect-mode=[miimon|carrier]"
# If using miimon, heartbeat interval in milliseconds (100 is usually good)
 "other_config:bond-miimon-interval=100"
# Number of milliseconds a link must be up to be activated (to prevent flapping)
 "other_config:bond_updelay=1000"

Here is a good recommendation for a Linux bonding LACP config:

"mode=802.3ad lacp_rate=[fast|slow] updelay=1000 miimon=100"

The mode statement enables LACP, the lacp_rate statement defines whether LACP packets are sent every 1 or every 30 seconds, the updelay establishes the minimum amount of time that an interface must be active before it is used for traffic (this prevents outages due to port "flapping"), and the miimon is the interval in milliseconds that is used for monitoring port state via MIIMON functionality in the driver.

Comment 7 Martin Lopes 2016-09-21 02:38:27 UTC
Republished updated guide:

https://access.redhat.com/documentation/en/red-hat-openstack-platform/9/single/director-installation-and-usage/#appe-Bonding_Options


What's changed: 

* `Table H.1. Bonding Options` - Removed balance-tcp section. 

* Updated note: Changed LACP example to use bonding_options: "mode=802.3ad lacp_rate=[fast|slow] updelay=1000 miimon=100"

* Updated note: Added descriptions for the above options.

* Throughout the guide: Changed all `balance-tcp` examples to `balance-slb`.

Comment 12 Martin Lopes 2016-11-08 04:37:11 UTC
This was merged by the QA contact. Moving to Verified.


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