Improve documentation on data-port functionality

Update docs to clarify that manual removing of previous
values are required if the config changes.

Related-bug: #1915967
Change-Id: I99ffab5488a088c40c276ba5be0b60223e077eb6
This commit is contained in:
Rodrigo Barbieri 2021-03-22 14:01:09 -03:00
parent 7b9b0de521
commit bd851d4884

View File

@ -24,19 +24,27 @@ options:
type: string type: string
default: default:
description: | description: |
Space-delimited list of bridge:port mappings. Ports will be added to Space-delimited list of bridge:port mappings. Specified ports will be
their corresponding bridge. The bridges will allow usage of flat or added to their corresponding specified bridge. The bridges will allow
VLAN network types with Neutron and should match this defined in usage of flat or VLAN network types with Neutron and should match this
bridge-mappings. defined in bridge-mappings.
. .
Ports provided can be the name or MAC address of the interface to be Ports can be specified through the name or MAC address of the interface
added to the bridge. If MAC addresses are used, you may provide multiple to be added to the bridge. If MAC addresses are used, you may provide
bridge:mac for the same bridge so as to be able to configure multiple multiple bridge:mac for the same bridge so as to be able to configure
units. In this case the charm will run through the provided MAC addresses multiple units. In this case the charm will run through the provided MAC
for each bridge until it finds one it can resolve to an interface name. addresses for each bridge until it finds one it can resolve to an
interface name.
Port can also be a linuxbridge bridge. In this case a veth pair will be Port can also be a linuxbridge bridge. In this case a veth pair will be
created, the ovs bridge and the linuxbridge bridge will be connected. It created, the ovs bridge and the linuxbridge bridge will be connected. It
can be useful to connect the ovs bridge to juju bridge. can be useful to connect the ovs bridge to juju bridge.
.
Any changes (subsequent to the initial setting) made to the value of this
option will merely add the new values along with the existing ones. If
removal of old values is desired, they have to be done manually through
the command "ovs-vsctl" in the affected units. If the new values conflict
with the previous ones, it may cause a network outage as seen in bug
https://pad.lv/1915967
dpdk-bond-mappings: dpdk-bond-mappings:
type: string type: string
default: default: