[ovs-dev] documentation: man vswitchd.conf.db(5) updated flow-restore-wait

Message ID 1541197529-22000-1-git-send-email-zwhitt.vmware@gmail.com
State Accepted
Headers show
Series
  • [ovs-dev] documentation: man vswitchd.conf.db(5) updated flow-restore-wait
Related show

Commit Message

Zak Whittington Nov. 2, 2018, 10:25 p.m.
Commit 7ed73428a changed the behavior of flow-restore-wait to
also prevent the switch from connecting to controllers in the
controller table, but failed to update the man page documentation
generated by vswitchd/vswitch.xml to reflect this.

This commit adds that documentation.

Signed-off-by: Zak Whittington <zwhitt.vmware@gmail.com>
---
 vswitchd/vswitch.xml | 10 ++++++++++
 1 file changed, 10 insertions(+)

Comments

Ben Pfaff Nov. 2, 2018, 11:17 p.m. | #1
On Fri, Nov 02, 2018 at 03:25:29PM -0700, Zak Whittington wrote:
> Commit 7ed73428a changed the behavior of flow-restore-wait to
> also prevent the switch from connecting to controllers in the
> controller table, but failed to update the man page documentation
> generated by vswitchd/vswitch.xml to reflect this.
> 
> This commit adds that documentation.
> 
> Signed-off-by: Zak Whittington <zwhitt.vmware@gmail.com>

Thanks, applied to master.

Patch

diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index 6d1fc1c..efa1ef8 100644
--- a/vswitchd/vswitch.xml
+++ b/vswitchd/vswitch.xml
@@ -122,6 +122,16 @@ 
           start receiving packets from the datapath and re-setup the flows.
         </p>
         <p>
+          Additionally, <code>ovs-vswitchd</code> is prevented from connecting
+          to controllers when this value is set to <code>true</code>. This
+          prevents controllers from making changes to the flow table in the
+          middle of flow restoration, which could result in undesirable
+          intermediate states. Once this value has been set to
+          <code>false</code> and the desired flow state has been
+          restored, <code>ovs-vswitchd</code> will be able to reconnect to
+          controllers and process any new flow table modifications.
+        </p>
+        <p>
           Thus, with this option, the procedure for a hot-upgrade of
           <code>ovs-vswitchd</code> becomes roughly the following:
         </p>