Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
[cascardo/ovs.git] / xenserver / README
1 This directory contains files for seamless integration of vswitch on
2 Citrix XenServer hosts managed by the Citrix management tools.
3
4 Some of these files are modifications of Citrix's proprietary code.
5 Citrix has given permission to distribute these modified files.
6 Citrix has not specified a particular license for them.  There is no
7 guarantee that, should Citrix specify a license, that it would be
8 DFSG-compliant or GPL-compatible.
9
10 Most of the files in this directory is installed on a XenServer system
11 under the same name, if underscores are replaced by slashes.  The
12 files are:
13
14     etc_init.d_vswitch
15
16         Initializes the vswitch at boot and shuts it down at shutdown.
17
18     etc_init.d_vswitch-xapi-update
19
20         Init script to ensure vswitch-cfg-update is called for the
21         current host at boot.
22
23     etc_logrotate.d_vswitch
24
25         Ensures that /var/log/ovs-vswitchd.log is rotated periodically
26         and that ovs-vswitchd reopens its log file at that point.
27
28     etc_profile.d_vswitch.sh
29
30         vswitch-related shell functions for the administrator's
31         convenience.
32
33     etc_sysconfig_vswitch.example
34
35         Example configuration options for vswitch.
36
37     etc_xapi.d_plugins_vswitch-cfg-update
38
39         xapi plugin script to update the cache of configuration items
40         in the ovs-vswitchd configuration file that are managed in the
41         xapi database when integrated with Citrix management tools.
42
43     etc_xensource_scripts_vif
44
45         vswitch-aware replacement for Citrix script of the same name.
46
47     opt_xensource_libexec_interface-reconfigure
48
49         vswitch-aware replacement for Citrix script of the same name.
50
51     usr_lib_xsconsole_plugins-base_XSFeatureVSwitch.py
52
53         xsconsole plugin to configure the pool-wide configuration keys
54         used to control vswitch when integrated with Citrix management
55         tools.
56
57     vswitch-xen.spec
58
59         spec file for building RPMs to install on a XenServer host.
60
61 To install, build the vswitch RPM with a command like this:
62
63         rpmbuild -D "vswitch_version $full_version" \
64                 -D "xen_version $XENKERNEL" \
65                 -D "build_number --with-build-number=$buildnr" \
66                 -bb vswitch-xen.spec
67
68 Then, "rpm -U" the resulting vswitch package on the XenServer hosts in
69 question and reboot them.  (The vswitch-dbg package that is also
70 produced need not be installed, but it is harmless to do so.)
71
72 ----------------------------------------------------------------------
73 Copyright (C) 2009 Nicira Networks, Inc.
74
75 Copying and distribution of this file, with or without modification,
76 are permitted in any medium without royalty provided the copyright
77 notice and this notice are preserved.  This file is offered as-is,
78 without warranty of any kind.