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_scripts_vif
  38
  39         Open vSwitch-aware replacement for Citrix script of the same name.
  40
  41     openvswitch-xen.spec
  42
  43         spec file for building RPMs to install on a XenServer host.
  44
  45     opt_xensource_libexec_interface-reconfigure
  46
  47         Open vSwitch-aware replacement for Citrix script of the same name.
  48
  49     usr_share_openvswitch_scripts_ovs-external-ids
  50
  51         Daemon to monitor the external_ids columns of the Bridge and
  52         Interface OVSDB tables.
  53
  54     usr_share_openvswitch_scripts_refresh-xs-network-uuids
  55
  56         Script to refresh Bridge table external-ids:xs-network-uuids
  57         values, which can get out-of-sync following a pool join.
  58
  59     usr_share_openvswitch_scripts_sysconfig.template
  60
  61         Template for Open vSwitch's /etc/sysconfig/openvswitch
  62         configuration file.
  63
  64     usr_lib_xsconsole_plugins-base_XSFeatureVSwitch.py
  65
  66         xsconsole plugin to configure the pool-wide configuration keys
  67         used to control Open vSwitch when integrated with Citrix
  68         management tools.
  69
  70     usr_sbin_brctl
  71
  72         wrapper for /usr/sbin/brctl that provides some additional
  73         bridge compatibility
  74
  75     usr_sbin_xen-bugtool
  76
  77         Open vSwitch-aware replacement for Citrix script of the same name.
  78
  79     uuid.py
  80
  81         This is uuid.py from Python 2.5.  It is installed into the
  82         Open vSwitch RPM because XenServer 5.5 and 5.6 use Python 2.4,
  83         which do not have uuid.py.
  84
  85 To install, build the Open vSwitch RPM with a command like this:
  86
  87         rpmbuild -D "openvswitch_version $full_version" \
  88                 -D "xen_version $XENKERNEL" \
  89                 -D "build_number --with-build-number=$buildnr" \
  90                 -bb openvswitch-xen.spec
  91
  92 Then, "rpm -U" the resulting Open vSwitch package on the XenServer hosts in
  93 question and reboot them.  (The openvswitch-dbg package that is also
  94 produced need not be installed, but it is harmless to do so.)
  95
  96 ----------------------------------------------------------------------
  97 Copyright (C) 2009, 2010 Nicira Networks, Inc.
  98
  99 Copying and distribution of this file, with or without modification,
 100 are permitted in any medium without royalty provided the copyright
 101 notice and this notice are preserved.  This file is offered as-is,
 102 without warranty of any kind.