xenserver: Add support for disabling in-band management via XAPI.

[mirror_ovs.git] / xenserver / README

This directory contains files for seamless integration of Open vSwitch on
Citrix XenServer hosts managed by the Citrix management tools.

Files in this directory are licensed on a file-by-file basis.  Please
refer to each file for details.

Most of the files in this directory is installed on a XenServer system
under the same name, if underscores are replaced by slashes.  The
files are:

    etc_init.d_openvswitch

        Initializes Open vSwitch at boot and shuts it down at shutdown.

    etc_init.d_openvswitch-xapi-update

        Init script to ensure openvswitch-cfg-update is called for the
        current host at boot.

    etc_logrotate.d_openvswitch

        Ensures that logs in /var/log/openvswitch are rotated
        periodically and that appropriate daemons reopen their log
        files at that point.

    etc_profile.d_openvswitch.sh

        Open vSwitch-related shell functions for the administrator's
        convenience.

    etc_xapi.d_plugins_openvswitch-cfg-update

        xapi plugin script to update the cache of configuration items
        in the ovs-vswitchd configuration that are managed in the
        xapi database when integrated with Citrix management tools.

    etc_xensource_bugtool_network-status_openvswitch.xml

        xen-bugtool extension to collect networking information relevant to
        Open vSwitch. Runs
        usr_share_openvswitch_scripts_xen-bugtool-tc-class-show.

    etc_xensource_scripts_vif

        Open vSwitch-aware replacement for Citrix script of the same name.

    openvswitch-xen.spec

        spec file for building RPMs to install on a XenServer host.

    opt_xensource_libexec_interface-reconfigure

        Open vSwitch-aware replacement for Citrix script of the same name.

    usr_share_openvswitch_scripts_ovs-xapi-sync

        Daemon to monitor the external_ids columns of the Bridge and
        Interface OVSDB tables for changes that require interrogating
        XAPI.

    usr_share_openvswitch_scripts_sysconfig.template

        Template for Open vSwitch's /etc/sysconfig/openvswitch 
        configuration file.

    usr_share_openvswitch_scripts_xen-bugtool-tc-class-show

        Script to dump tc class configuration for all network
        interfaces. Intended to be run by xen-bugtool via
        etc_xensource_bugtool_network-status_openvswitch.xml.

    usr_lib_xsconsole_plugins-base_XSFeatureVSwitch.py

        xsconsole plugin to configure the pool-wide configuration keys
        used to control Open vSwitch when integrated with Citrix 
        management tools.

    uuid.py

        This is uuid.py from Python 2.5.  It is installed into the
        Open vSwitch RPM because XenServer uses Python 2.4, which does
        not have uuid.py.

To install, build the Open vSwitch RPM with a command like this:

        rpmbuild -D "openvswitch_version $full_version" \
                -D "xen_version $XENKERNEL" \
                -D "build_number --with-build-number=$buildnr" \
                -bb openvswitch-xen.spec

Then, "rpm -U" the resulting Open vSwitch package on the XenServer hosts in
question and reboot them.  (The openvswitch-dbg package that is also
produced need not be installed, but it is harmless to do so.)

----------------------------------------------------------------------
Copyright (C) 2009, 2010, 2011 Nicira Networks, Inc.

Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.  This file is offered as-is,
without warranty of any kind.