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_refresh-network-uuids
  53
  54         Script to refresh bridge.<bridge>.network-uuids keys, which
  55         can get out-of-sync following a pool join.  Running this script
  56         is an alternative to rebooting the host.
  57
  58     usr_share_openvswitch_scripts_sysconfig.template
  59
  60         Template for Open vSwitch's /etc/sysconfig/openvswitch
  61         configuration file.
  62
  63     usr_lib_xsconsole_plugins-base_XSFeatureVSwitch.py
  64
  65         xsconsole plugin to configure the pool-wide configuration keys
  66         used to control Open vSwitch when integrated with Citrix
  67         management tools.
  68
  69     usr_sbin_brctl
  70
  71         wrapper for /usr/sbin/brctl that provides some additional
  72         bridge compatibility
  73
  74     usr_sbin_xen-bugtool
  75
  76         Open vSwitch-aware replacement for Citrix script of the same name.
  77
  78 To install, build the Open vSwitch RPM with a command like this:
  79
  80         rpmbuild -D "openvswitch_version $full_version" \
  81                 -D "xen_version $XENKERNEL" \
  82                 -D "build_number --with-build-number=$buildnr" \
  83                 -bb openvswitch-xen.spec
  84
  85 Then, "rpm -U" the resulting Open vSwitch package on the XenServer hosts in
  86 question and reboot them.  (The openvswitch-dbg package that is also
  87 produced need not be installed, but it is harmless to do so.)
  88
  89 ----------------------------------------------------------------------
  90 Copyright (C) 2009, 2010 Nicira Networks, Inc.
  91
  92 Copying and distribution of this file, with or without modification,
  93 are permitted in any medium without royalty provided the copyright
  94 notice and this notice are preserved.  This file is offered as-is,
  95 without warranty of any kind.