vlog: Take advantage of relaxed "-v" syntax through the tree.

[sliver-openvswitch.git] / xenserver / README

diff --git a/xenserver/README b/xenserver/README
index 3f26776..e72655f 100644 (file)
--- a/xenserver/README
+++ b/xenserver/README
@@ -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.
 
 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
 
 
     etc_init.d_openvswitch
 


@@ -34,17 +33,6 @@ files are:
         in the ovs-vswitchd configuration that are managed in the
         xapi database when integrated with Citrix management tools.
 
         in the ovs-vswitchd configuration that are managed in the
         xapi database when integrated with Citrix management tools.
 

-    etc_xensource_bugtool_network-status_openvswitch.xml
-
-        xen-bugtool extension to collect networking information relevant to
-        Open vSwitch. Runs
-        usr_share_openvswitch_scripts_xen-bugtool-tc-class-show.
-
-    etc_xensource_bugtool_kernel-info_openvswitch.xml
-
-        xen-bugtool extension to collect kernel information relevant to
-        Open vSwitch.
-

     etc_xensource_scripts_vif
 
         Open vSwitch-aware replacement for Citrix script of the same name.
     etc_xensource_scripts_vif
 
         Open vSwitch-aware replacement for Citrix script of the same name.


@@ -54,8 +42,18 @@ files are:
         spec file for building RPMs to install on a XenServer host.
 
     opt_xensource_libexec_interface-reconfigure
         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
 
 
     usr_share_openvswitch_scripts_ovs-xapi-sync
 


@@ -65,40 +63,71 @@ files are:
 
     usr_share_openvswitch_scripts_sysconfig.template
 
 
     usr_share_openvswitch_scripts_sysconfig.template
 

-        Template for Open vSwitch's /etc/sysconfig/openvswitch 
+        Template for Open vSwitch's /etc/sysconfig/openvswitch

         configuration file.
 
         configuration file.
 

-    usr_share_openvswitch_scripts_xen-bugtool-tc-class-show
+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:

 
 

-        Script to dump tc class configuration for all network
-        interfaces. Intended to be run by xen-bugtool via
-        etc_xensource_bugtool_network-status_openvswitch.xml.
+    kernel-info/openvswitch.xml

 
 

-    usr_lib_xsconsole_plugins-base_XSFeatureVSwitch.py
+        Collect kernel information relevant to Open vSwitch, such as
+        slabinfo.

 
 

-        xsconsole plugin to configure the pool-wide configuration keys
-        used to control Open vSwitch when integrated with Citrix 
-        management tools.
+    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
+            * ovs-bugtool-bond-show
+
+    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-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

 
 

-    uuid.py
+        Script to dump contents of Open vSwitch configuration database 
+        in comma-separated value format.

 
 

-        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-tc-class-show

 
 

-To install, build the Open vSwitch RPM with a command like this:
+        Script to dump tc class configuration for all network interfaces.

 
 

-        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, 2011 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