When set-connection was added the ability to specify the ability to
read, read/write, and a role for the connection entity existed but was
not documented.

Assisted-by: Claude Opus 4.6, Claude Code
Fixes: c869c7c91e94 ("ovn-sb: remote connection management in sb db")
Signed-off-by: Jacob Tanenbaum <[email protected]>
---
 utilities/ovn-sbctl.8.xml | 37 +++++++++++++++++++++++++++++++++----
 utilities/ovn-sbctl.c     |  2 ++
 2 files changed, 35 insertions(+), 4 deletions(-)

diff --git a/utilities/ovn-sbctl.8.xml b/utilities/ovn-sbctl.8.xml
index 56fcdcb0d..433205450 100644
--- a/utilities/ovn-sbctl.8.xml
+++ b/utilities/ovn-sbctl.8.xml
@@ -485,10 +485,39 @@
 
       <dt>[<code>--inactivity-probe=</code><var>msecs</var>] 
<code>set-connection</code> <var>target</var>...</dt>
       <dd>
-        Sets the configured connection target or targets.  Use
-        <code>--inactivity-probe=</code><var>msecs</var> to override the
-        default idle connection inactivity probe time.  Use 0 to disable
-        inactivity probes.
+        <p>
+          Sets the configured connection target or targets.  Use
+          <code>--inactivity-probe=</code><var>msecs</var> to override the
+          default idle connection inactivity probe time.  Use 0 to disable
+          inactivity probes.
+        </p>
+
+        <p>
+          Each <var>target</var> may be preceded by zero or more of the
+          following modifiers, which apply to all subsequent targets until
+          changed:
+        </p>
+
+        <dl>
+          <dt><code>read-only</code></dt>
+          <dd>
+            Sets the <code>read_only</code> column for subsequent connections
+            to <code>true</code>, restricting them to read-only transactions.
+          </dd>
+
+          <dt><code>read-write</code></dt>
+          <dd>
+            Sets the <code>read_only</code> column for subsequent connections
+            to <code>false</code>, allowing them to modify the database.
+            This is the default.
+          </dd>
+
+          <dt><code>role=</code><var>name</var></dt>
+          <dd>
+            Sets the <code>role</code> column for subsequent connections to
+            <var>name</var>.  The default is the empty string.
+          </dd>
+        </dl>
       </dd>
     </dl>
 
diff --git a/utilities/ovn-sbctl.c b/utilities/ovn-sbctl.c
index a6d6678cd..8a49341f6 100644
--- a/utilities/ovn-sbctl.c
+++ b/utilities/ovn-sbctl.c
@@ -118,6 +118,8 @@ Connection commands:\n\
   del-connection             delete the connections\n\
   [--inactivity-probe=MSECS]\n\
   set-connection TARGET...   set the list of connections to TARGET...\n\
+                               (TARGET may be preceded by read-only,\n\
+                               read-write, or role=NAME)\n\
 \n\
 SSL/TLS commands:\n\
   get-ssl                     print the SSL/TLS configuration\n\
-- 
2.55.0

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

Reply via email to