daemon: Integrate checking for an existing pidfile into daemonize_start().
[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 Files in this directory are licensed on a file-by-file basis.  Please
5 refer to each file for details.
6
7 Most of the files in this directory is installed on a XenServer system
8 under the same name, if underscores are replaced by slashes.  The
9 files are:
10
11     etc_init.d_openvswitch
12
13         Initializes Open vSwitch at boot and shuts it down at shutdown.
14
15     etc_init.d_openvswitch-xapi-update
16
17         Init script to ensure openvswitch-cfg-update is called for the
18         current host at boot.
19
20     etc_logrotate.d_openvswitch
21
22         Ensures that logs in /var/log/openvswitch are rotated
23         periodically and that appropriate daemons reopen their log
24         files at that point.
25
26     etc_profile.d_openvswitch.sh
27
28         Open vSwitch-related shell functions for the administrator's
29         convenience.
30
31     etc_xapi.d_plugins_openvswitch-cfg-update
32
33         xapi plugin script to update the cache of configuration items
34         in the ovs-vswitchd configuration that are managed in the
35         xapi database when integrated with Citrix management tools.
36
37     etc_xensource_bugtool_network-status_openvswitch.xml
38
39         xen-bugtool extension to collect networking information relevant to
40         Open vSwitch. Runs
41         usr_share_openvswitch_scripts_xen-bugtool-tc-class-show.
42
43     etc_xensource_bugtool_kernel-info_openvswitch.xml
44
45         xen-bugtool extension to collect kernel information relevant to
46         Open vSwitch.
47
48     etc_xensource_scripts_vif
49
50         Open vSwitch-aware replacement for Citrix script of the same name.
51
52     openvswitch-xen.spec
53
54         spec file for building RPMs to install on a XenServer host.
55
56     opt_xensource_libexec_interface-reconfigure
57
58         Open vSwitch-aware replacement for Citrix script of the same name.
59
60     usr_share_openvswitch_scripts_ovs-xapi-sync
61
62         Daemon to monitor the external_ids columns of the Bridge and
63         Interface OVSDB tables for changes that require interrogating
64         XAPI.
65
66     usr_share_openvswitch_scripts_sysconfig.template
67
68         Template for Open vSwitch's /etc/sysconfig/openvswitch 
69         configuration file.
70
71     usr_share_openvswitch_scripts_xen-bugtool-tc-class-show
72
73         Script to dump tc class configuration for all network
74         interfaces. Intended to be run by xen-bugtool via
75         etc_xensource_bugtool_network-status_openvswitch.xml.
76
77     usr_lib_xsconsole_plugins-base_XSFeatureVSwitch.py
78
79         xsconsole plugin to configure the pool-wide configuration keys
80         used to control Open vSwitch when integrated with Citrix 
81         management tools.
82
83     uuid.py
84
85         This is uuid.py from Python 2.5.  It is installed into the
86         Open vSwitch RPM because XenServer uses Python 2.4, which does
87         not have uuid.py.
88
89 To install, build the Open vSwitch RPM with a command like this:
90
91         rpmbuild -D "openvswitch_version $full_version" \
92                 -D "xen_version $XENKERNEL" \
93                 -D "build_number --with-build-number=$buildnr" \
94                 -bb openvswitch-xen.spec
95
96 Then, "rpm -U" the resulting Open vSwitch package on the XenServer hosts in
97 question and reboot them.  (The openvswitch-dbg package that is also
98 produced need not be installed, but it is harmless to do so.)
99
100 ----------------------------------------------------------------------
101 Copyright (C) 2009, 2010, 2011 Nicira Networks, Inc.
102
103 Copying and distribution of this file, with or without modification,
104 are permitted in any medium without royalty provided the copyright
105 notice and this notice are preserved.  This file is offered as-is,
106 without warranty of any kind.