git://git.onelab.eu / sliver-openvswitch.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
ovs-xapi-sync: Convert to vlog.
[sliver-openvswitch.git] / xenserver / README
diff --git a/xenserver/README b/xenserver/README
index 6c91e94..0e2affa 100644 (file)
--- a/xenserver/README
+++ b/xenserver/README
@@ -1,86 +1,110 @@
-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 is installed on a XenServer system
 under the same name, if 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_sysconfig_vswitch.example
-
-        Example configuration options for vswitch.
-
-    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.
 
         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_bugtool_system-configuration.xml
+
+        Custom xen-bugtool category to 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.
+
+    etc_xensource_bugtool_system-configuration_openvswitch.xml
+
+        xen-bugtool extension to collect system configuration information
+        relevant to Open vSwitch, including timezone.
+
     etc_xensource_scripts_vif
 
     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
 
-        vswitch-aware replacement for Citrix script of the same name.
+        Open vSwitch-aware replacement for Citrix script of the same name.
 
 
-    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.
 
 
-    usr_lib_xsconsole_plugins-base_XSFeatureVSwitch.py
+    usr_share_openvswitch_scripts_sysconfig.template
 
 
-        xsconsole plugin to configure the pool-wide configuration keys
-        used to control vswitch when integrated with Citrix management
-        tools.
+        Template for Open vSwitch's /etc/sysconfig/openvswitch
+        configuration file.
 
 
-    usr_sbin_xen-bugtool
+    usr_share_openvswitch_scripts_xen-bugtool-tc-class-show
 
 
-        vswitch-aware replacement for Citrix script of the same name.
+        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.
 
 
-    vswitch-xen.spec
+    usr_lib_xsconsole_plugins-base_XSFeatureVSwitch.py
 
 
-        spec file for building RPMs to install on a XenServer host.
+        xsconsole plugin to configure the pool-wide configuration keys
+        used to control Open vSwitch when integrated with Citrix
+        management tools.
 
 
-To install, build the vswitch RPM with a command like this:
+To install, build the Open vSwitch RPM with a command like this:
 
 
-        rpmbuild -D "vswitch_version $full_version" \
+        rpmbuild -D "openvswitch_version $full_version" \
                 -D "xen_version $XENKERNEL" \
                 -D "build_number --with-build-number=$buildnr" \
                 -D "xen_version $XENKERNEL" \
                 -D "build_number --with-build-number=$buildnr" \
-                -bb vswitch-xen.spec
+                -bb openvswitch-xen.spec
 
 
-Then, "rpm -U" the resulting vswitch package on the XenServer hosts in
-question and reboot them.  (The vswitch-dbg package that is also
+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.)
 
 ----------------------------------------------------------------------
 produced need not be installed, but it is harmless to do so.)
 
 ----------------------------------------------------------------------
-Copyright (C) 2009 Nicira Networks, Inc.
+Copyright (C) 2009, 2010, 2011 Nicira Networks, 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
sliver-openvswitch