Cleanup default file locations and XenServer packaging
[sliver-openvswitch.git] / xenserver / README
index 6dafdb4..255e5e6 100644 (file)
@@ -1,4 +1,4 @@
-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 XenServer hosts managed by the Citrix management tools.
 
 Some of these files are modifications of Citrix's proprietary code.
@@ -11,55 +11,60 @@ 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:
 
 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_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.
 
     etc_xensource_scripts_vif
 
         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_interface-reconfigure
 
-        vswitch-aware replacement for Citrix script of the same name.
+        Open vSwitch-aware replacement for Citrix script of the same name.
 
 
-    usr_share_vswitch_scripts_refresh-network-uuids
+    usr_share_openvswitch_scripts_refresh-network-uuids
 
         Script to refresh bridge.<bridge>.network-uuids keys, which
         can get out-of-sync following a pool join.  Running this script
         is an alternative to rebooting the host.
 
 
         Script to refresh bridge.<bridge>.network-uuids keys, which
         can get out-of-sync following a pool join.  Running this script
         is an alternative to rebooting the host.
 
-    root_vswitch_scripts_sysconfig.template
+    usr_share_openvswitch_scripts_sysconfig.template
 
 
-        Template for vswitch's /etc/sysconfig/vswitch configuration
-        file.
+        Template for Open vSwitch's /etc/sysconfig/openvswitch 
+        configuration file.
 
     usr_lib_xsconsole_plugins-base_XSFeatureVSwitch.py
 
         xsconsole plugin to configure the pool-wide configuration keys
 
     usr_lib_xsconsole_plugins-base_XSFeatureVSwitch.py
 
         xsconsole plugin to configure the pool-wide configuration keys
-        used to control vswitch when integrated with Citrix management
-        tools.
+        used to control Open vSwitch when integrated with Citrix 
+        management tools.
 
     usr_sbin_brctl
 
 
     usr_sbin_brctl
 
@@ -68,25 +73,21 @@ files are:
 
     usr_sbin_xen-bugtool
 
 
     usr_sbin_xen-bugtool
 
-        vswitch-aware replacement for Citrix script of the same name.
-
-    vswitch-xen.spec
-
-        spec file for building RPMs to install on a XenServer host.
+        Open vSwitch-aware replacement for Citrix script of the same name.
 
 
-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 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