+.. NOTE(stephenfin): If making changes to this file, ensure that the
+ start-after/end-before lines found in 'Documentation/intro/what-is-ovs'
+ are kept up-to-date.
+
============
Open vSwitch
============
-Build Status
-------------
-
+.. image:: https://github.com/openvswitch/ovs/workflows/Build%20and%20Test/badge.svg
+ :target: https://github.com/openvswitch/ovs/actions
.. image:: https://travis-ci.org/openvswitch/ovs.png
:target: https://travis-ci.org/openvswitch/ovs
+.. image:: https://ci.appveyor.com/api/projects/status/github/openvswitch/ovs?branch=master&svg=true&retina=true
+ :target: https://ci.appveyor.com/project/blp/ovs/history
+.. image:: https://api.cirrus-ci.com/github/openvswitch/ovs.svg
+ :target: https://cirrus-ci.com/github/openvswitch/ovs
What is Open vSwitch?
---------------------
The included Linux kernel module supports Linux 3.10 and up.
-Open vSwitch can also operate, at a cost in performance, entirely in userspace,
-without assistance from a kernel module. This userspace implementation should
-be easier to port than the kernel-based switch. It is considered experimental.
+Open vSwitch can also operate entirely in userspace without assistance from
+a kernel module. This userspace implementation should be easier to port than
+the kernel-based switch. OVS in userspace can access Linux or DPDK devices.
+Note Open vSwitch with userspace datapath and non DPDK devices is considered
+experimental and comes with a cost in performance.
What's here?
------------
What other documentation is available?
--------------------------------------
+.. TODO(stephenfin): Update with a link to the hosting site of the docs, once
+ we know where that is
+
To install Open vSwitch on a regular Linux or FreeBSD host, please read the
-`installation guide <INSTALL.md>`__. For specifics around installation on a
-specific platform, please see one of the below installation guides:
+`installation guide <Documentation/intro/install/general.rst>`__. For specifics
+around installation on a specific platform, refer to one of the `other
+installation guides <Documentation/intro/install/index.rst>`__
-- `Debian <INSTALL.Debian.rst>`__
-- `Fedora <INSTALL.Fedora.rst>`__
-- `RHEL <INSTALL.RHEL.md>`__
-- `XenServer <INSTALL.XenServer.rst>`__
-- `Windows <INSTALL.Windows.rst>`__
+For answers to common questions, refer to the `FAQ <Documentation/faq>`__.
-To use Open vSwitch...
+To learn about some advanced features of the Open vSwitch software switch, read
+the `tutorial <Documentation/tutorials/ovs-advanced.rst>`__.
-- ...with Docker on Linux, see `here <INSTALL.Docker.rst>`__.
+Each Open vSwitch userspace program is accompanied by a manpage. Many of the
+manpages are customized to your configuration as part of the build process, so
+we recommend building Open vSwitch before reading the manpages.
-- ...with KVM on Linux, see `here <INSTALL.rst>`__ and `here
- <INSTALL.KVM.rst>`__.
+License
+-------
-- ...with Libvirt, see `here <INSTALL.Libvirt.md>`__.
+The following is a summary of the licensing of files in this distribution.
+As mentioned, Open vSwitch is licensed under the open source Apache 2 license.
+Some files may be marked specifically with a different license, in which case
+that license applies to the file in question.
-- ...without using a kernel module, see `here <INSTALL.userspace.rst>`__.
-- ...with DPDK, see `here <INSTALL.DPDK.rst>`__.
+Files under the datapath directory are licensed under the GNU General Public
+License, version 2.
-- ...with SELinux, see `here <INSTALL.SELinux.md>`__.
+File build-aux/cccl is licensed under the GNU General Public License, version 2.
-For answers to common questions, refer to the `FAQ <FAQ.rst>`__.
+The following files are licensed under the 2-clause BSD license.
+ include/windows/getopt.h
+ lib/getopt_long.c
+ lib/conntrack-tcp.c
-To learn how to set up SSL support for Open vSwitch, see `here
-<INSTALL.SSL.rst>`__.
+The following files are licensed under the 3-clause BSD-license
+ include/windows/netinet/icmp6.h
+ include/windows/netinet/ip6.h
+ lib/strsep.c
-To learn about some advanced features of the Open vSwitch software switch, read
-the `tutorial <tutorial/Tutorial.md>`__.
+Files under the xenserver directory are licensed on a file-by-file basis.
+Refer to each file for details.
-Each Open vSwitch userspace program is accompanied by a manpage. Many of the
-manpages are customized to your configuration as part of the build process, so
-we recommend building Open vSwitch before reading the manpages.
+Files lib/sflow*.[ch] are licensed under the terms of either the
+Sun Industry Standards Source License 1.1, that is available at:
+ http://host-sflow.sourceforge.net/sissl.html
+or the InMon sFlow License, that is available at:
+ http://www.inmon.com/technology/sflowlicense.txt
Contact
-------
projects / mirror_ovs.git / blobdiff