xenserver: Add information about some bugtool scripts.

[sliver-openvswitch.git] / xenserver / README

diff --git a/xenserver/README b/xenserver/README
index ff692fd..472159e 100644 (file)
--- a/xenserver/README
+++ b/xenserver/README
@@ -1,98 +1,164 @@
-This directory contains files for seamless integration of vswitch on
+This directory contains files for seamless integration of Open vSwitch on

 Citrix XenServer hosts managed by the Citrix management tools.
 
 Citrix XenServer hosts managed by the Citrix management tools.
 

-Some of these files are modifications of Citrix's proprietary code.
-Citrix has given permission to distribute these modified files.
-Citrix has not specified a particular license for them.  There is no
-guarantee that, should Citrix specify a license, that it would be
-DFSG-compliant or GPL-compatible.
+Files in this directory are licensed on a file-by-file basis.  Please
+refer to each file for details.

 
 

-Most of the files in this directory is installed on a XenServer system
-under the same name, if underscores are replaced by slashes.  The
-files are:
+Most of the files in this directory are installed on a XenServer system
+under the same name; underscores are replaced by slashes.  The files are:

 
 

-    etc_init.d_vswitch
+    etc_init.d_openvswitch

 
 

-        Initializes the vswitch at boot and shuts it down at shutdown.
+        Initializes Open vSwitch at boot and shuts it down at shutdown.

 
 

-    etc_init.d_vswitch-xapi-update
+    etc_init.d_openvswitch-xapi-update

 
 

-        Init script to ensure vswitch-cfg-update is called for the
+        Init script to ensure openvswitch-cfg-update is called for the

         current host at boot.
 
         current host at boot.
 

-    etc_logrotate.d_vswitch
+    etc_logrotate.d_openvswitch

 
 

-        Ensures that /var/log/ovs-vswitchd.log is rotated periodically
-        and that ovs-vswitchd reopens its log file at that point.
+        Ensures that logs in /var/log/openvswitch are rotated
+        periodically and that appropriate daemons reopen their log
+        files at that point.

 
 

-    etc_profile.d_vswitch.sh
+    etc_profile.d_openvswitch.sh

 
 

-        vswitch-related shell functions for the administrator's
+        Open vSwitch-related shell functions for the administrator's

         convenience.
 
         convenience.
 

-    etc_xapi.d_plugins_vswitch-cfg-update
+    etc_xapi.d_plugins_openvswitch-cfg-update

 
         xapi plugin script to update the cache of configuration items
 
         xapi plugin script to update the cache of configuration items

-        in the ovs-vswitchd configuration file that are managed in the
+        in the ovs-vswitchd configuration that are managed in the

         xapi database when integrated with Citrix management tools.
 
     etc_xensource_scripts_vif
 
         xapi database when integrated with Citrix management tools.
 
     etc_xensource_scripts_vif
 

-        vswitch-aware replacement for Citrix script of the same name.
+        Open vSwitch-aware replacement for Citrix script of the same name.
+
+    openvswitch-xen.spec
+
+        spec file for building RPMs to install on a XenServer host.

 
     opt_xensource_libexec_interface-reconfigure
 
     opt_xensource_libexec_interface-reconfigure

+    opt_xensource_libexec_InterfaceReconfigureBridge.py
+    opt_xensource_libexec_InterfaceReconfigure.py
+    opt_xensource_libexec_InterfaceReconfigureVswitch.py

 
 

-        vswitch-aware replacement for Citrix script of the same name.
+        Open vSwitch-aware replacements for Citrix script of the same
+        names.

 
 

-    root_vswitch_scripts_dump-vif-details
+    usr_lib_xsconsole_plugins-base_XSFeatureVSwitch.py

 
 

-        Script to retrieve extended information about VIFs that are
-        needed by the controller.  This is called by the "vif" script,
-        which is run when virtual interfaces are added and removed.
+        xsconsole plugin to configure the pool-wide configuration keys
+        used to control Open vSwitch when integrated with Citrix
+        management tools.

 
 

-    usr_share_vswitch_scripts_refresh-xs-network-uuids
+    usr_share_openvswitch_scripts_ovs-xapi-sync

 
 

-        Script to refresh bridge.<bridge>.xs-network-uuids keys, which
-        can get out-of-sync following a pool join.  Running this script
-        is an alternative to rebooting the host.
+        Daemon to monitor the external_ids columns of the Bridge and
+        Interface OVSDB tables for changes that require interrogating
+        XAPI.

 
 

-    root_vswitch_scripts_sysconfig.template
+    usr_share_openvswitch_scripts_sysconfig.template

 
 

