Documentation/intro/install/index.rst

   1 ..
   2       Copyright (c) 2016, Stephen Finucane <stephen@that.guru>
   3
   4       Licensed under the Apache License, Version 2.0 (the "License"); you may
   5       not use this file except in compliance with the License. You may obtain
   6       a copy of the License at
   7
   8           http://www.apache.org/licenses/LICENSE-2.0
   9
  10       Unless required by applicable law or agreed to in writing, software
  11       distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  12       WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  13       License for the specific language governing permissions and limitations
  14       under the License.
  15
  16       Convention for heading levels in Open vSwitch documentation:
  17
  18       =======  Heading 0 (reserved for the title in a document)
  19       -------  Heading 1
  20       ~~~~~~~  Heading 2
  21       +++++++  Heading 3
  22       '''''''  Heading 4
  23
  24       Avoid deeper levels because they do not render well.
  25
  26 =======================
  27 Installing Open vSwitch
  28 =======================
  29
  30 A collection of guides detailing how to install Open vSwitch in a variety of
  31 different environments and using different configurations.
  32
  33 Installation from Source
  34 ------------------------
  35
  36 .. TODO(stephenfin): The DPDK-ADVANCED doc is mostly usage material. The
  37    install related instructions should be moved to the main doc, while the
  38    rest should be moved to howto and topic docs
  39
  40 .. TODO(stephenfin): Based on the title alone, the NetBSD doc should probably
  41    be merged into the general install doc
  42
  43 .. toctree::
  44    :maxdepth: 2
  45
  46    general
  47    netbsd
  48    windows
  49    xenserver
  50    userspace
  51    dpdk
  52    dpdk-advanced
  53    bash-completion
  54
  55 Installation from Packages
  56 --------------------------
  57
  58 Open vSwitch is packaged on a variety of distributions. The tooling required to
  59 build these packages is included in the Open vSwitch tree. The instructions are
  60 provided below.
  61
  62 .. toctree::
  63    :maxdepth: 2
  64
  65    debian
  66    fedora
  67    rhel