summaryrefslogtreecommitdiff
path: root/Documentation/tutorials/index.rst
blob: ab90b7c847218ba213b24726966c664f37b38173 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
..
      Copyright (c) 2016, Stephen Finucane <stephen@that.guru>

      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

          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.

      Convention for heading levels in Open vSwitch documentation:

      =======  Heading 0 (reserved for the title in a document)
      -------  Heading 1
      ~~~~~~~  Heading 2
      +++++++  Heading 3
      '''''''  Heading 4

      Avoid deeper levels because they do not render well.

=========
Tutorials
=========

Getting started with Open vSwitch (OVS) and Open Virtual Network (OVN) for Open
vSwitch.

.. TODO(stephenfin): We could really do with a few basic tutorials, along with
   some more specialized ones (DPDK, XenServer, Windows). The latter could
   probably be formed from the install guides, but the former will need to be
   produced from scratch or reproduced from blogs (with permission of the
   author)

.. toctree::
   :maxdepth: 2

   faucet
   ovs-advanced
   ovn-sandbox
   ovn-openstack
   ovs-conntrack