docs/documentation/index.rst


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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208

.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) Open Platform for NFV Project, Inc. and its contributors

*******************
OPNFV Documentation
*******************

==============================
Colorado Release Documentation
==============================

OPNFV release documentation is structured with brief platform-level documents referencing
more detailed installation instructions and descriptive documentation.

Platform documentation
======================

* `OPNFV platform overview document <http://artifacts.opnfv.org/opnfvdocs/colorado/3.0/docs/overview/index.html>`_
* `OPNFV Installation instruction <http://artifacts.opnfv.org/opnfvdocs/colorado/3.0/docs/installationprocedure/index.html>`_
* `OPNFV user guide <http://artifacts.opnfv.org/opnfvdocs/colorado/3.0/docs/userguide/index.html>`_

Installation instructions
=========================

* `Apex installation instruction <http://artifacts.opnfv.org/apex/colorado/3.0/docs/installationprocedure/index.html>`_
* `Apex release notes <http://artifacts.opnfv.org/apex/colorado/3.0/docs/releasenotes/index.html>`_
* `Compass installation instruction <http://artifacts.opnfv.org/compass4nfv/colorado/3.0/docs/installationprocedure/index.html>`_
* `Compass release notes <http://artifacts.opnfv.org/compass4nfv/colorado/3.0/docs/releasenotes/index.html>`_
* `Fuel installation instruction <http://artifacts.opnfv.org/fuel/colorado/3.0/docs/installationprocedure/index.html>`_
* `Fuel release notes <http://artifacts.opnfv.org/fuel/colorado/3.0/docs/releasenotes/index.html>`_
* `Joid installation instruction <http://artifacts.opnfv.org/joid/colorado/3.0/docs/installationprocedure/index.html>`_
* `Joid release notes <http://artifacts.opnfv.org/joid/colorado/3.0/docs/releasenotes/index.html>`_

Feature project documentation
=============================

---------------
ARMband project
---------------

* `Installation instruction <http://artifacts.opnfv.org/armband/colorado/3.0/docs/installationprocedure/index.html>`_
* `Release notes <http://artifacts.opnfv.org/armband/colorado/3.0/docs/releasenotes/index.html>`_

----------------------------
Copper release documentation
----------------------------

* `Design documentation <http://artifacts.opnfv.org/copper/colorado/3.0/docs/design/index.html>`_
* `Installation instruction <http://artifacts.opnfv.org/copper/colorado/3.0/docs/installationprocedure/index.html>`_
* `User guide <http://artifacts.opnfv.org/copper/colorado/3.0/docs/userguide/index.html>`_
* `Release notes <http://artifacts.opnfv.org/copper/colorado/3.0/docs/releasenotes/index.html>`_

--------------------------------
Doctor features and capabilities
--------------------------------

* `Project overview <http://artifacts.opnfv.org/doctor/colorado/3.0/docs/scenarios/index.html>`_
* `User guide <http://artifacts.opnfv.org/doctor/colorado/3.0/docs/userguide/index.html>`_
* `Release notes <http://artifacts.opnfv.org/doctor/colorado/3.0/docs/releasenotes/index.html>`_

--------------------------------
Domino features and capabilities
--------------------------------

* `User guide <http://artifacts.opnfv.org/domino/colorado/3.0/docs/userguide/index.html>`_

-------------------------------------------------
FastDataStacks feature and scenario documentation
-------------------------------------------------

* `OpenDaylight integrated fd.io scenario description <http://artifacts.opnfv.org/fds/colorado/3.0/scenarios_os-odl_l2-fdio-noha/index.html>`_

------------------------------------
IPv6 platform support and capability
------------------------------------

* `Configuration guide <http://artifacts.opnfv.org/ipv6/colorado/3.0/docs/installationprocedure/index.html>`_
* `User guide <http://artifacts.opnfv.org/ipv6/colorado/3.0/docs/userguide/index.html>`_

-----------
KVM for NFV
-----------

* `Installation instruction <http://artifacts.opnfv.org/kvmfornfv/colorado/3.0/docs/installationprocedure/index.html>`_
* `Configuration guide <http://artifacts.opnfv.org/kvmfornfv/colorado/3.0/docs/configurationguide/index.html>`_
* `User guide <http://artifacts.opnfv.org/kvmfornfv/colorado/3.0/docs/userguide/index.html>`_
* `Release notes <http://artifacts.opnfv.org/kvmfornfv/colorado/3.0/docs/releasenotes/index.html>`_

--------------------------------
MOON security management for NFV
--------------------------------

* `Project and Scenario overview <http://artifacts.opnfv.org/moon/colorado/3.0/docs/scenarios_os-odl_l2-moon-ha/index.html>`_
* `Installation instruction <http://artifacts.opnfv.org/moon/colorado/3.0/docs/installationprocedure/index.html>`_
* `User guide <http://artifacts.opnfv.org/moon/colorado/3.0/docs/userguide/index.html>`_
* `Release notes <http://artifacts.opnfv.org/moon/colorado/3.0/docs/releasenotes/index.html>`_

----------------------------
Multisite datacenter project
----------------------------

