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_bugtool_system-configuration.xml
  49
  50         Custom xen-bugtool category to collect system configuration data.
  51         This category is configured to collect up to 1Mb of data, take
  52         up to 60 seconds to collect data, run every time and is hidden from
  53         display in xencenter.
  54
  55     etc_xensource_bugtool_system-configuration_openvswitch.xml
  56
  57         xen-bugtool extension to collect system configuration information
  58         relevant to Open vSwitch, including timezone.
  59
  60     etc_xensource_scripts_vif
  61
  62         Open vSwitch-aware replacement for Citrix script of the same name.
  63
  64     openvswitch-xen.spec
  65
  66         spec file for building RPMs to install on a XenServer host.
  67
  68     opt_xensource_libexec_interface-reconfigure
  69
  70         Open vSwitch-aware replacement for Citrix script of the same name.
  71
  72     usr_share_openvswitch_scripts_ovs-xapi-sync
  73
  74         Daemon to monitor the external_ids columns of the Bridge and
  75         Interface OVSDB tables for changes that require interrogating
  76         XAPI.
  77
  78     usr_share_openvswitch_scripts_sysconfig.template
  79
  80         Template for Open vSwitch's /etc/sysconfig/openvswitch
  81         configuration file.
  82
  83     usr_share_openvswitch_scripts_xen-bugtool-tc-class-show
  84
  85         Script to dump tc class configuration for all network
  86         interfaces. Intended to be run by xen-bugtool via
  87         etc_xensource_bugtool_network-status_openvswitch.xml.
  88
  89     usr_lib_xsconsole_plugins-base_XSFeatureVSwitch.py
  90
  91         xsconsole plugin to configure the pool-wide configuration keys
  92         used to control Open vSwitch when integrated with Citrix
  93         management tools.
  94
  95 To install, build the Open vSwitch RPM with a command like this:
  96
  97         rpmbuild -D "openvswitch_version $full_version" \
  98                 -D "xen_version $XENKERNEL" \
  99                 -D "build_number --with-build-number=$buildnr" \
 100                 -bb openvswitch-xen.spec
 101
 102 Then, "rpm -U" the resulting Open vSwitch package on the XenServer hosts in
 103 question and reboot them.  (The openvswitch-dbg package that is also
 104 produced need not be installed, but it is harmless to do so.)
 105
 106 ----------------------------------------------------------------------
 107 Copyright (C) 2009, 2010, 2011 Nicira Networks, Inc.
 108
 109 Copying and distribution of this file, with or without modification,
 110 are permitted in any medium without royalty provided the copyright
 111 notice and this notice are preserved.  This file is offered as-is,
 112 without warranty of any kind.