mirror of
https://github.com/openvswitch/ovs
synced 2025-08-22 09:58:01 +00:00
doc: Convert README to rST
Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Russell Bryant <russell@ovn.org>
This commit is contained in:
Stephen Finucane
Russell Bryant
parent
7f907848f5
commit
b1fe1c94b5
@ -85,7 +85,7 @@ use the userspace-only implementation, at some cost in features and performance
|
|||||||
To compile the kernel module on Linux, you must also install the
|
To compile the kernel module on Linux, you must also install the
|
||||||
following:
|
following:
|
||||||
|
|
||||||
- A supported Linux kernel version. Refer to the `README <README.md>`__
|
- A supported Linux kernel version. Refer to the `README <README.rst>`__
|
||||||
for a list of supported versions.
|
for a list of supported versions.
|
||||||
|
|
||||||
For optional support of ingress policing, you must enable kernel
|
For optional support of ingress policing, you must enable kernel
|
||||||
|
|||||||
@ -90,7 +90,7 @@ docs = \
|
|||||||
MAINTAINERS.rst \
|
MAINTAINERS.rst \
|
||||||
OPENFLOW-1.1+.md \
|
OPENFLOW-1.1+.md \
|
||||||
PORTING.rst \
|
PORTING.rst \
|
||||||
README.md \
|
README.rst \
|
||||||
README-lisp.md \
|
README-lisp.md \
|
||||||
README-native-tunneling.md \
|
README-native-tunneling.md \
|
||||||
REPORTING-BUGS.md \
|
REPORTING-BUGS.md \
|
||||||
|
|||||||
131
README.md
131
README.md
@ -1,131 +0,0 @@
|
|||||||
Open vSwitch
|
|
||||||
============
|
|
||||||
|
|
||||||
Build Status:
|
|
||||||
-------------
|
|
||||||
|
|
||||||
[](https://travis-ci.org/openvswitch/ovs)
|
|
||||||
|
|
||||||
What is Open vSwitch?
|
|
||||||
---------------------
|
|
||||||
|
|
||||||
Open vSwitch is a multilayer software switch licensed under the open
|
|
||||||
source Apache 2 license. Our goal is to implement a production
|
|
||||||
quality switch platform that supports standard management interfaces
|
|
||||||
and opens the forwarding functions to programmatic extension and
|
|
||||||
control.
|
|
||||||
|
|
||||||
Open vSwitch is well suited to function as a virtual switch in VM
|
|
||||||
environments. In addition to exposing standard control and visibility
|
|
||||||
interfaces to the virtual networking layer, it was designed to support
|
|
||||||
distribution across multiple physical servers. Open vSwitch supports
|
|
||||||
multiple Linux-based virtualization technologies including
|
|
||||||
Xen/XenServer, KVM, and VirtualBox.
|
|
||||||
|
|
||||||
The bulk of the code is written in platform-independent C and is
|
|
||||||
easily ported to other environments. The current release of Open
|
|
||||||
vSwitch supports the following features:
|
|
||||||
|
|
||||||
* Standard 802.1Q VLAN model with trunk and access ports
|
|
||||||
* NIC bonding with or without LACP on upstream switch
|
|
||||||
* NetFlow, sFlow(R), and mirroring for increased visibility
|
|
||||||
* QoS (Quality of Service) configuration, plus policing
|
|
||||||
* Geneve, GRE, VXLAN, STT, and LISP tunneling
|
|
||||||
* 802.1ag connectivity fault management
|
|
||||||
* OpenFlow 1.0 plus numerous extensions
|
|
||||||
* Transactional configuration database with C and Python bindings
|
|
||||||
* High-performance forwarding using a Linux kernel module
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
What's here?
|
|
||||||
------------
|
|
||||||
|
|
||||||
The main components of this distribution are:
|
|
||||||
|
|
||||||
* ovs-vswitchd, a daemon that implements the switch, along with
|
|
||||||
a companion Linux kernel module for flow-based switching.
|
|
||||||
* ovsdb-server, a lightweight database server that ovs-vswitchd
|
|
||||||
queries to obtain its configuration.
|
|
||||||
* ovs-dpctl, a tool for configuring the switch kernel module.
|
|
||||||
* Scripts and specs for building RPMs for Citrix XenServer and Red
|
|
||||||
Hat Enterprise Linux. The XenServer RPMs allow Open vSwitch to
|
|
||||||
be installed on a Citrix XenServer host as a drop-in replacement
|
|
||||||
for its switch, with additional functionality.
|
|
||||||
* ovs-vsctl, a utility for querying and updating the configuration
|
|
||||||
of ovs-vswitchd.
|
|
||||||
* ovs-appctl, a utility that sends commands to running Open
|
|
||||||
vSwitch daemons.
|
|
||||||
|
|
||||||
Open vSwitch also provides some tools:
|
|
||||||
|
|
||||||
* ovs-ofctl, a utility for querying and controlling OpenFlow
|
|
||||||
switches and controllers.
|
|
||||||
* ovs-pki, a utility for creating and managing the public-key
|
|
||||||
infrastructure for OpenFlow switches.
|
|
||||||
* ovs-testcontroller, a simple OpenFlow controller that may be useful
|
|
||||||
for testing (though not for production).
|
|
||||||
* A patch to tcpdump that enables it to parse OpenFlow messages.
|
|
||||||
|
|
||||||
What other documentation is available?
|
|
||||||
--------------------------------------
|
|
||||||
|
|
||||||
To install Open vSwitch on a regular Linux or FreeBSD host, please
|
|
||||||
read [INSTALL.rst]. For specifics around installation on a specific
|
|
||||||
platform, please see one of these files:
|
|
||||||
|
|
||||||
- [INSTALL.Debian.rst]
|
|
||||||
- [INSTALL.Fedora.md]
|
|
||||||
- [INSTALL.RHEL.md]
|
|
||||||
- [INSTALL.XenServer.rst]
|
|
||||||
|
|
||||||
To use Open vSwitch...
|
|
||||||
|
|
||||||
- ...with Docker on Linux, read [INSTALL.Docker.rst]
|
|
||||||
|
|
||||||
- ...with KVM on Linux, read [INSTALL.rst], read [INSTALL.KVM.rst]
|
|
||||||
|
|
||||||
- ...with Libvirt, read [INSTALL.Libvirt.md].
|
|
||||||
|
|
||||||
- ...without using a kernel module, read [INSTALL.userspace.rst].
|
|
||||||
|
|
||||||
- ...with DPDK, read [INSTALL.DPDK.rst].
|
|
||||||
|
|
||||||
- ...with SELinux, read [INSTALL.SELinux.md].
|
|
||||||
|
|
||||||
For answers to common questions, read [FAQ.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/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
|
|
||||||
build process, so we recommend building Open vSwitch before reading
|
|
||||||
the manpages.
|
|
||||||
|
|
||||||
Contact
|
|
||||||
-------
|
|
||||||
|
|
||||||
bugs@openvswitch.org
|
|
||||||
|
|
||||||
[INSTALL.rst]:INSTALL.rst
|
|
||||||
[INSTALL.Debian.rst]:INSTALL.Debian.rst
|
|
||||||
[INSTALL.Docker.rst]:INSTALL.Docker.rst
|
|
||||||
[INSTALL.DPDK.rst]:INSTALL.DPDK.rst
|
|
||||||
[INSTALL.Fedora.md]:INSTALL.Fedora.md
|
|
||||||
[INSTALL.KVM.rst]:INSTALL.KVM.rst
|
|
||||||
[INSTALL.Libvirt.md]:INSTALL.Libvirt.md
|
|
||||||
[INSTALL.RHEL.md]:INSTALL.RHEL.md
|
|
||||||
[INSTALL.SELinux.md]:INSTALL.SELinux.md
|
|
||||||
[INSTALL.SSL.md]:INSTALL.SSL.md
|
|
||||||
[INSTALL.userspace.rst]:INSTALL.userspace.rst
|
|
||||||
[INSTALL.XenServer.rst]:INSTALL.XenServer.rst
|
|
||||||
[FAQ.md]:FAQ.md
|
|
||||||
[tutorial/Tutorial.md]:tutorial/Tutorial.md
|
|
||||||
116
README.rst
Normal file
116
README.rst
Normal file
@ -0,0 +1,116 @@
|
|||||||
|
============
|
||||||
|
Open vSwitch
|
||||||
|
============
|
||||||
|
|
||||||
|
Build Status
|
||||||
|
------------
|
||||||
|
|
||||||
|
.. image:: https://travis-ci.org/openvswitch/ovs.png
|
||||||
|
:target: https://travis-ci.org/openvswitch/ovs
|
||||||
|
|
||||||
|
What is Open vSwitch?
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
Open vSwitch is a multilayer software switch licensed under the open source
|
||||||
|
Apache 2 license. Our goal is to implement a production quality switch
|
||||||
|
platform that supports standard management interfaces and opens the forwarding
|
||||||
|
functions to programmatic extension and control.
|
||||||
|
|
||||||
|
Open vSwitch is well suited to function as a virtual switch in VM environments.
|
||||||
|
In addition to exposing standard control and visibility interfaces to the
|
||||||
|
virtual networking layer, it was designed to support distribution across
|
||||||
|
multiple physical servers. Open vSwitch supports multiple Linux-based
|
||||||
|
virtualization technologies including Xen/XenServer, KVM, and VirtualBox.
|
||||||
|
|
||||||
|
The bulk of the code is written in platform-independent C and is easily ported
|
||||||
|
to other environments. The current release of Open vSwitch supports the
|
||||||
|
following features:
|
||||||
|
|
||||||
|
- Standard 802.1Q VLAN model with trunk and access ports
|
||||||
|
- NIC bonding with or without LACP on upstream switch
|
||||||
|
- NetFlow, sFlow(R), and mirroring for increased visibility
|
||||||
|
- QoS (Quality of Service) configuration, plus policing
|
||||||
|
- Geneve, GRE, VXLAN, STT, and LISP tunneling
|
||||||
|
- 802.1ag connectivity fault management
|
||||||
|
- OpenFlow 1.0 plus numerous extensions
|
||||||
|
- Transactional configuration database with C and Python bindings
|
||||||
|
- High-performance forwarding using a Linux kernel module
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
What's here?
|
||||||
|
------------
|
||||||
|
|
||||||
|
The main components of this distribution are:
|
||||||
|
|
||||||
|
- ovs-vswitchd, a daemon that implements the switch, along with a companion
|
||||||
|
Linux kernel module for flow-based switching.
|
||||||
|
- ovsdb-server, a lightweight database server that ovs-vswitchd queries to
|
||||||
|
obtain its configuration.
|
||||||
|
- ovs-dpctl, a tool for configuring the switch kernel module.
|
||||||
|
- Scripts and specs for building RPMs for Citrix XenServer and Red Hat
|
||||||
|
Enterprise Linux. The XenServer RPMs allow Open vSwitch to be installed on a
|
||||||
|
Citrix XenServer host as a drop-in replacement for its switch, with
|
||||||
|
additional functionality.
|
||||||
|
- ovs-vsctl, a utility for querying and updating the configuration of
|
||||||
|
ovs-vswitchd.
|
||||||
|
- ovs-appctl, a utility that sends commands to running Open vSwitch daemons.
|
||||||
|
|
||||||
|
Open vSwitch also provides some tools:
|
||||||
|
|
||||||
|
- ovs-ofctl, a utility for querying and controlling OpenFlow switches and
|
||||||
|
controllers.
|
||||||
|
- ovs-pki, a utility for creating and managing the public-key infrastructure
|
||||||
|
for OpenFlow switches.
|
||||||
|
- ovs-testcontroller, a simple OpenFlow controller that may be useful for
|
||||||
|
testing (though not for production).
|
||||||
|
- A patch to tcpdump that enables it to parse OpenFlow messages.
|
||||||
|
|
||||||
|
What other documentation is available?
|
||||||
|
--------------------------------------
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
- `Debian <INSTALL.Debian.rst>`__
|
||||||
|
- `Fedora <INSTALL.Fedora.md>`__
|
||||||
|
- `RHEL <INSTALL.RHEL.md>`__
|
||||||
|
- `XenServer <INSTALL.XenServer.rst>`__
|
||||||
|
- `Windows <INSTALL.Windows.rst>`__
|
||||||
|
|
||||||
|
To use Open vSwitch...
|
||||||
|
|
||||||
|
- ...with Docker on Linux, see `here <INSTALL.Docker.rst>`__.
|
||||||
|
|
||||||
|
- ...with KVM on Linux, see `here <INSTALL.rst>`__ and `here
|
||||||
|
<INSTALL.KVM.rst>`__.
|
||||||
|
|
||||||
|
- ...with Libvirt, see `here <INSTALL.Libvirt.md>`__.
|
||||||
|
|
||||||
|
- ...without using a kernel module, see `here <INSTALL.userspace.rst>`__.
|
||||||
|
|
||||||
|
- ...with DPDK, see `here <INSTALL.DPDK.rst>`__.
|
||||||
|
|
||||||
|
- ...with SELinux, see `here <INSTALL.SELinux.md>`__.
|
||||||
|
|
||||||
|
For answers to common questions, refer to the `FAQ <FAQ.md>`__.
|
||||||
|
|
||||||
|
To learn how to set up SSL support for Open vSwitch, see `here
|
||||||
|
<INSTALL.SSL.md>`__.
|
||||||
|
|
||||||
|
To learn about some advanced features of the Open vSwitch software switch, read
|
||||||
|
the `tutorial <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 build process, so
|
||||||
|
we recommend building Open vSwitch before reading the manpages.
|
||||||
|
|
||||||
|
Contact
|
||||||
|
-------
|
||||||
|
|
||||||
|
bugs@openvswitch.org
|
||||||
@ -474,7 +474,7 @@ fi
|
|||||||
%{_mandir}/man8/ovs-vswitchd.8*
|
%{_mandir}/man8/ovs-vswitchd.8*
|
||||||
%{_mandir}/man8/ovs-parse-backtrace.8*
|
%{_mandir}/man8/ovs-parse-backtrace.8*
|
||||||
%{_mandir}/man8/ovs-testcontroller.8*
|
%{_mandir}/man8/ovs-testcontroller.8*
|
||||||
%doc COPYING DESIGN.md INSTALL.SSL.md NOTICE README.md WHY-OVS.md
|
%doc COPYING DESIGN.md INSTALL.SSL.md NOTICE README.rst WHY-OVS.md
|
||||||
%doc FAQ.md NEWS INSTALL.DPDK.rst rhel/README.RHEL
|
%doc FAQ.md NEWS INSTALL.DPDK.rst rhel/README.RHEL
|
||||||
/var/lib/openvswitch
|
/var/lib/openvswitch
|
||||||
/var/log/openvswitch
|
/var/log/openvswitch
|
||||||
|
|||||||
@ -247,7 +247,7 @@ exit 0
|
|||||||
/usr/share/openvswitch/scripts/sysconfig.template
|
/usr/share/openvswitch/scripts/sysconfig.template
|
||||||
/usr/share/openvswitch/vswitch.ovsschema
|
/usr/share/openvswitch/vswitch.ovsschema
|
||||||
/usr/share/openvswitch/vtep.ovsschema
|
/usr/share/openvswitch/vtep.ovsschema
|
||||||
%doc COPYING DESIGN.md INSTALL.SSL.md NOTICE README.md WHY-OVS.md FAQ.md NEWS
|
%doc COPYING DESIGN.md INSTALL.SSL.md NOTICE README.rst WHY-OVS.md FAQ.md NEWS
|
||||||
%doc INSTALL.DPDK.rst rhel/README.RHEL README-native-tunneling.md
|
%doc INSTALL.DPDK.rst rhel/README.RHEL README-native-tunneling.md
|
||||||
/var/lib/openvswitch
|
/var/lib/openvswitch
|
||||||
/var/log/openvswitch
|
/var/log/openvswitch
|
||||||
|
|||||||
@ -502,5 +502,5 @@ distribution are good examples of how to use \fBovs\-ctl\fR.
|
|||||||
.
|
.
|
||||||
.SH "SEE ALSO"
|
.SH "SEE ALSO"
|
||||||
.
|
.
|
||||||
\fBREADME.md\fR, \fBINSTALL.Linux.md\fR, \fBovsdb\-server\fR(8),
|
\fBREADME.rst\fR, \fBINSTALL.Linux.md\fR, \fBovsdb\-server\fR(8),
|
||||||
\fBovs\-vswitchd\fR(8).
|
\fBovs\-vswitchd\fR(8).
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user