* `Installation instruction <http://artifacts.opnfv.org/multisite/colorado/3.0/docs/installationprocedure/index.html>`_
* `User guide <http://artifacts.opnfv.org/multisite/colorado/3.0/docs/userguide/index.html>`_
* `Release notes <http://artifacts.opnfv.org/multisite/colorado/3.0/docs/releasenotes/index.html>`_

-------------------------
Network readiness project
-------------------------

* `Requirements document <http://artifacts.opnfv.org/netready/colorado/3.0/docs/requirements/index.html>`_

----------------------
ONOS framework project
----------------------

* `Installation instruction <http://artifacts.opnfv.org/onosfw/colorado/3.0/docs/installationprocedure/index.html>`_
* `User guide <http://artifacts.opnfv.org/onosfw/colorado/3.0/docs/userguide/index.html>`_

----------------------------
OVSNFV release documentation
----------------------------

* `OVS for NFV scenario description <http://artifacts.opnfv.org/ovsnfv/colorado/3.0/docs/scenarios_os-nosdn-ovs/index.html>`_
* `Configuration guide <http://artifacts.opnfv.org/ovsnfv/colorado/3.0/docs/configguide/index.html>`_
* `User guide <http://artifacts.opnfv.org/ovsnfv/colorado/3.0/docs/userguide/index.html>`_

--------------
Parser project
--------------

* `Parser release documentation <http://artifacts.opnfv.org/parser/colorado/3.0/docs/parser_docs/index.html>`_
* `Installation instruction <http://artifacts.opnfv.org/parser/colorado/3.0/docs/installationprocedure/index.html>`_
* `User guide <http://artifacts.opnfv.org/parser/colorado/3.0/docs/userguide/index.html>`_

------
Pharos
------

* `Pharos specification <http://artifacts.opnfv.org/pharos/colorado/3.0/docs/specification/index.html>`_
* `Configuration guide <http://artifacts.opnfv.org/pharos/colorado/3.0/docs/configguide/index.html>`_

-------
Promise
-------

* `Requirement specification <http://artifacts.opnfv.org/promise/colorado/3.0/docs/requirements/index.html>`_
* `Installation and configuration guide <http://artifacts.opnfv.org/promise/colorado/3.0/docs/installationprocedure/index.html>`_
* `User guide <http://artifacts.opnfv.org/promise/colorado/3.0/docs/userguide/index.html>`_

------
SDNVPN
------

* `BGPVPN scenario description <http://artifacts.opnfv.org/sdnvpn/colorado/3.0/docs/scenarios_os-odl_l2-bgpvpn/index.html>`_
* `User guide <http://artifacts.opnfv.org/sdnvpn/colorado/3.0/docs/userguide/index.html>`_
* `Release notes <http://artifacts.opnfv.org/sdnvpn/colorado/3.0/docs/release-notes/index.html>`_

---
SFC
---

* `Design documentation <http://artifacts.opnfv.org/sfc/colorado/3.0/docs/design/index.html>`_
* `SFC scenario description <http://artifacts.opnfv.org/sfc/colorado/3.0/docs/scenarios_os-odl_l2-sfc-noha/index.html>`_
* `High availability SFC scenario description <http://artifacts.opnfv.org/sfc/colorado/3.0/docs/scenarios_os-odl_l2-sfc-ha/index.html>`_
* `Installation instruction <http://artifacts.opnfv.org/sfc/colorado/3.0/docs/installationprocedure/index.html>`_
* `User guide <http://artifacts.opnfv.org/sfc/colorado/3.0/docs/userguide/index.html>`_
* `Release notes <http://artifacts.opnfv.org/sfc/colorado/3.0/docs/releasenotes/index.html>`_

------------------------------------------------
Software fast-path quality metrics documentation
------------------------------------------------

* `Release and development documentation <http://artifacts.opnfv.org/fastpathmetrics/colorado/3.0/index.html>`_


Test Project documentation
==========================

-------------------------
Bottlenecks documentation
-------------------------

* `Installation instruction <http://artifacts.opnfv.org/bottlenecks/colorado/3.0/docs/installationprocedure/index.html>`_
* `Release notes <http://artifacts.opnfv.org/bottlenecks/colorado/3.0/docs/releasenotes/index.html>`_

----------------------
Functest documentation
----------------------

*  `Configuration guide <http://artifacts.opnfv.org/functest/colorado/3.0/docs/configguide/index.html>`_
*  `User guide <http://artifacts.opnfv.org/functest/colorado/3.0/docs/userguide/index.html>`_
*  `Developer guide <http://artifacts.opnfv.org/functest/colorado/3.0/docs/devguide/index.html>`_
*  `Release notes <http://artifacts.opnfv.org/functest/colorado/docs/release-notes/index.html>`_

-------------------------
vSwitchPerf documentation
-------------------------

* `Release and development documentation  <http://artifacts.opnfv.org/vswitchperf/colorado/3.0/docs/index.html>`_

-----------------------
Yardstick documentation
-----------------------

*  `User guide <http://artifacts.opnfv.org/yardstick/colorado/3.0/docs/userguide/index.html>`_
*  `Release notes <http://artifacts.opnfv.org/yardstick/colorado/3.0/docs/release/index.html>`_