netdev-dpdk: fix mbuf leaks
[cascardo/ovs.git] / xenserver / README
index 9fcdb1a..87378d0 100644 (file)
@@ -1,15 +1,11 @@
 This directory contains files for seamless integration of Open vSwitch on
 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_openvswitch
 
@@ -46,58 +42,143 @@ files are:
         spec file for building RPMs to install on a XenServer host.
 
     opt_xensource_libexec_interface-reconfigure
+    opt_xensource_libexec_InterfaceReconfigureBridge.py
+    opt_xensource_libexec_InterfaceReconfigure.py
+    opt_xensource_libexec_InterfaceReconfigureVswitch.py
 
-        Open vSwitch-aware replacement for Citrix script of the same name.
+        Open vSwitch-aware replacements for Citrix script of the same
+        names.
 
-    usr_share_openvswitch_scripts_monitor-external-ids
+    usr_lib_xsconsole_plugins-base_XSFeatureVSwitch.py
 
-        Daemon to monitor the external_ids columns of the Bridge and
-        Interface OVSDB tables.
+        xsconsole plugin to configure the pool-wide configuration keys
+        used to control Open vSwitch when integrated with Citrix
+        management tools.
 
-    usr_share_openvswitch_scripts_refresh-xs-network-uuids
+    usr_share_openvswitch_scripts_ovs-xapi-sync
 
-        Script to refresh Bridge table external-ids:xs-network-uuids
-        values, which can get out-of-sync following a pool join.
+        Daemon to monitor the external_ids columns of the Bridge and
+        Interface OVSDB tables for changes that require interrogating
+        XAPI.
 
     usr_share_openvswitch_scripts_sysconfig.template
 
-        Template for Open vSwitch's /etc/sysconfig/openvswitch 
+        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 Open 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:
 
-        Open vSwitch-aware replacement for Citrix script of the same name.
+            * ovs-bugtool-bfd-show
+            * ovs-bugtool-cfm-show
+            * ovs-bugtool-fdb-show
+            * ovs-bugtool-lacp-show
+            * ovs-bugtool-list-dbs
+            * 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
+            * ovs-bugtool-conntrack-dump
+
+    system-configuration/openvswitch.xml
+
+        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-bfd-show
+
+        Script to dump detailed BFD information for all enabled interfaces.
+
+    ovs-bugtool-cfm-show
+
+        Script to dump detailed CFM information for all enabled interfaces.
+
+    ovs-bugtool-fdb-show
+
+        Script to collect a summary of learned MACs for each bridge.
+
+    ovs-bugtool-lacp-show
+
+        Script to dump detailed LACP information for all enabled ports.
+
+    ovs-bugtool-list-dbs
+
+        Script to list the databases controlled by ovsdb-server.
+
+    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
 
-    uuid.py
+        Script to show a brief overview of the database contents.
 
-        This is uuid.py from Python 2.5.  It is installed into the
-        Open vSwitch RPM because XenServer 5.5 and 5.6 use Python 2.4,
-        which do not have uuid.py.
+    ovs-bugtool-conntrack-dump
 
-To install, build the Open vSwitch RPM with a command like this:
+        Script to show all the connection entries in the tracker.
 
-        rpmbuild -D "openvswitch_version $full_version" \
-                -D "xen_version $XENKERNEL" \
-                -D "build_number --with-build-number=$buildnr" \
-                -bb openvswitch-xen.spec
+    ovs-bugtool-daemons-ver
 
-Then, "rpm -U" the resulting Open vSwitch package on the XenServer hosts in
-question and reboot them.  (The openvswitch-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, 2010 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