blob: da3301903d9ccd2146bffe0eb47c57a737e68276 (
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
..
Copyright 2015 Futurewei. All rights reserved.
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 Neutron devref:
======= 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.)
Welcome to the Service Function Chaining Documentation!
=======================================================
.. include:: ../../README.rst
===============
Developer Guide
===============
In the Developer Guide, you will find information on Networking-SFC lower level
programming APIs. There are sections that cover the core pieces of networking-sfc,
including its api, command-lines, database, system-design, alembic-migration etc.
There are also subsections that describe specific plugins inside networking-sfc.
Finally, the developer guide includes information about testing infrastructure.
Programming HowTos and Tutorials
--------------------------------
.. toctree::
:maxdepth: 2
installation
usage
contribution
Networking-SFC Internals
------------------------
.. toctree::
:maxdepth: 2
api
system_design and_workflow
ovs_driver_and_agent_workflow
command_extensions
alembic_migration
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|