diff mbox

[ovs-dev,RFC,01/21] vswitch.xml: Add keepalive support.

Message ID 1496852117-71097-2-git-send-email-bhanuprakash.bodireddy@intel.com
State Superseded
Headers show

Commit Message

Bodireddy, Bhanuprakash June 7, 2017, 4:14 p.m. UTC 
Add support for keepalive functionality. By default, the keepalive is off and
can be enabled/disabled only at init time.

For eg:
  To enable keepalive feature.
  'ovs-vsctl --no-wait set Open_vSwitch . other_config:enable-keepalive=true'

  To set timer interval of 500ms for monitoring packet processing cores;
  'ovs-vsctl --no-wait set Open_vSwitch . \
     other_config:keepalive-interval="500"

  To set shared memory block name where the events shall be updated
  'ovs-vsctl --no-wait set Open_vSwitch .
     other_config:keepalive-shm-name="/ovs_keepalive_shm_name"'

Signed-off-by: Bhanuprakash Bodireddy <bhanuprakash.bodireddy@intel.com>
---
 vswitchd/vswitch.xml | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

Comments

Ben Pfaff June 7, 2017, 9:18 p.m. UTC | #1 
On Wed, Jun 07, 2017 at 05:14:57PM +0100, Bhanuprakash Bodireddy wrote:
> Add support for keepalive functionality. By default, the keepalive is off and
> can be enabled/disabled only at init time.
> 
> For eg:
>   To enable keepalive feature.
>   'ovs-vsctl --no-wait set Open_vSwitch . other_config:enable-keepalive=true'
> 
>   To set timer interval of 500ms for monitoring packet processing cores;
>   'ovs-vsctl --no-wait set Open_vSwitch . \
>      other_config:keepalive-interval="500"
> 
>   To set shared memory block name where the events shall be updated
>   'ovs-vsctl --no-wait set Open_vSwitch .
>      other_config:keepalive-shm-name="/ovs_keepalive_shm_name"'
> 
> Signed-off-by: Bhanuprakash Bodireddy <bhanuprakash.bodireddy@intel.com>

Thanks for working on Open vSwitch and keeping the documentation up to
date.

Our usual practice is to document a feature in the same commit that
implements the feature, so probably this commit should be folded into
one later in the series.
diff mbox

Patch

diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index 892f839..59c96df 100644
--- a/vswitchd/vswitch.xml
+++ b/vswitchd/vswitch.xml
@@ -531,6 +531,45 @@ 
           </p>
         </column>
       </group>
+
+      <group title="Keepalive">
+        <p>
+          The <code>keepalive</code> column contains key-value pairs that
+          report health of datapath cores in Open vSwitch.  These are updated
+          periodically (based on the keepalive-interval).
+        </p>
+
+        <column name="other_config" key="enable-keepalive"
+                type='{"type": "boolean"}'>
+          Keepalive is disabled by default to avoid overhead in the common
+          case when heartbeat monitoring is not useful.  Set this value to
+          <code>true</code> to enable keepalive <ref column="keepalive"/>
+          column or to <code>false</code> to explicitly disable it.
+        </column>
+
+        <column name="other_config" key="keepalive-interval"
+                type='{"type": "integer", "minInteger": 1}'>
+          <p>
+            Specifies the keepalive interval value.
+          </p>
+          <p>
+            If not specified, this will be set to 100 milliseconds (default
+            value). Changing this value requires restarting the daemon.
+          </p>
+        </column>
+
+        <column name="other_config" key="keepalive-shm-name"
+              type='{"type": "string"}'>
+          <p>
+            Specifies the keepalive shared memory block name.
+          </p>
+          <p>
+            If not specified, shared memory block named "keepalive_shm_name"
+            (default name) is created. Changing this value requires restarting
+            the daemon.
+          </p>
+        </column>
+      </group>
     </group>
 
     <group title="Version Reporting">