-        Template for vswitch's /etc/sysconfig/vswitch configuration
-        file.
+        Template for Open vSwitch's /etc/sysconfig/openvswitch
+        configuration file.

 
 

-    usr_lib_xsconsole_plugins-base_XSFeatureVSwitch.py
+Open vSwitch installs a number of xen-bugtool extensions in
+/etc/xensource/bugtool to gather additional information useful for
+debugging.  The sources for the extensions are in
+../utilities/bugtool/plugins:

 
 

-        xsconsole plugin to configure the pool-wide configuration keys
-        used to control vswitch when integrated with Citrix management
-        tools.
+    kernel-info/openvswitch.xml

 
 

-    usr_sbin_brctl
+        Collect kernel information relevant to Open vSwitch, such as
+        slabinfo.

 
 

-        wrapper for /usr/sbin/brctl that provides some additional
-        bridge compatibility
+    network-status/openvswitch.xml

 
 

-    usr_sbin_xen-bugtool
+        Collect networking information relevant to Open vSwitch.  Runs
+        the following scripts, which are described below:

 
 

-        vswitch-aware replacement for Citrix script of the same name.
+            * ovs-bugtool-cfm-show
+            * ovs-bugtool-lacp-show
+            * ovs-bugtool-ovsdb-dump
+            * ovs-bugtool-tc-class-show
+            * ovs-bugtool-bond-show
+            * ovs-bugtool-ovs-ofctl-show
+            * ovs-bugtool-ovs-ofctl-dump-flows
+            * ovs-bugtool-ovs-appctl-dpif
+            * ovs-bugtool-coverage-show
+            * ovs-bugtool-memory-show
+            * ovs-bugtool-vsctl-show

 
 

-    vswitch-xen.spec
+    system-configuration/openvswitch.xml

 
 

-        spec file for building RPMs to install on a XenServer host.
+        Collect system configuration information relevant to Open vSwitch,
+        including timezone. Runs the following script which is described
+        below:
+
+            * ovs-bugtool-daemons-ver
+
+    system-configuration.xml
+
+        Collect system configuration data.  This category is configured
+        to collect up to 1Mb of data, take up to 60 seconds to collect
+        data, run every time and is hidden from display in XenCenter.
+
+A number of scripts are installed in /usr/share/openvswitch/scripts to
+assist Open vSwitch's xen-bugtool extensions.  The sources for the
+scripts are located in ../utilities/bugtool:
+
+    ovs-bugtool-cfm-show
+
+        Script to dump detailed CFM information for all enabled interfaces.
+
+    ovs-bugtool-lacp-show
+
+        Script to dump detailed LACP information for all enabled ports.
+
+    ovs-bugtool-ovsdb-dump
+
+        Script to dump contents of Open vSwitch configuration database 
+        in comma-separated value format.
+
+    ovs-bugtool-tc-class-show
+
+        Script to dump tc class configuration for all network interfaces.
+
+    ovs-bugtool-ovs-ofctl-show
+
+        Script to dump information about flow tables and ports of each bridge.
+
+    ovs-bugtool-ovs-ofctl-dump-flows
+
+        Script to dump openflow flows of each bridge.
+
+    ovs-bugtool-ovs-appctl-dpif
+
+        Script to collect a summary of configured datapaths and datapath flows.
+
+    ovs-bugtool-coverage-show
+
+        Script to count the number of times particular events occur during
+        ovs-vswitchd's runtime.
+
+    ovs-bugtool-memory-show
+
+        Script to show some basic statistics about ovs-vswitchd's memory usage.
+
+    ovs-bugtool-vsctl-show

 
 

-To install, build the vswitch RPM with a command like this:
+        Script to show a brief overview of the database contents.

 
 

-        rpmbuild -D "vswitch_version $full_version" \
-                -D "xen_version $XENKERNEL" \
-                -D "build_number --with-build-number=$buildnr" \
-                -bb vswitch-xen.spec
+    ovs-bugtool-daemons-ver

 
 

-Then, "rpm -U" the resulting vswitch package on the XenServer hosts in
-question and reboot them.  (The vswitch-dbg package that is also
-produced need not be installed, but it is harmless to do so.)
+        Script to dump version information for all Open vSwitch daemons.

 
 ----------------------------------------------------------------------
 
 ----------------------------------------------------------------------

-Copyright (C) 2009 Nicira Networks, Inc.
+Copyright (C) 2009, 2010, 2011 Nicira, Inc.

 
 Copying and distribution of this file, with or without modification,
 are permitted in any medium without royalty provided the copyright
 
 Copying and distribution of this file, with or without modification,
 are permitted in any medium without royalty provided the copyright