With the change in 354d766ca892 ("ovn-controller: Remove monitor all
of chassis private.") the documentation of the "ovn-monitor-all"
external_id became a bit stale.  The Chassis_Private table is always
conditionally monitored.

Update the documentation to reflect that.

While at it, also fix up some more minor issues in the documentation of
the flag.

Fixes: 3c355e35298b ("ovn-controller.c: Support option "ovn-monitor-all".")
Fixes: 354d766ca892 ("ovn-controller: Remove monitor all of chassis private.")
Reported-by: Ilya Maximets <[email protected]>
Signed-off-by: Dumitru Ceara <[email protected]>
---
 controller/ovn-controller.8.xml | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/controller/ovn-controller.8.xml b/controller/ovn-controller.8.xml
index a6a6d6f4e3..32f6210523 100644
--- a/controller/ovn-controller.8.xml
+++ b/controller/ovn-controller.8.xml
@@ -117,16 +117,19 @@
       <dd>
         <p>
           A boolean value that tells if <code>ovn-controller</code> should
-          monitor all records of tables in <var>ovs-database</var>.  If
-          set to <code>false</code>, it will conditionally monitor the records
-          that is needed in the current chassis.
+          monitor all records of most tables in the <var>OVN Southbound</var>
+          database.  The only exception is the <code>Chassis_Private</code>
+          table for which ovn-controller always monitors only the record that
+          is relevant to the local chassis.  If this option is set to
+          <code>false</code>, ovn-controller will conditionally monitor only
+          the records that are needed for the local chassis.
         </p>
         <p>
           It is more efficient to set it to <code>true</code> in use cases
           where the chassis would anyway need to monitor most of the records in
           <var>OVN Southbound</var> database, which would save the overhead of
           conditions processing, especially for server side.  Typically, set it
-          to <code>true</code> for environments that all workloads need to be
+          to <code>true</code> for environments where all workloads need to be
           reachable from each other.
         </p>
         <p>
-- 
2.48.1

_______________________________________________
dev mailing list
[email protected]
https://mail.openvswitch.org/mailman/listinfo/ovs-dev

Reply via email to