xenserver: Simplify RPM build instructions.
[sliver-openvswitch.git] / xenserver / README
index 5023de2..c626a92 100644 (file)
@@ -4,9 +4,8 @@ Citrix XenServer hosts managed by the Citrix management tools.
 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
 
@@ -43,8 +42,18 @@ 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_lib_xsconsole_plugins-base_XSFeatureVSwitch.py
+
+        xsconsole plugin to configure the pool-wide configuration keys
+        used to control Open vSwitch when integrated with Citrix
+        management tools.
 
     usr_share_openvswitch_scripts_ovs-xapi-sync
 
@@ -54,35 +63,60 @@ files are:
 
     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_xen-bugtool
+        Collect kernel information relevant to Open vSwitch, such as
+        slabinfo.
 
-        Open vSwitch-aware replacement for Citrix script of the same name.
+    network-status/openvswitch.xml
+
+        Collect networking information relevant to Open vSwitch.  Runs
+        the following scripts, which are described below:
+
+            * ovs-bugtool-cfm-show
+            * ovs-bugtool-lcap-show
+            * ovs-bugtool-ovsdb-dump
+            * ovs-bugtool-tc-class-show
+
+    system-configuration/openvswitch.xml
+
+        Collect system configuration information relevant to Open vSwitch,
+        including timezone.
+
+    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
 
-    uuid.py
+        Script to dump detailed LACP information for all enabled ports.
 
-        This is uuid.py from Python 2.5.  It is installed into the
-        Open vSwitch RPM because XenServer uses Python 2.4, which does
-        not have uuid.py.
+    ovs-bugtool-ovsdb-dump
 
-To install, build the Open vSwitch RPM with a command like this:
+        Script to dump contents of Open vSwitch configuration database 
+        in comma-separated value format.
 
-        rpmbuild -D "openvswitch_version $full_version" \
-                -D "xen_version $XENKERNEL" \
-                -D "build_number --with-build-number=$buildnr" \
-                -bb openvswitch-xen.spec
+    ovs-bugtool-tc-class-show
 
-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 tc class configuration for all network interfaces.
 
 ----------------------------------------------------------------------
 Copyright (C) 2009, 2010, 2011 Nicira Networks, Inc.