From e575bca67aa7ade1989f0c2e6e3498d0bc49f15a Mon Sep 17 00:00:00 2001 From: Ben Pfaff Date: Tue, 27 Nov 2012 23:31:39 -0800 Subject: [PATCH] work on manual --- doc/.gitignore | 10 ++++++ doc/manual.texi | 84 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 94 insertions(+) create mode 100644 doc/.gitignore create mode 100644 doc/manual.texi diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 00000000..df6585d2 --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1,10 @@ +/manual.aux +/manual.cp +/manual.fn +/manual.ky +/manual.log +/manual.pdf +/manual.pg +/manual.toc +/manual.tp +/manual.vr diff --git a/doc/manual.texi b/doc/manual.texi new file mode 100644 index 00000000..16627389 --- /dev/null +++ b/doc/manual.texi @@ -0,0 +1,84 @@ +\input texinfo @c -*-texinfo-*- +@c %**start of header +@setfilename openvswitch.info +@settitle Open vSwitch Guide +@c %**end of header + +@macro ovs {} +Open@tie{}vSwitch +@end macro + +@copying +Copyright @copyright{} 2012 Nicira, Inc. + +Licensed under the Apache License, Version 2.0 (the ``License''); you +may not use this file except in compliance with the License. You may +obtain a copy of the License at +@url{http://www.apache.org/licenses/LICENSE-2.0}. + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an ``AS IS'' BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +implied. See the License for the specific language governing +permissions and limitations under the License. +@end copying + +@titlepage +@title Open vSwitch Guide +@author Open vSwitch Contributors + +@page +@vskip 0pt plus 1filll +@insertcopying +@end titlepage + +@contents + +@ifnottex +@node Top +@top TITLE + +This manual is for PROGRAM, version VERSION. +@end ifnottex + +@menu +* Introduction:: +@end menu + +@node Introduction +@chapter Introduction + +Open vSwitch is an Ethernet switch implemented in software. It is +well suited to environments that call for basic switching features +such as VLANs and bonding. However, Open vSwitch is built as a +platform to open up network forwarding to programmatic extension, so +it really shines in environments that demand fast, flexible control +over the network. + +The most common uses of Open vSwitch today deploy it as a +software-based switch, that is, on general-purpose computers without +hardware specialized for switching. Within this class of uses, Open +vSwitch is most often used on virtual server hosts, to forward traffic +among virtual machines and to and from a physical network. +Virtualization is not a requirement: Open vSwitch can also forward +traffic among physical interfaces in a ``bare metal'' environment. + +Open vSwitch is designed and internally layered to be amenable for use +within special-purpose switch hardware, and a number of network +hardware manufacturers have used it for that purpose. This allows +Open vSwitch to control high-performance hardware switches as well as +software switches, although hardware is inherently less flexible than +software. + +What platforms? What hypervisors? +Why OVS? +What is OpenFlow? + +@node + +@node Index +@unnumbered Index + +@printindex cp + +@bye -- 2.30.2