Debian: Add Homepage
[openvswitch] / xenserver / README
1 This directory contains files for seamless integration of Open 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_openvswitch
15
16         Initializes Open vSwitch at boot and shuts it down at shutdown.
17
18     etc_init.d_openvswitch-xapi-update
19
20         Init script to ensure openvswitch-cfg-update is called for the
21         current host at boot.
22
23     etc_logrotate.d_openvswitch
24
25         Ensures that logs in /var/log/openvswitch are rotated
26         periodically and that appropriate daemons reopen their log
27         files at that point.
28
29     etc_profile.d_openvswitch.sh
30
31         Open vSwitch-related shell functions for the administrator's
32         convenience.
33
34     etc_xapi.d_plugins_openvswitch-cfg-update
35
36         xapi plugin script to update the cache of configuration items
37         in the ovs-vswitchd configuration that are managed in the
38         xapi database when integrated with Citrix management tools.
39
40     etc_xensource_scripts_vif
41
42         Open vSwitch-aware replacement for Citrix script of the same name.
43
44     openvswitch-xen.spec
45
46         spec file for building RPMs to install on a XenServer host.
47
48     opt_xensource_libexec_interface-reconfigure
49
50         Open vSwitch-aware replacement for Citrix script of the same name.
51
52     usr_share_openvswitch_scripts_monitor-external-ids
53
54         Daemon to monitor the external_ids columns of the Bridge and
55         Interface OVSDB tables.
56
57     usr_share_openvswitch_scripts_refresh-xs-network-uuids
58
59         Script to refresh Bridge table external-ids:xs-network-uuids
60         values, which can get out-of-sync following a pool join.
61
62     usr_share_openvswitch_scripts_sysconfig.template
63
64         Template for Open vSwitch's /etc/sysconfig/openvswitch 
65         configuration file.
66
67     usr_lib_xsconsole_plugins-base_XSFeatureVSwitch.py
68
69         xsconsole plugin to configure the pool-wide configuration keys
70         used to control Open vSwitch when integrated with Citrix 
71         management tools.
72
73     usr_sbin_brctl
74
75         wrapper for /usr/sbin/brctl that provides some additional
76         bridge compatibility
77
78     usr_sbin_xen-bugtool
79
80         Open vSwitch-aware replacement for Citrix script of the same name.
81
82     uuid.py
83
84         This is uuid.py from Python 2.5.  It is installed into the
85         Open vSwitch RPM because XenServer 5.5 and 5.6 use Python 2.4,
86         which do not have uuid.py.
87
88 To install, build the Open vSwitch RPM with a command like this:
89
90         rpmbuild -D "openvswitch_version $full_version" \
91                 -D "xen_version $XENKERNEL" \
92                 -D "build_number --with-build-number=$buildnr" \
93                 -bb openvswitch-xen.spec
94
95 Then, "rpm -U" the resulting Open vSwitch package on the XenServer hosts in
96 question and reboot them.  (The openvswitch-dbg package that is also
97 produced need not be installed, but it is harmless to do so.)
98
99 ----------------------------------------------------------------------
100 Copyright (C) 2009, 2010 Nicira Networks, Inc.
101
102 Copying and distribution of this file, with or without modification,
103 are permitted in any medium without royalty provided the copyright
104 notice and this notice are preserved.  This file is offered as-is,
105 without warranty of any kind.