If you are using GitHub, then you may utilize the travis-ci.org CI build
system by linking your GitHub repository to it. This will run some of
the above tests automatically when you push changes to your repository.
-See the "Continuous Integration with Travis-CI" in the [INSTALL](INSTALL.md)
-file for details on how to set it up.
+See the "Continuous Integration with Travis-CI" in the [INSTALL.md] file
+for details on how to set it up.
Email Subject
-------------
sending the patch as an attachment is a second choice.
Please follow the style used in the code that you are modifying. The
-[CodingStyle](CodingStyle.md) file describes the coding style used in
-most of Open vSwitch. Use Linux kernel coding style for Linux kernel code.
+[CodingStyle.md] file describes the coding style used in most of Open
+vSwitch. Use Linux kernel coding style for Linux kernel code.
Example
-------
1.7.7.3
```
+[INSTALL.md]:INSTALL.md
+[CodingStyle.md]:CodingStyle.md
### Q: What's involved with porting Open vSwitch to a new platform or switching ASIC?
-A: The [PORTING](PORTING.md) document describes how one would go about
+A: The [PORTING.md] document describes how one would go about
porting Open vSwitch to a new operating system or hardware platform.
### Q: Why would I use Open vSwitch instead of the Linux bridge?
A: Open vSwitch is specially designed to make it easier to manage VM
network configuration and monitor state spread across many physical
hosts in dynamic virtualized environments. Please see
- [WHY-OVS](WHY-OVS.md) for a more detailed description of how Open
- vSwitch relates to the Linux Bridge.
+ [WHY-OVS.md] for a more detailed description of how Open vSwitch
+ relates to the Linux Bridge.
### Q: How is Open vSwitch related to distributed virtual switches like the VMware vNetwork distributed switch or the Cisco Nexus 1000V?
dmesg for errors regarding GRE registration). To fix this, unload all
GRE modules that appear in lsmod as well as the OVS kernel module. You
can then reload the OVS module following the directions in
- [INSTALL](INSTALL.md), which will ensure that dependencies are satisfied.
+ [INSTALL.md], which will ensure that dependencies are satisfied.
### Q: Open vSwitch does not seem to obey my packet filter rules.
(Open vSwitch 2.2 had an experimental implementation of OpenFlow
1.4 that could cause crashes. We don't recommend enabling it.)
- OPENFLOW-1.1+ in the Open vSwitch source tree tracks support for
+ [OPENFLOW-1.1+.md] in the Open vSwitch source tree tracks support for
OpenFlow 1.1 and later features. When support for OpenFlow 1.4 and
1.5 is solidly implemented, Open vSwitch will enable those version
by default. Also, the OpenFlow 1.5 specification is still under
lib/ofp-msgs.h, following the existing pattern. Then recompile and
fix all of the new warnings, implementing new functionality for the
new message as needed. (If you configure with --enable-Werror, as
- described in [INSTALL](INSTALL.md), then it is impossible to miss
- any warnings.)
+ described in [INSTALL.md], then it is impossible to miss any warnings.)
If you need to add an OpenFlow vendor extension message for a
vendor that doesn't yet have any extension messages, then you will
bugs@openvswitch.org
http://openvswitch.org/
+
+[PORTING.md]:PORTING.md
+[WHY-OVS.md]:WHY-OVS.md
+[INSTALL.md]:INSTALL.md
+[OPENFLOW-1.1+.md]:OPENFLOW-1.1+.md
`make CFLAGS='-O3 -march=native'`
-Refer to [INSTALL.userspace](INSTALL.userspace.md) for general requirements of
-building userspace OVS.
+Refer to [INSTALL.userspace.md] for general requirements of building userspace OVS.
Using the DPDK with ovs-vswitchd:
---------------------------------
Ref to http://www.dpdk.org/doc/quick-start for verifying DPDK setup.
-4. Start ovsdb-server as discussed in [INSTALL](INSTALL.md) doc:
+4. Start ovsdb-server as discussed in [INSTALL.md] doc:
1. First time only db creation (or clearing):
```
--------------
Please report problems to bugs@openvswitch.org.
+
+[INSTALL.userspace.md]:INSTALL.userspace.md
+[INSTALL.md]:INSTALL.md
This document describes how to build Debian packages for Open vSwitch.
To install Open vSwitch on Debian without building Debian packages,
-see [INSTALL](INSTALL.md) instead.
+see [INSTALL.md] instead.
These instructions should also work on Ubuntu and other Debian
derivative distributions.
Please report problems to bugs@openvswitch.org.
+[INSTALL.md]:INSTALL.md
====================================
This document describes how to use Open vSwitch with Docker 1.2.0 or
-later. This document assumes that you followed [INSTALL](INSTALL.md)
-or installed Open vSwitch from distribution packaging such as a .deb
-or .rpm. Consult www.docker.com for instructions on how to install
-Docker.
+later. This document assumes that you followed [INSTALL.md] or installed
+Open vSwitch from distribution packaging such as a .deb or .rpm. Consult
+www.docker.com for instructions on how to install or .rpm. Consult
+www.docker.com for instructions on how to install Docker.
Limitations
-----------
-------------
Please report problems to bugs@openvswitch.org.
+
+[INSTALL.md]:INSTALL.md
This document describes how to build and install Open vSwitch on a Fedora
Linux host. If you want to install Open vSwitch on a generic Linux host,
-see [INSTALL.Linux](INSTALL.Linux.md) instead.
+see [INSTALL.md] instead.
We have tested these instructions with Fedora 16 and Fedora 17.
--------------
Please report problems to bugs@openvswitch.org.
+
+[INSTALL.md]:INSTALL.md
This document describes how to use Open vSwitch with the Kernel-based
Virtual Machine (KVM). This document assumes that you have read and
-followed [INSTALL](INSTALL.md) to get Open vSwitch setup on your Linux
-system.
+followed [INSTALL.md] to get Open vSwitch setup on your Linux system.
Setup
-----
-First, follow the setup instructions in [INSTALL](INSTALL.md) to get a
-working Open vSwitch installation.
+First, follow the setup instructions in [INSTALL.md] to get a working
+Open vSwitch installation.
KVM uses tunctl to handle various bridging modes, which you can
install with the Debian/Ubuntu package uml-utilities.
ovs-vsctl del-port ${switch} $1
```
-At the end of [INSTALL](INSTALL.md), it describes basic usage of creating
+At the end of [INSTALL.md], it describes basic usage of creating
bridges and ports. If you haven't already, create a bridge named
br0 with the following command:
-------------
Please report problems to bugs@openvswitch.org.
+
+[INSTALL.md]:INSTALL.md
====================================
This document describes how to use Open vSwitch with Libvirt 0.9.11 or
-later. This document assumes that you followed INSTALL or installed
-Open vSwitch from distribution packaging such as a .deb or .rpm. The Open
+later. This document assumes that you followed [INSTALL.md] or installed
+Open vSwitch from distribution packaging such as a .deb or .rpm. The Open
vSwitch support is included by default in Libvirt 0.9.11. Consult
www.libvirt.org for instructions on how to build the latest Libvirt, if your
Linux distribution by default comes with an older Libvirt release.
-------------
Please report problems to bugs@openvswitch.org.
+
+[INSTALL.md]:INSTALL.md
* py27-xml
* pkg_alternatives
-Some components have additional requirements. (See [INSTALL](INSTALL.md))
+Some components have additional requirements. (See [INSTALL.md])
Assuming you are running NetBSD/amd64 6.1.2, you can download and
install pre-built binary packages as the following.
directory, it might be a good idea to add it to your PATH.
Open vSwitch on NetBSD is currently "userspace switch" implementation
-in the sense described in INSTALL.userspace and PORTING.
+in the sense described in [INSTALL.userspace.md] and [PORTING.md].
+
+[INSTALL.md]:INSTALL.md
+[INSTALL.userspace.md]:INSTALL.userspace.md
+[PORTING.md]:PORTING.md
This document describes how to build and install Open vSwitch on a Red
Hat Enterprise Linux (RHEL) host. If you want to install Open vSwitch
-on a generic Linux host, see [INSTALL](INSTALL.md) instead.
+on a generic Linux host, see [INSTALL.md] instead.
We have tested these instructions with RHEL 5.6 and RHEL 6.0.
b. Create a distribution tarball on some other machine, by
running "./boot.sh; ./configure; make dist" in the Git tree.
You must run this on a machine that has the tools listed in
- [INSTALL](INSTALL.md) as prerequisites for building from a Git
- tree. Afterward, proceed with the rest of the instructions using
+ [INSTALL.md] as prerequisites for building from a Git tree.
+ Afterward, proceed with the rest of the instructions using
the distribution tarball.
3. Some versions of the RHEL 6 kernel-devel package contain a broken
-----------------------------------
Simple integration with Red Hat network scripts has been implemented.
-Please read rhel/README.RHEL in the source tree or
+Please read [rhel/README.RHEL] in the source tree or
/usr/share/doc/openvswitch/README.RHEL in the installed openvswitch
package for details.
--------------
Please report problems to bugs@openvswitch.org.
+
+[INSTALL.md]:INSTALL.md
+[rhel/README.RHEL]:rhel/README.RHEL
the OpenFlow connections, increasing network security.
This file explains how to configure an Open vSwitch to connect to an
-OpenFlow controller over SSL. Refer to INSTALL for instructions on
-building Open vSwitch with SSL support.
+OpenFlow controller over SSL. Refer to [INSTALL.md] for instructions
+on building Open vSwitch with SSL support.
Open vSwitch uses TLS version 1.0 or later (TLSv1), as specified by
RFC 2246, which is very similar to SSL version 3.0. TLSv1 was
--------------
Please report problems to bugs@openvswitch.org.
+
+[INSTALL.md]:INSTALL.md
This document describes how to build and install Open vSwitch on a
Citrix XenServer host. If you want to install Open vSwitch on a
-generic Linux or BSD host, see [INSTALL](INSTALL.md) instead.
+generic Linux or BSD host, see [INSTALL.md] instead.
These instructions have been tested with XenServer 5.6 FP1.
./configure; make dist` in the Git tree. You cannot run this in
the DDK VM, because it lacks tools that are necessary to bootstrap
the Open vSwitch distribution. Instead, you must run this on a
- machine that has the tools listed in [INSTALL](INSTALL.md) as
- prerequisites for building from a Git tree.
+ machine that has the tools listed in [INSTALL.md] as prerequisites
+ for building from a Git tree.
2. Copy the distribution tarball into /usr/src/redhat/SOURCES inside
the DDK VM.
--------------
Please report problems to bugs@openvswitch.org.
+
+[INSTALL.md]:INSTALL.md
generic Linux, FreeBSD, or NetBSD host. For specifics around installation
on a specific platform, please see one of these files:
- - [INSTALL.Debian](INSTALL.Debian.md)
- - [INSTALL.Fedora](INSTALL.Fedora.md)
- - [INSTALL.RHEL](INSTALL.RHEL.md)
- - [INSTALL.XenServer](INSTALL.XenServer.md)
- - [INSTALL.NetBSD](INSTALL.NetBSD.md)
- - [INSTALL.DPDK](INSTALL.DPDK.md)
+ - [INSTALL.Debian.md]
+ - [INSTALL.Fedora.md]
+ - [INSTALL.RHEL.md]
+ - [INSTALL.XenServer.md]
+ - [INSTALL.NetBSD.md]
+ - [INSTALL.DPDK.md]
Build Requirements
------------------
On Linux, you may choose to compile the kernel module that comes with
the Open vSwitch distribution or to use the kernel module built into
-the Linux kernel (version 3.3 or later). See the FAQ question "What
-features are not available in the Open vSwitch kernel datapath that
+the Linux kernel (version 3.3 or later). See the [FAQ.md] question
+"What features are not available in the Open vSwitch kernel datapath that
ships as part of the upstream Linux kernel?" for more information on
this trade-off. You may also use the userspace-only implementation,
-at some cost in features and performance (see INSTALL.userspace for
-details). To compile the kernel module on Linux, you must also
+at some cost in features and performance (see [INSTALL.userspace.md]
+for details). To compile the kernel module on Linux, you must also
install the following:
- - A supported Linux kernel version. Please refer to README.md for a
+ - A supported Linux kernel version. Please refer to [README.md] for a
list of supported versions.
The Open vSwitch datapath requires bridging support
If --with-linux requests building for an unsupported version of
Linux, then "configure" will fail with an error message. Please
- refer to the FAQ for advice in that case.
+ refer to the [FAQ.md] for advice in that case.
If you wish to build the kernel module for an architecture other
than the architecture of the machine used for the build, you may
=============
Please report problems to bugs@openvswitch.org.
+
+[README.md]:README.md
+[INSTALL.Debian.md]:INSTALL.Debian.md
+[INSTALL.Fedora.md]:INSTALL.Fedora.md
+[INSTALL.RHEL.md]:INSTALL.RHEL.md
+[INSTALL.XenServer.md]:INSTALL.XenServer.md
+[INSTALL.NetBSD.md]:INSTALL.NetBSD.md
+[INSTALL.DPDK.md]:INSTALL.DPDK.md
+[INSTALL.userspace.md]:INSTALL.userspace.md
+[FAQ.md]:FAQ.md
-----------------------
The requirements and procedure for building, installing, and
-configuring Open vSwitch are the same as those given in INSTALL.
+configuring Open vSwitch are the same as those given in [INSTALL.md].
You may omit configuring, building, and installing the kernel module,
and the related requirements.
-------------
Please report problems to bugs@openvswitch.org.
+
+[INSTALL.md]:INSTALL.md
should document it in the appropriate manpage and mention it in
NEWS as well.
- * Coding style (see the [CodingStyle](CodingStyle.md) file at the
- top of the source tree).
+ * Coding style (see the [CodingStyle.md] file at the top of the
+ source tree).
- * The patch submission guidelines (see CONTRIBUTING). I
+ * The patch submission guidelines (see [CONTRIBUTING.md]). I
recommend using "git send-email", which automatically follows a
lot of those guidelines.
-------------
Please report problems to bugs@openvswitch.org.
+
+[CONTRIBUTING.md]:CONTRIBUTING.md
+[CodingStyle.md]:CodingStyle.md
writing any more code, as long as the netdev provider that you
implemented supports receiving packets. It yields poor performance,
however, because every packet passes through the ovs-vswitchd process.
-See [INSTALL.userspace](INSTALL.userspace.md) for instructions on how
-to configure a userspace switch.
+See [INSTALL.userspace.md] for instructions on how to configure a
+userspace switch.
If the userspace switch is not the right choice for your port, then
you will have to write more code. You may implement either an
Please direct porting questions to dev@openvswitch.org. We will try
to use questions to improve this porting guide.
+
+[INSTALL.userspace.md]:INSTALL.userspace.md
--------------------------------------
To install Open vSwitch on a regular Linux or FreeBSD host, please
-read INSTALL. For specifics around installation on a specific
+read [INSTALL.md]. For specifics around installation on a specific
platform, please see one of these files:
-- [INSTALL.Debian](INSTALL.Debian.md)
-- [INSTALL.Fedora](INSTALL.Fedora.md)
-- [INSTALL.RHEL](INSTALL.RHEL.md)
-- [INSTALL.XenServer](INSTALL.XenServer.md)
+- [INSTALL.Debian.md]
+- [INSTALL.Fedora.md]
+- [INSTALL.RHEL.md]
+- [INSTALL.XenServer.md]
To use Open vSwitch...
-- ...with Docker on Linux, read [INSTALL.Docker](INSTALL.Docker.md)
+- ...with Docker on Linux, read [INSTALL.Docker.md]
-- ...with KVM on Linux, read [INSTALL](INSTALL.md), read
- [INSTALL.KVM](INSTALL.KVM.md)
+- ...with KVM on Linux, read [INSTALL.md], read [INSTALL.KVM.md]
-- ...with Libvirt, read [INSTALL.Libvirt](INSTALL.Libvirt.md).
+- ...with Libvirt, read [INSTALL.Libvirt.md].
-- ...without using a kernel module, read
-[INSTALL.userspace](INSTALL.userspace.md).
+- ...without using a kernel module, read [INSTALL.userspace.md].
-For answers to common questions, read FAQ.
+For answers to common questions, read [FAQ.md].
-To learn how to set up SSL support for Open vSwitch, read
-[INSTALL.SSL](INSTALL.SSL.md).
+To learn how to set up SSL support for Open vSwitch, read [INSTALL.SSL.md].
To learn about some advanced features of the Open vSwitch software
-switch, read the tutorial in tutorial/Tutorial.
+switch, read the [tutorial/Tutorial.md].
Each Open vSwitch userspace program is accompanied by a manpage. Many
of the manpages are customized to your configuration as part of the
-------
bugs@openvswitch.org
+
+[INSTALL.md]:INSTALL.md
+[INSTALL.Debian.md]:INSTALL.Debian.md
+[INSTALL.Docker.md]:INSTALL.Docker.md
+[INSTALL.Fedora.md]:INSTALL.Fedora.md
+[INSTALL.KVM.md]:INSTALL.KVM.md
+[INSTALL.Libvirt.md]:INSTALL.Libvirt.md
+[INSTALL.RHEL.md]:INSTALL.RHEL.md
+[INSTALL.SSL.md]:INSTALL.SSL.md
+[INSTALL.userspace.md]:INSTALL.userspace.md
+[INSTALL.XenServer.md]:INSTALL.XenServer.md
+[FAQ.md]:FAQ.md
+[tutorial/Tutorial.md]:tutorial/Tutorial.md
==========================
This file lists a number of project ideas for Open vSwitch. The ideas
-here overlap somewhat with those in the OPENFLOW-1.1+ file.
+here overlap somewhat with those in the [OPENFLOW-1.1+.md] file.
Programming Project Ideas
Each of these projects would ideally result in a patch or a short
series of them posted to ovs-dev.
-Please read [CONTRIBUTING](CONTRIBUTING.md) and [CodingStyle](CodingStyle.md)
-in the top of the source tree before you begin work. The OPENFLOW-1.1+
-file also has an introduction to how OpenFlow is implemented in Open vSwitch.
-It is also a good idea to look around the source tree for related code, and
+Please read [CONTRIBUTING.md] and [CodingStyle.md] in the top of the
+source tree before you begin work. The [OPENFLOW-1.1+.md] file also has
+an introduction to how OpenFlow is implemented in Open vSwitch. It is
+also a good idea to look around the source tree for related code, and
back through the Git history for commits on related subjects, to allow
you to follow existing patterns and conventions.
should document it in the appropriate manpage and mention it in
NEWS as well.
- * Coding style (see the [CodingStyle](CodingStyle.md) file at the top
- of the source tree).
+ * Coding style (see the [CodingStyle.md] file at the top of the
+ source tree).
- * The patch submission guidelines (see [CONTRIBUTING](CONTRIBUTING.md)).
- I recommend using "git send-email", which automatically follows a
+ * The patch submission guidelines (see [CONTRIBUTING.md]). I
+ recommend using "git send-email", which automatically follows a
lot of those guidelines.
Local Variables:
mode: text
End:
+
+[OPENFLOW-1.1+.md]:OPENFLOW-1.1+.md
+[CONTRIBUTING.md]:CONTRIBUTING.md
+[CodingStyle.md]:CodingStyle.md
case $srcdir in
'')
srcdir=$builddir
- if test ! -e "$srcdir"/WHY-OVS; then
+ if test ! -e "$srcdir"/WHY-OVS.md; then
srcdir=`cd $builddir/.. && pwd`
fi
;;
projects / cascardo / ovs.git / commitdiff