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