xenserver/README.rst

   1 ..
   2       Copyright (C) 2009, 2010, 2011 Nicira, Inc.
   3
   4       Licensed under the Apache License, Version 2.0 (the "License"); you may
   5       not use this file except in compliance with the License. You may obtain
   6       a copy of the License at
   7
   8           http://www.apache.org/licenses/LICENSE-2.0
   9
  10       Unless required by applicable law or agreed to in writing, software
  11       distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  12       WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  13       License for the specific language governing permissions and limitations
  14       under the License.
  15
  16       Convention for heading levels in Open vSwitch documentation:
  17
  18       =======  Heading 0 (reserved for the title in a document)
  19       -------  Heading 1
  20       ~~~~~~~  Heading 2
  21       +++++++  Heading 3
  22       '''''''  Heading 4
  23
  24       Avoid deeper levels because they do not render well.
  25
  26 ================
  27 XenServer README
  28 ================
  29
  30 This directory contains files for seamless integration of Open vSwitch on
  31 Citrix XenServer hosts managed by the Citrix management tools.
  32
  33 Files in this directory are licensed on a file-by-file basis.  Refer to each
  34 file for details.
  35
  36 Most of the files in this directory are installed on a XenServer system under
  37 the same name; underscores are replaced by slashes.  The files are:
  38
  39 etc_init.d_openvswitch
  40   Initializes Open vSwitch at boot and shuts it down at shutdown.
  41
  42 etc_init.d_openvswitch-xapi-update
  43   Init script to ensure openvswitch-cfg-update is called for the current host
  44   at boot.
  45
  46 etc_logrotate.d_openvswitch
  47   Ensures that logs in /var/log/openvswitch are rotated periodically and that
  48   appropriate daemons reopen their log files at that point.
  49
  50 etc_profile.d_openvswitch.sh
  51   Open vSwitch-related shell functions for the administrator's convenience.
  52
  53 etc_xapi.d_plugins_openvswitch-cfg-update
  54   xapi plugin script to update the cache of configuration items in the
  55   ovs-vswitchd configuration that are managed in the xapi database when
  56   integrated with Citrix management tools.
  57
  58 etc_xensource_scripts_vif
  59   Open vSwitch-aware replacement for Citrix script of the same name.
  60
  61 openvswitch-xen.spec
  62   spec file for building RPMs to install on a XenServer host.
  63
  64 opt_xensource_libexec_interface-reconfigure
  65    Open vSwitch-aware replacements for Citrix script of the same names.
  66
  67 opt_xensource_libexec_InterfaceReconfigureBridge.py
  68   See above.
  69
  70 opt_xensource_libexec_InterfaceReconfigure.py
  71   See above.
  72
  73 opt_xensource_libexec_InterfaceReconfigureVswitch.py
  74   See above.
  75
  76 usr_lib_xsconsole_plugins-base_XSFeatureVSwitch.py
  77   xsconsole plugin to configure the pool-wide configuration keys used to
  78   control Open vSwitch when integrated with Citrix management tools.
  79
  80 usr_share_openvswitch_scripts_ovs-xapi-sync
  81   Daemon to monitor the external_ids columns of the Bridge and Interface OVSDB
  82   tables for changes that require interrogating XAPI.
  83
  84 usr_share_openvswitch_scripts_sysconfig.template
  85   Template for Open vSwitch's /etc/sysconfig/openvswitch configuration file.
  86
  87 Open vSwitch installs a number of xen-bugtool extensions in
  88 ``/etc/xensource/bugtool`` to gather additional information useful for
  89 debugging.  The sources for the extensions are in
  90 ``../utilities/bugtool/plugins``:
  91
  92 kernel-info/openvswitch.xml
  93   Collect kernel information relevant to Open vSwitch, such as slabinfo.
  94
  95 network-status/openvswitch.xml
  96   Collect networking information relevant to Open vSwitch.  Runs the following
  97   scripts, which are described below:
  98
  99   * ovs-bugtool-bfd-show
 100   * ovs-bugtool-cfm-show
 101   * ovs-bugtool-fdb-show
 102   * ovs-bugtool-lacp-show
 103   * ovs-bugtool-list-dbs
 104   * ovs-bugtool-ovsdb-dump
 105   * ovs-bugtool-tc-class-show
 106   * ovs-bugtool-bond-show
 107   * ovs-bugtool-ovs-ofctl-show
 108   * ovs-bugtool-ovs-ofctl-dump-flows
 109   * ovs-bugtool-ovs-appctl-dpif
 110   * ovs-bugtool-coverage-show
 111   * ovs-bugtool-memory-show
 112   * ovs-bugtool-vsctl-show
 113   * ovs-bugtool-conntrack-dump
 114
 115 system-configuration/openvswitch.xml
 116   Collect system configuration information relevant to Open vSwitch, including
 117   timezone. Runs the following script which is described below:
 118
 119   * ovs-bugtool-daemons-ver
 120
 121 system-configuration.xml
 122   Collect system configuration data.  This category is configured to collect up
 123   to 1Mb of data, take up to 60 seconds to collect data, run every time and is
 124   hidden from display in XenCenter.
 125
 126 A number of scripts are installed in ``/usr/share/openvswitch/scripts`` to
 127 assist Open vSwitch's xen-bugtool extensions.  The sources for the scripts are
 128 located in ``../utilities/bugtool``:
 129
 130 ovs-bugtool-bfd-show
 131   Script to dump detailed BFD information for all enabled interfaces.
 132
 133 ovs-bugtool-cfm-show
 134   Script to dump detailed CFM information for all enabled interfaces.
 135
 136 ovs-bugtool-fdb-show
 137   Script to collect a summary of learned MACs for each bridge.
 138
 139 ovs-bugtool-lacp-show
 140   Script to dump detailed LACP information for all enabled ports.
 141
 142 ovs-bugtool-list-dbs
 143   Script to list the databases controlled by ovsdb-server.
 144
 145 ovs-bugtool-ovsdb-dump
 146   Script to dump contents of Open vSwitch configuration database in
 147   comma-separated value format.
 148
 149 ovs-bugtool-tc-class-show
 150   Script to dump tc class configuration for all network interfaces.
 151
 152 ovs-bugtool-ovs-ofctl-show
 153   Script to dump information about flow tables and ports of each bridge.
 154
 155 ovs-bugtool-ovs-ofctl-dump-flows
 156   Script to dump openflow flows of each bridge.
 157
 158 ovs-bugtool-ovs-appctl-dpif
 159   Script to collect a summary of configured datapaths and datapath flows.
 160
 161 ovs-bugtool-coverage-show
 162   Script to count the number of times particular events occur during
 163   ovs-vswitchd's runtime.
 164
 165 ovs-bugtool-memory-show
 166   Script to show some basic statistics about ovs-vswitchd's memory usage.
 167
 168 ovs-bugtool-vsctl-show
 169   Script to show a brief overview of the database contents.
 170
 171 ovs-bugtool-conntrack-dump
 172   Script to show all the connection entries in the tracker.
 173
 174 ovs-bugtool-daemons-ver
 175   Script to dump version information for all Open vSwitch daemons.