Merge branch 'mainstream'
[sliver-openvswitch.git] / xenserver / README
index 5407aac..e72655f 100644 (file)
-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.
 
-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.
 
-    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.
 
-    etc_xapi.d_plugins_vswitch-cfg-update
+    etc_xapi.d_plugins_openvswitch-cfg-update
 
         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
 
-        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_InterfaceReconfigureBridge.py
+    opt_xensource_libexec_InterfaceReconfigure.py
+    opt_xensource_libexec_InterfaceReconfigureVswitch.py
+
+        Open vSwitch-aware replacements for Citrix script of the same
+        names.
+
+    usr_lib_xsconsole_plugins-base_XSFeatureVSwitch.py
 
-        vswitch-aware replacement for Citrix script of the same name.
+        xsconsole plugin to configure the pool-wide configuration keys
+        used to control Open vSwitch when integrated with Citrix
+        management tools.
 
-    root_vswitch_scripts_dump-vif-details
+    usr_share_openvswitch_scripts_ovs-xapi-sync
 
-        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.
+        Daemon to monitor the external_ids columns of the Bridge and
+        Interface OVSDB tables for changes that require interrogating
+        XAPI.
 
-    root_vswitch_scripts_refresh-xs-network-uuids
+    usr_share_openvswitch_scripts_sysconfig.template
 
-        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.
+        Template for Open vSwitch's /etc/sysconfig/openvswitch
+        configuration file.
 
-    root_vswitch_scripts_sysconfig.template
+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:
 
-        Template for vswitch's /etc/sysconfig/vswitch configuration
-        file.
+    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 vswitch when integrated with Citrix management
-        tools.
+    network-status/openvswitch.xml
 
-    usr_sbin_brctl
+        Collect networking information relevant to Open vSwitch.  Runs
+        the following scripts, which are described below:
 
-        wrapper for /usr/sbin/brctl that provides some additional
-        bridge compatibility
+            * ovs-bugtool-cfm-show
+            * ovs-bugtool-lcap-show
+            * ovs-bugtool-ovsdb-dump
+            * ovs-bugtool-tc-class-show
+            * ovs-bugtool-bond-show
 
-    usr_sbin_xen-bugtool
+    system-configuration/openvswitch.xml
 
-        vswitch-aware replacement for Citrix script of the same name.
+        Collect system configuration information relevant to Open vSwitch,
+        including timezone. Runs the following script which is described
+        below:
 
-    vswitch-xen.spec
+            * ovs-bugtool-daemons-ver
 
-        spec file for building RPMs to install on a XenServer host.
+    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
 
-To install, build the vswitch RPM with a command like this:
+        Script to dump tc class configuration for all network interfaces.
 
-        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