mir/openvswitch
2
0
Fork 0
mirror of https://github.com/openvswitch/ovs synced 2025-10-29 15:28:56 +00:00
Code Issues Releases Wiki Activity
Files
29d935d631c522c5e5915d6c0cb9a8af3a1f2390
openvswitch/INSTALL.XenServer

144 lines
6.0 KiB
Plaintext
Raw Normal View History

Update documentation.
2009-06-09 13:09:08 -07:00
How to Install Open vSwitch on Citrix XenServer
===============================================
This document describes how to build and install Open vSwitch on a
xenserver: Avoid "rpm -i" warnings on XenServer 5.5.900. Open vSwitch installs successfully on XenServer 5.5.900 but it prints some worrying messages during the process. This commit fixes them.
2009-09-08 13:18:13 -07:00
Citrix XenServer host. If you want to install Open vSwitch on a
Update documentation.
2009-06-09 13:09:08 -07:00
generic Linux host, see INSTALL.Linux instead.
xenserver: Merge upstream changes and drop pre-5.6.100 support. Citrix have made modifications to the various interface configuration scripts that OVS replaces, so at present those modifications are lost when OVS is installed on e.g. XenServer 5.6.100. This commit applies those changes while preserving OVS-specific modifications that have been made in the interim. One major change introduced by these updates is the removal of support for XenServer releases prior to 5.6.100. This commit also updates the OVS-supplied xen-bugtool in similar fashion. We will soon remove xen-bugtool from OVS altogether and move the added OVS functionality to an XML extension as described in the Supplemental Pack DDK guide.
2011-02-10 16:50:49 -08:00
These instructions have been tested with XenServer 5.6 FP1.
xenserver: Avoid "rpm -i" warnings on XenServer 5.5.900. Open vSwitch installs successfully on XenServer 5.5.900 but it prints some worrying messages during the process. This commit fixes them.
2009-09-08 13:18:13 -07:00
Update documentation.
2009-06-09 13:09:08 -07:00
Building Open vSwitch for XenServer
-----------------------------------
The recommended build environment to build RPMs for Citrix XenServer
is the DDK VM available from Citrix. If you are building from an Open
vSwitch distribution tarball, this VM has all the tools that you will
need. If you are building from an Open vSwitch Git tree, then you
will need to first create a distribution tarball elsewhere, by running
"./boot.sh; ./configure; make dist" in the Git tree, because the DDK
VM does not include Autoconf or Automake that are required to
bootstrap the Open vSwitch distribution.
Once you have a distribution tarball, copy it into
/usr/src/redhat/SOURCES inside the VM. Then execute the following:
VERSION=<Open vSwitch version>
XENKERNEL=<Xen kernel version>
cd /tmp
tar xfz /usr/src/redhat/SOURCES/openvswitch-$VERSION.tar.gz
rpmbuild \
Cleanup default file locations and XenServer packaging This commit cleans up the locations of a number of files and directories used. These include: - Config file lives in /etc/openvswitch/conf.db - Logs go into /var/log/openvswitch - ovsdb-server socket is /var/run/openvswitch/db.sock - Schema goes into /usr/share/openvswitch/vswitch.ovsschema - PID files go in /var/run/openvswitch For XenServer, these additional changes are made: - Cores go in /var/xen/openvswitch - OVS binaries run in /var/xen/openvswitch In addition, it attempts to cleanup the XenServer packaging. This includes referring to the project as "openvswitch" as opposed to the somewhat presumptuous "vswitch". Note: Changes to the Debian packaging will be forthcoming.
2010-03-25 22:38:13 -07:00
-D "openvswitch_version $VERSION" \
Update documentation.
2009-06-09 13:09:08 -07:00
-D "xen_version $XENKERNEL" \
Cleanup default file locations and XenServer packaging This commit cleans up the locations of a number of files and directories used. These include: - Config file lives in /etc/openvswitch/conf.db - Logs go into /var/log/openvswitch - ovsdb-server socket is /var/run/openvswitch/db.sock - Schema goes into /usr/share/openvswitch/vswitch.ovsschema - PID files go in /var/run/openvswitch For XenServer, these additional changes are made: - Cores go in /var/xen/openvswitch - OVS binaries run in /var/xen/openvswitch In addition, it attempts to cleanup the XenServer packaging. This includes referring to the project as "openvswitch" as opposed to the somewhat presumptuous "vswitch". Note: Changes to the Debian packaging will be forthcoming.
2010-03-25 22:38:13 -07:00
-bb openvswitch-$VERSION/xenserver/openvswitch-xen.spec
Update documentation.
2009-06-09 13:09:08 -07:00
where:
<openvswitch version> is the version number that appears in the
name of the Open vSwitch tarball, e.g. 0.90.0.
<Xen kernel version> is the version number of the Xen kernel,
xenserver: Merge upstream changes and drop pre-5.6.100 support. Citrix have made modifications to the various interface configuration scripts that OVS replaces, so at present those modifications are lost when OVS is installed on e.g. XenServer 5.6.100. This commit applies those changes while preserving OVS-specific modifications that have been made in the interim. One major change introduced by these updates is the removal of support for XenServer releases prior to 5.6.100. This commit also updates the OVS-supplied xen-bugtool in similar fashion. We will soon remove xen-bugtool from OVS altogether and move the added OVS functionality to an XML extension as described in the Supplemental Pack DDK guide.
2011-02-10 16:50:49 -08:00
e.g. 2.6.32.12-0.7.1.xs5.6.100.307.170586xen. This version number
Update documentation.
2009-06-09 13:09:08 -07:00
appears as the name of a directory in /lib/modules inside the VM.
It always ends in "xen".
xenserver: Split kernel/userspace into separate RPMs for supplemental packs. XenServer has the concept of a "supplemental pack", which is just a collection of RPMs rolled into an ISO image for installation as a unit, either during XenServer installation or later as an update. The script used to build supplemental packs requires that a single RPM not mix kernel and userspace components. It also enforces a particular naming scheme for kernel module RPMs. This commit modifies the OVS RPM spec file to create separate RPMs in accordance with these conventions. In an attempt to ensure that the userspace and kernel module packages are both present and compatible, the kernel package provides a fictitious capability, openvswitch_mod.ko.0, and the userspace package requires that capability. If a future change breaks backward compatibility between userspace and kernel, we'll increment the numeric suffix, preventing mismatched installs. Reviewed by Ben Pfaff.
2011-02-16 22:40:46 -08:00
Three RPMs will be output into /usr/src/redhat/RPMS/i386, whose names begin
with "openvswitch", "openvswitch-modules-xen", and "openvswitch-debuginfo".
Update documentation.
2009-06-09 13:09:08 -07:00
Installing Open vSwitch for XenServer
-------------------------------------
xenserver: Split kernel/userspace into separate RPMs for supplemental packs. XenServer has the concept of a "supplemental pack", which is just a collection of RPMs rolled into an ISO image for installation as a unit, either during XenServer installation or later as an update. The script used to build supplemental packs requires that a single RPM not mix kernel and userspace components. It also enforces a particular naming scheme for kernel module RPMs. This commit modifies the OVS RPM spec file to create separate RPMs in accordance with these conventions. In an attempt to ensure that the userspace and kernel module packages are both present and compatible, the kernel package provides a fictitious capability, openvswitch_mod.ko.0, and the userspace package requires that capability. If a future change breaks backward compatibility between userspace and kernel, we'll increment the numeric suffix, preventing mismatched installs. Reviewed by Ben Pfaff.
2011-02-16 22:40:46 -08:00
To install Open vSwitch on a XenServer host, or to upgrade to a newer version,
copy the "openvswitch" and "openvswitch-modules-xen" RPMs to that host with
"scp", then install them with "rpm -U", e.g.:
Update documentation.
2009-06-09 13:09:08 -07:00
xenserver: Split kernel/userspace into separate RPMs for supplemental packs. XenServer has the concept of a "supplemental pack", which is just a collection of RPMs rolled into an ISO image for installation as a unit, either during XenServer installation or later as an update. The script used to build supplemental packs requires that a single RPM not mix kernel and userspace components. It also enforces a particular naming scheme for kernel module RPMs. This commit modifies the OVS RPM spec file to create separate RPMs in accordance with these conventions. In an attempt to ensure that the userspace and kernel module packages are both present and compatible, the kernel package provides a fictitious capability, openvswitch_mod.ko.0, and the userspace package requires that capability. If a future change breaks backward compatibility between userspace and kernel, we'll increment the numeric suffix, preventing mismatched installs. Reviewed by Ben Pfaff.
2011-02-16 22:40:46 -08:00
scp openvswitch-$VERSION-1.i386.rpm \
openvswitch-modules-xen-$XEN_KERNEL_VERSION-$VERSION-1.i386.rpm \
root@<host>:
(At this point you will have to enter <host>'s root password.)
Update documentation.
2009-06-09 13:09:08 -07:00
ssh root@<host>
xenserver: Split kernel/userspace into separate RPMs for supplemental packs. XenServer has the concept of a "supplemental pack", which is just a collection of RPMs rolled into an ISO image for installation as a unit, either during XenServer installation or later as an update. The script used to build supplemental packs requires that a single RPM not mix kernel and userspace components. It also enforces a particular naming scheme for kernel module RPMs. This commit modifies the OVS RPM spec file to create separate RPMs in accordance with these conventions. In an attempt to ensure that the userspace and kernel module packages are both present and compatible, the kernel package provides a fictitious capability, openvswitch_mod.ko.0, and the userspace package requires that capability. If a future change breaks backward compatibility between userspace and kernel, we'll increment the numeric suffix, preventing mismatched installs. Reviewed by Ben Pfaff.
2011-02-16 22:40:46 -08:00
(At this point you will have to enter <host>'s root password again.)
rpm -U openvswitch-$VERSION-1.i386.rpm \
openvswitch-modules-xen-$XEN_KERNEL_VERSION-$VERSION-1.i386.rpm
Update documentation.
2009-06-09 13:09:08 -07:00
xenserver: Split kernel/userspace into separate RPMs for supplemental packs. XenServer has the concept of a "supplemental pack", which is just a collection of RPMs rolled into an ISO image for installation as a unit, either during XenServer installation or later as an update. The script used to build supplemental packs requires that a single RPM not mix kernel and userspace components. It also enforces a particular naming scheme for kernel module RPMs. This commit modifies the OVS RPM spec file to create separate RPMs in accordance with these conventions. In an attempt to ensure that the userspace and kernel module packages are both present and compatible, the kernel package provides a fictitious capability, openvswitch_mod.ko.0, and the userspace package requires that capability. If a future change breaks backward compatibility between userspace and kernel, we'll increment the numeric suffix, preventing mismatched installs. Reviewed by Ben Pfaff.
2011-02-16 22:40:46 -08:00
To uninstall Open vSwitch from a XenServer host, remove the packages:
Update documentation.
2009-06-09 13:09:08 -07:00
ssh root@<host>
xenserver: Split kernel/userspace into separate RPMs for supplemental packs. XenServer has the concept of a "supplemental pack", which is just a collection of RPMs rolled into an ISO image for installation as a unit, either during XenServer installation or later as an update. The script used to build supplemental packs requires that a single RPM not mix kernel and userspace components. It also enforces a particular naming scheme for kernel module RPMs. This commit modifies the OVS RPM spec file to create separate RPMs in accordance with these conventions. In an attempt to ensure that the userspace and kernel module packages are both present and compatible, the kernel package provides a fictitious capability, openvswitch_mod.ko.0, and the userspace package requires that capability. If a future change breaks backward compatibility between userspace and kernel, we'll increment the numeric suffix, preventing mismatched installs. Reviewed by Ben Pfaff.
2011-02-16 22:40:46 -08:00
(At this point you will have to enter <host>'s root password again.)
rpm -e openvswitch openvswitch-modules-xen-$XEN_KERNEL_VERSION
Update documentation.
2009-06-09 13:09:08 -07:00
After installing or uninstalling Open vSwitch, the XenServer should be
rebooted as soon as possible.
INSTALL.XenServer: Document Open vSwitch boot process on XenServer. Inspired by a conversation with David Erickson <derickso@stanford.edu>.
2011-05-10 09:15:44 -07:00
Open vSwitch Boot Sequence on XenServer
---------------------------------------
When Open vSwitch is installed on XenServer, its startup script
/etc/init.d/openvswitch runs early in boot. It does roughly the
following:
* Loads the OVS kernel module, openvswitch_mod.
* Starts ovsdb-server, the OVS configuration database.
* XenServer expects there to be no bridges configured at
startup, but the OVS configuration database likely still has
bridges configured from before reboot. To match XenServer
expectations, the startup script deletes all configured
bridges from the database.
* Starts ovs-vswitchd, the OVS switching daemon.
At this point in the boot process, then, there are no Open vSwitch
bridges, even though all of the Open vSwitch daemons are running.
Later on in boot, /etc/init.d/management-interface (part of XenServer,
not Open vSwitch) creates the bridge for the XAPI management interface
by invoking /opt/xensource/libexec/interface-reconfigure. Normally
this program consults XAPI's database to obtain information about how
to configure the bridge, but XAPI is not running yet[*] so it instead
consults /var/xapi/network.dbcache, which is a cached copy of the most
recent network configuration.
[*] Even if XAPI were running, if this XenServer node is a pool slave
then the query would have to consult the master, which requires
network access, which begs the question of how to configure the
management interface.
XAPI starts later on in the boot process. XAPI can then create other
bridges on demand using /opt/xensource/libexec/interface-reconfigure.
Now that XAPI is running, that program consults XAPI directly instead
of reading the cache.
As part of its own startup, XAPI invokes the Open vSwitch XAPI plugin
script /etc/xapi.d/openvswitch-cfg-update passing the "update"
command. The plugin script does roughly the following:
* Calls /opt/xensource/libexec/interface-reconfigure with the
"rewrite" command, to ensure that the network cache is
up-to-date.
* Queries the Open vSwitch manager setting (named
"vswitch_controller") from the XAPI database for the
XenServer pool.
* If XAPI and OVS are configured for different managers, or if
OVS is configured for a manager but XAPI is not, runs
"ovs-vsctl emer-reset" to bring the Open vSwitch
configuration to a known state. One effect of emer-reset is
to deconfigure any manager from the OVS database.
* If XAPI is configured for a manger, configures the OVS
manager to match with "ovs-vsctl set-manager".
The Open vSwitch boot sequence only configures an OVS configuration
database manager. There is no way to directly configure an OpenFlow
controller on XenServer and, as a consequence of the step above that
deletes all of the bridges at boot time, controller configuration only
persists until XenServer reboot. The configuration database manager
can, however, configure controllers for bridges. See the BUGS section
of ovs-controller(8) for more information on this topic.
Update documentation.
2009-06-09 13:09:08 -07:00
Reporting Bugs
--------------
Adjust Open vSwitch mailing lists to reflect reality We've gone through a couple of iterations for names of these mailing lists. Currently, there are three: announce, discuss, and git. There are aliases that point "bugs" and "dev" to the "discuss" mailing list. This commit drops the "ovs-" prefix to mailing lists, since we're not using them.
2009-06-25 00:36:42 -07:00
Please report problems to bugs@openvswitch.org.
Reference in New Issue Copy Permalink